> ## 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.

# Linkme profile

> Fetches a public Linkme (link.me) profile by URL. Returns the identity (username, display name, bio, avatar, verified status), counts (profile views, followers, total links), the social-icon links, the featured link cards (with images, colors, and type), contact info, and the photo gallery.

<Info>
  **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
</Info>

<Accordion title="Copy for AI assistant" icon="sparkles">
  Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).

  ```text Prompt
  I want to make an API call to /v1/linkme/profile. Here are the details:

  Endpoint: GET https://api.scraperize.com/v1/linkme/profile
  Description: Fetches a public Linkme (link.me) profile by URL. Returns the identity (username, display name, bio, avatar, verified status), counts (profile views, followers, total links), the social-icon links, the featured link cards (with images, colors, and type), contact info, and the photo gallery.

  Required Headers:
  - x-api-key: Your API key

  Parameters:
  - url (string) [required]: Public Linkme profile URL, e.g. https://link.me/danucd.
  - cache_max_age (select): 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.

  Example Response:
  {
    "data": {
      "profile": {
        "id": "1bf3efbf94cc4f55d3650ddc61094ac3",
        "userId": "1169288",
        "username": "danucd",
        "displayName": "Dana",
        "firstName": "Dana",
        "lastName": null,
        "bio": "ALL MY LINKS👇",
        "url": "https://link.me/danucd",
        "verified": false,
        "verifiedColor": "blue",
        "isAmbassador": true,
        "isPrivate": false,
        "isAdult": false,
        "avatarUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/1169288/tmp-2541-1763300314455.webp",
        "avatarUrlPng": "https://media.link.me/_resize/image/quality=90,format=webp/images/user-profile/1169288/tmp-2541-1763300314455.png",
        "isDefaultProfilePicture": false,
        "coverUrl": null,
        "logoUrl": null,
        "videoProfileUrl": null,
        "videoProfileThumbnailUrl": null,
        "views": "62.7k",
        "followers": null,
        "totalLinks": 7,
        "theme": "dark",
        "customTheme": {
          "backgroundColor": null,
          "backgroundImageUrl": null,
          "bioBackground": null,
          "mainTextColor": null,
          "level1TextColor": null,
          "level2TextColor": null,
          "customFont": null,
          "customFontUrl": null
        },
        "tipsEnabled": false,
        "shopEnabled": false,
        "qrCode": "qrCode/v2/danucd",
        "referralLink": "https://meglobalapp.page.link/TFZgPYaJGeqm3mXt5",
        "deeplink": "https://meglobalapp.page.link/14GsZs1EQ2KMqxjH7",
        "createdAt": "2024-11-01T12:37:51.000Z",
        "updatedAt": "2025-11-16T13:43:17.000Z",
        "socialLinks": [
          {
            "platform": "Apple-music",
            "url": "https://music.apple.com/ng/artist/danucd/1562315189",
            "handle": "1562315189",
            "iconUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/Apple-Music-1.png",
            "isAdult": false
          }
        ],
        "featuredLinks": [
          {
            "id": 231267,
            "title": "Twitch",
            "description": null,
            "url": "https://twitch.tv/danucd",
            "platform": "twitch",
            "imageUrl": null,
            "iconUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/external-links/1169288/icon_1763239167644.png",
            "thumbnail": "small",
            "color": {
              "c": "#61187bff"
            },
            "order": 0,
            "isAdult": false,
            "kind": "link"
          }
        ],
        "contactInfo": [
          {
            "type": "Email",
            "value": "dana.danucd@gmail.com"
          }
        ],
        "gallery": [
          {
            "id": 673778,
            "url": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/userImage/1169288/tmp-397-1730484089200.webp",
            "order": 2,
            "createdAt": "2024-11-01T18:01:30.000Z"
          }
        ],
        "sections": [
          {
            "section": "total_followers",
            "order": 1,
            "enabled": true
          }
        ],
        "sameAs": [
          "https://music.apple.com/ng/artist/danucd/1562315189"
        ],
        "metadata": {
          "title": "Check out Dana  (@danucd) on Linkme",
          "description": "Discover Dana  on LinkMe: ALL MY LINKS👇: Connect and see what they're passionate about.",
          "image": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/1169288/tmp-2541-1763300314455.webp",
          "keywords": "Dana , Dana  Linkme, Dana  on Linkme, Dana  Linkme Profile, Dana  Linkme Profile Link",
          "canonical": "https://link.me/danucd"
        }
      },
      "fetchedAt": "2026-10-05T14:43:30.060Z"
    },
    "meta": {
      "requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
      "creditsCharged": 1,
      "creditsRemaining": 4999,
      "cached": false
    }
  }

  Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
  ```
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/linkme/profile
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: LinkedIn
    description: LinkedIn scraping endpoints
  - name: Twitch
    description: Twitch scraping endpoints
  - name: TikTok
    description: TikTok (tiktok.com) scraping endpoints
