> ## 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 Linktree page

> Fetches a public Linktree page by URL: the profile (name, avatar, verification, theme, social links) and the page links — each with its title, url, thumbnail, preview metadata, nested children, and gating — plus any storefront items.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/linktree/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/linktree/page:
    get:
      tags:
        - Linktree
      summary: Get a public Linktree page
      description: >-
        Fetches a public Linktree page by URL: the profile (name, avatar,
        verification, theme, social links) and the page links — each with its
        title, url, thumbnail, preview metadata, nested children, and gating —
        plus any storefront items.
      parameters:
        - name: url
          in: query
          required: true
          description: Public Linktree page URL, e.g. https://linktr.ee/pharrell.
          schema:
            type: string
          example: https://linktr.ee/pharrell
        - 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 Linktree 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: pharrell
                    accountId: 3025568
                    uuid: b18d6498-3f5d-11eb-85b8-0a26086d88df
                    title: '@pharrell'
                    name: Pharrell Williams
                    description: null
                    isVerified: true
                    isActive: true
                    avatarUrl: >-
                      https://ugc.production.linktr.ee/54f5ea79-e633-456d-b88d-f75656c977dc_Screenshot-2025-05-06-at-7.42.05-AM.png
                    avatarType: IMAGE
                    avatarShape: CIRCLE_SMALL
                    bannerImageUrl: null
                    bannerType: IMAGE
                    createdAt: '2019-08-23T09:48:16.000Z'
                    updatedAt: '2026-08-31T09:54:19.000Z'
                    socialLinksPosition: TOP
                    metaTitle: Pharrell Williams | Linktree
                    metaDescription: Follow my Linktree for the latest.
                    theme:
                      key: custom
                      luminance: LIGHT
                      backgroundColor: '#ffffff'
                      backgroundStyle: FLAT
                      backgroundType: COLOR
                      buttonType: HARDSHADOW_CIRCULAR
                      buttonColor: '#ffffff'
                      buttonTextColor: '#000000'
                      buttonCornerType: ROUNDED_FULL
                      buttonShadowColor: '#000000'
                      socialColor: '#000000'
                      fontFamily: dm sans
                      fontColor: '#000000'
                    socialLinks:
                      - type: FACEBOOK
                        url: https://facebook.com/pharrell
                        position: 0
                      - type: INSTAGRAM
                        url: https://instagram.com/pharrell
                        position: 0
                      - type: TIKTOK
                        url: https://tiktok.com/@pharrell
                        position: 0
                    links:
                      - id: '13210175'
                        type: CLASSIC
                        title: PHARRELLWILLIAMS.COM
                        url: https://pharrellwilliams.com/
                        thumbnailUrl: null
                        position: 0
                        locked: false
                        gateTypes: null
                        layout: stack
                        amazonAffiliate: false
                        meta:
                          title: Pharrell Williams
                          description: Dress Up Pharrell
                          image: >-
                            https://pharrellwilliams.com/opengraph-image.png?opengraph-image.1kc5_rpella_-.png
                        children: null
                      - id: '498208380'
                        type: CLASSIC
                        title: VIRGINIA
                        url: http://blackyachtrock.com
                        thumbnailUrl: >-
                          https://ugc.production.linktr.ee/bf7cf3fc-89b5-4173-b46d-e174d5d428ac_virginia-opengraph-2025.png
                        position: 1
                        locked: false
                        gateTypes: null
                        layout: stack
                        amazonAffiliate: false
                        meta:
                          title: null
                          description: null
                          image: null
                        children: null
                      - id: '477277634'
                        type: CLASSIC
                        title: Louis Vuitton Menswear
                        url: >-
                          https://us.louisvuitton.com/eng-us/new/for-men/new-this-season/_/N-t1blflj9
                        thumbnailUrl: >-
                          https://ugc.production.linktr.ee/650e26ba-d3f7-480c-8788-8c97fa0dc554_Untitled-design--4-.png
                        position: 3
                        locked: false
                        gateTypes: null
                        layout: stack
                        amazonAffiliate: false
                        meta:
                          title: null
                          description: null
                          image: null
                        children: null
                    pinnedLinks: []
                    storefront:
                      hasCommissionProducts: false
                      itemCount: 0
                      postCount: 0
                      items: []
                      posts: []
                    linkCount: 9
                    totalLinkCount: 9
                    socialCount: 7
                  fetchedAt: '2026-09-14T12:14:45.519Z'
                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.

````