> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a public Lnk.Bio page

> Fetches a public Lnk.Bio (lnk.bio) link-in-bio page by URL: the profile (username, name, pronouns, avatar, verified status), the custom theme colors, the social-icon row, and the main bio links (title, url, thumbnail).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/linkbio/page
openapi: 3.0.3
info:
  title: Scraperize API
  version: 1.0.0
  description: >-
    Extract public data from social media platforms as clean JSON. Endpoints are
    split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.


    ## Authentication

    Send your API key in the `x-api-key` header (or `Authorization: Bearer
    <key>`). Create keys in your dashboard.


    ## Credits

    Each successful live scrape costs **1 credit**. Credits are prepaid and
    never expire.


    ## Caching

    Every endpoint accepts an optional `cache_max_age`
    (`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
    **0 credits**.


    ## Responses

    Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
    `{ "error": { "code", "message", "requestId" } }` with a matching HTTP
    status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
    `cached`, and (on a hit) `cachedAt`.


    ## Rate limits

    Requests are limited per team per minute; over the limit returns `429` with
    a `Retry-After` header.
servers:
  - url: https://api.scraperize.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Twitter
    description: Twitter / X scraping endpoints
  - name: Facebook
    description: Facebook scraping endpoints
  - name: Linkme
    description: Linkme (link.me) scraping endpoints
  - name: Amazon
    description: Amazon (creator shop / storefront) scraping endpoints
  - name: Linkbio
    description: Linkbio (lnk.bio) scraping endpoints
  - name: Pillar
    description: Pillar (pillar.io) scraping endpoints
  - name: Komi
    description: Komi (komi.io) scraping endpoints
  - name: Linktree
    description: Linktree (linktr.ee) scraping endpoints
  - name: Kick
    description: Kick (kick.com) scraping endpoints
  - name: Snapchat
    description: Snapchat (snapchat.com) scraping endpoints
  - name: Telegram
    description: Telegram (t.me) scraping endpoints
  - name: Google
    description: Google Search scraping endpoints
paths:
  /v1/linkbio/page:
    get:
      tags:
        - Linkbio
      summary: Get a public Lnk.Bio page
      description: >-
        Fetches a public Lnk.Bio (lnk.bio) link-in-bio page by URL: the profile
        (username, name, pronouns, avatar, verified status), the custom theme
        colors, the social-icon row, and the main bio links (title, url,
        thumbnail).
      parameters:
        - name: url
          in: query
          required: true
          description: Public Lnk.Bio profile URL, e.g. https://lnk.bio/tamirawill.
          schema:
            type: string
          example: https://lnk.bio/tamirawill
        - name: cache_max_age
          in: query
          required: false
          description: >-
            Optional. Return a cached result if one this age or newer exists —
            served for **0 credits** with `meta.cached=true` and
            `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
            refreshes the cache. Omit to always scrape fresh.
          schema:
            type: string
            enum:
              - 1d
              - 3d
              - 7d
              - 14d
              - 30d
          example: 7d
      responses:
        '200':
          description: The Lnk.Bio page.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      page:
                        type: object
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  page:
                    username: tamirawill
                    userId: '-1123819'
                    name: Tamira
                    pronouns: (they/them)
                    displayName: Tamira
                    url: https://lnk.bio/tamirawill
                    avatarUrl: >-
                      https://s3.us-west-2.amazonaws.com/cdn.lnk.bio/profilepics/-1123819_20210219387.jpg
                    verified: true
                    theme:
                      headingsColor: '#8E6859'
                      bioColor: '#8E6859'
                      iconsColor: '#8E6859'
                      iconTextColor: '#FAFAFA'
                      backgroundColor: '#FCFAF7'
                      boxColor: '#F8EDDE'
                      iconBackgroundColor: '#221F1F'
                    socialLinks:
                      - platform: Instagram
                        network: SOCIAL_IG
                        url: https://instagram.com/tamirawill
                      - platform: YouTube
                        network: SOCIAL_YT
                        url: >-
                          https://www.youtube.com/channel/UCk8ujbLrxJBoHKsE5hpfcgA
                      - platform: TikTok
                        network: SOCIAL_TK
                        url: https://tiktok.com/@tamirawill
                    links:
                      - id: '7336276'
                        title: Test
                        url: https://www.google.com
                        image: >-
                          https://cdn2.lnk.bi/uploads/7336276_20240419182619257-1024.jpg?lu=2024-04-19+10%3A26%3A24
                        isMultiLink: true
                      - id: '4696075'
                        title: Fitness Shoes
                        url: https://www.instagram.com/p/CD0ysqPHMS6/?hl=en
                        image: >-
                          https://cdn2.lnk.bi/uploads/4696075_20230511152546109-1024.jpg?lu=2024-04-19+10%3A23%3A25
                        isMultiLink: false
                      - id: '4695740'
                        title: Post
                        url: https://www.google.com
                        image: >-
                          https://cdn2.lnk.bi/uploads/4695740_20230511140632685-1024.jpg?lu=2024-04-19+10%3A23%3A25
                        isMultiLink: false
                  fetchedAt: '2026-09-14T12:14:39.529Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '401':
          description: Missing, invalid, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHORIZED
                  message: API key required — pass it in the `x-api-key` header.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '402':
          description: Not enough credits for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_CREDITS
                  message: >-
                    This request costs 1 credit, but your balance is 0. Top up
                    to continue.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '404':
          description: Page not found / unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: >-
                    The requested content was not found (it may not exist, be
                    deleted, or be private).
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '422':
          description: Invalid query parameters (missing or malformed url).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  details:
                    - path: url
                      message: Required
        '429':
          description: Over the per-minute rate limit — honour `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: >-
                    Rate limit exceeded — max 100 requests per 60s. Retry in
                    ~30s.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '502':
          description: Upstream block.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UPSTREAM_BLOCKED
                  message: >-
                    The source was temporarily unavailable. Please try again
                    shortly.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: The requested content was not found.
            requestId:
              type: string
              example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
            details:
              type: array
              items:
                type: object
              description: Present on validation errors.
          required:
            - code
            - message
            - requestId
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key. Send it in the `x-api-key` header (or `Authorization:
        Bearer <key>`). Create and manage keys from your dashboard.

````