> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/linkme/profiles/handle/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/linkme/profiles/handle/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Linkme profile (https://www.socialfetch.dev/docs/api/v1/linkme/profiles/handle/get)

## Summary

Get a Linkme profile: name, bio, avatar, follower total, featured links with headings and carousels, social and contact icons, gallery photos and section order.

**Tags:** `Linkme`

## HTTP

- **Method:** GET
- **Path:** `/v1/linkme/profiles/{handle}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.linkme.getProfile({ handle: "danucd" })`
- **Accepted identifiers:** `handle` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `handle` (path)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 200
- **Description:** Linkme handle, the profile path, e.g. `danucd` for link.me/danucd. A leading @ or the full profile URL is accepted.

## Responses (status codes)

- **200**: Linkme profile.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Linkme profile.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the public link-in-bio page was found.
  - **profile** (required) — type `object`; nullable. The profile when found; null when not.
    - **platform** (required) — type `string`; enum: linkme. Platform id.
    - **handle** (required) — type `string`; minLength: 1. Canonical public username/handle without a leading @.
    - **displayName** (required) — type `string`; nullable. Public display title of the profile.
    - **bio** (required) — type `string`; nullable. Public bio or description text, when the profile has one.
    - **avatarUrl** (required) — type `string`; minLength: 1; nullable. Best available avatar image URL; null when the profile has only a blank placeholder.
    - **profileUrl** (required) — type `string`; minLength: 1. The public profile URL, `https://link.me/{handle}`.
    - **verified** (required) — type `boolean`. Whether the platform marks the profile as verified.
    - **id** (required) — type `string`; minLength: 1. Linkme profile id.
    - **firstName** (required) — type `string`; nullable. First name, when given.
    - **lastName** (required) — type `string`; nullable. Last name, when given.
    - **followers** (required) — type `integer`; minimum: 0; nullable. Total followers across the connected accounts, as the profile shows it.
    - **profileViews** (required) — type `string`; nullable. Profile view count as the profile shows it, e.g. `68k`.
    - **private** (required) — type `boolean`. Whether the owner marked the profile private.
    - **adult** (required) — type `boolean`. Whether the profile is marked for adults (age gate).
    - **customDomainUrl** (required) — type `string`; minLength: 1; nullable. The profile's own domain, when it has one.
    - **createdAt** (required) — type `string`; nullable. When the profile was created, as the site gives it (UTC).
    - **updatedAt** (required) — type `string`; nullable. When the profile last changed, as the site gives it (UTC).
  - **links** (required) — type `array`. Featured links in display order, with carousel links in place.
    - _items:_
      - **id** (required) — type `string`; nullable. Stable link id from the platform when available.
      - **title** (required) — type `string`; nullable. Link title as displayed on the profile.
      - **url** (required) — type `string`; minLength: 1. Destination URL.
      - **type** (required) — type `string`; nullable. The service the link points at as the profile labels it, e.g. `youtube`, `spotify` or `link`.
      - **thumbnailUrl** (required) — type `string`; minLength: 1; nullable. Optional thumbnail image URL for the link.
      - **position** (required) — type `integer`; minimum: 0. Zero-based display order.
      - **description** (required) — type `string`; nullable. Second line shown on the link, when any.
      - **group** (required) — type `object`; nullable. The heading or carousel this link sits under, when any.
  - **linksTotal** (required) — type `integer`; minimum: 0; nullable. How many links the profile has, counted as in `links` (each carousel link counts). It equals the number of links returned when the response holds every link, and is null when it does not (`linksTruncated`).
  - **linksTruncated** (required) — type `boolean`. True when the links list may be incomplete: the profile has more featured entries than the first page the site sends.
  - **socials** (required) — type `array`. Social, music and contact icons, in the profile's order.
    - _items:_
      - **platform** (required) — type `string`; minLength: 1. Normalized social platform slug (e.g. instagram, tiktok, email).
      - **url** (required) — type `string`; minLength: 1. Social profile or contact destination.
  - **gallery** (required) — type `array`. Gallery photos, in order.
    - _items:_
      - **id** (required) — type `string`; nullable. Image id.
      - **url** (required) — type `string`; minLength: 1. Image URL.
      - **position** (required) — type `integer`; minimum: 0. Display order.
  - **sections** (required) — type `array`. The sections the profile shows, in order.
    - _items:_
      - **name** (required) — type `string`; minLength: 1. Section name as the profile names it, e.g. `web_links`, `bio`, `featured_links`, `gallery`, `contact_info` or `shop`.
      - **position** (required) — type `integer`; minimum: 0. Display order.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "profile": {
      "platform": "linkme",
      "handle": "olamide",
      "displayName": "Olamide",
      "bio": null,
      "avatarUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/1032776/tmp-3518-1760380071448.webp",
      "profileUrl": "https://link.me/olamide",
      "verified": true,
      "id": "f897e1da16ac6d171c851390772827b6",
      "firstName": "Olamide",
      "lastName": null,
      "followers": 23795718,
      "profileViews": "349",
      "private": false,
      "adult": false,
      "customDomainUrl": null,
      "createdAt": "2024-06-24T18:42:57Z",
      "updatedAt": "2026-07-06T17:00:47Z"
    },
    "links": [
      {
        "id": "1354338",
        "title": "Rock Me Gentle",
        "url": "https://open.spotify.com/album/45NPP48bR0MLByihoQBOia?si=GMosHv-OTQGldrLFlCS8_g",
        "type": "spotify",
        "thumbnailUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/external-links/1032776/tmp-3580-1783357235095.jpg",
        "description": "Olamide",
        "group": null,
        "position": 0
      }
    ],
    "linksTotal": 21,
    "linksTruncated": false,
    "socials": [
      {
        "platform": "apple_music",
        "url": "https://music.apple.com/ng/artist/olamide/389401008"
      }
    ],
    "gallery": [
      {
        "id": "610949",
        "url": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/userImage/1032776/tmp-340-1719257601600.webp",
        "position": 0
      }
    ],
    "sections": [
      {
        "name": "web_links",
        "position": 0
      }
    ]
  },
  "meta": {
    "requestId": "req_01example_linkme_found",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.linkme.getProfile({
  handle: "danucd",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/linkme/profiles/danucd",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/linkme/profiles/danucd" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/linkme/profiles/danucd",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```