paths:
  /v1/linkme/profile:
    get:
      tags:
        - Linkme
      summary: Linkme profile
      description: >-
        Fetches a public Linkme (link.me) profile by URL. Returns the identity
        (username, display name, bio, avatar, verified status), counts (profile
        views, followers, total links), the social-icon links, the featured link
        cards (with images, colors, and type), contact info, and the photo
        gallery.
      parameters:
        - name: url
          in: query
          required: true
          description: Public Linkme profile URL, e.g. https://link.me/danucd.
          schema:
            type: string
          example: https://link.me/danucd
        - 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 Linkme profile.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      profile:
                        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:
                  profile:
                    id: 1bf3efbf94cc4f55d3650ddc61094ac3
                    userId: '1169288'
                    username: danucd
                    displayName: Dana
                    firstName: Dana
                    lastName: null
                    bio: ALL MY LINKS👇
                    url: https://link.me/danucd
                    verified: false
                    verifiedColor: blue
                    isAmbassador: true
                    isPrivate: false
                    isAdult: false
                    avatarUrl: >-
                      https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/1169288/tmp-2541-1763300314455.webp
                    avatarUrlPng: >-
                      https://media.link.me/_resize/image/quality=90,format=webp/images/user-profile/1169288/tmp-2541-1763300314455.png
                    isDefaultProfilePicture: false
                    coverUrl: null
                    logoUrl: null
                    videoProfileUrl: null
                    videoProfileThumbnailUrl: null
                    views: 62.7k
                    followers: null
                    totalLinks: 7
                    theme: dark
                    customTheme:
                      backgroundColor: null
                      backgroundImageUrl: null
                      bioBackground: null
                      mainTextColor: null
                      level1TextColor: null
                      level2TextColor: null
                      customFont: null
                      customFontUrl: null
                    tipsEnabled: false
                    shopEnabled: false
                    qrCode: qrCode/v2/danucd
                    referralLink: https://meglobalapp.page.link/TFZgPYaJGeqm3mXt5
                    deeplink: https://meglobalapp.page.link/14GsZs1EQ2KMqxjH7
                    createdAt: '2024-11-01T12:37:51.000Z'
                    updatedAt: '2025-11-16T13:43:17.000Z'
                    socialLinks:
                      - platform: Apple-music
                        url: https://music.apple.com/ng/artist/danucd/1562315189
                        handle: '1562315189'
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/Apple-Music-1.png
                        isAdult: false
                      - platform: Spotify
                        url: >-
                          https://open.spotify.com/artist/0A8XmfCL2yangEtvot3peD?autoplay=true&source_application=google_assistant
                        handle: 0A8XmfCL2yangEtvot3peD
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/Spotify-1.png
                        isAdult: false
                      - platform: Instagram
                        url: https://www.instagram.com/danucd/
                        handle: danucd
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/Instagram-1.png
                        isAdult: false
                    featuredLinks:
                      - id: 231267
                        title: Twitch
                        description: null
                        url: https://twitch.tv/danucd
                        platform: twitch
                        imageUrl: null
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/external-links/1169288/icon_1763239167644.png
                        thumbnail: small
                        color:
                          c: '#61187bff'
                        order: 0
                        isAdult: false
                        kind: link
                      - id: 611348
                        title: Daily YouTube
                        description: null
                        url: https://www.youtube.com/@DanucD2
                        platform: youtube
                        imageUrl: null
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/YouTube-1.png
                        thumbnail: small
                        color:
                          c: '#e22400ff'
                        order: 0
                        isAdult: false
                        kind: link
                      - id: 609639
                        title: Kick
                        description: null
                        url: https://www.kick.com/danucd
                        platform: kick
                        imageUrl: null
                        iconUrl: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/style/icons/v5.0/Kick-1.png
                        thumbnail: small
                        color:
                          p:
                            d: '#6cd97aff'
                            l: '#6cd97a99'
                        order: 1
                        isAdult: false
                        kind: link
                    contactInfo:
                      - type: Email
                        value: dana.danucd@gmail.com
                    gallery:
                      - id: 673778
                        url: >-
                          https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/userImage/1169288/tmp-397-1730484089200.webp
                        order: 2
                        createdAt: '2024-11-01T18:01:30.000Z'
                    sections:
                      - section: total_followers
                        order: 1
                        enabled: true
                      - section: bio
                        order: 1
                        enabled: true
                      - section: featured_links
                        order: 2
                        enabled: true
                    sameAs:
                      - https://music.apple.com/ng/artist/danucd/1562315189
                      - >-
                        https://open.spotify.com/artist/0A8XmfCL2yangEtvot3peD?autoplay=true&source_application=google_assistant
                      - https://www.instagram.com/danucd/
                    metadata:
                      title: Check out Dana  (@danucd) on Linkme
                      description: >-
                        Discover Dana  on LinkMe: ALL MY LINKS👇: Connect and
                        see what they're passionate about.
                      image: >-
                        https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/1169288/tmp-2541-1763300314455.webp
                      keywords: >-
                        Dana , Dana  Linkme, Dana  on Linkme, Dana  Linkme
                        Profile, Dana  Linkme Profile Link
                      canonical: https://link.me/danucd
                  fetchedAt: '2026-10-05T14:43:30.060Z'
                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: Profile 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
        '503':
          description: >-
            Temporarily unavailable — retry after `Retry-After`. `error.code`
            tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
            `EXTRACTION_FAILED` (the source returned unexpected data),
            `PLATFORM_UNAVAILABLE` (the source is down), or
            `SERVICE_UNAVAILABLE` (we are at capacity).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UPSTREAM_BLOCKED
                  message: >-
                    The source is 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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.