> **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):** - **Markdown (.mdx) URL:** ## 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:** ## 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, 910 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 Lnk.Bio profile (https://www.socialfetch.dev/docs/api/v1/lnk-bio/profiles/handle/get) ## Summary Get a Lnk.Bio profile's identity, bio, avatar, social icons, page tabs and main-page links. **Tags:** `Lnk.Bio` ## HTTP - **Method:** GET - **Path:** `/v1/lnk-bio/profiles/{handle}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.lnkBio.getProfile({ handle: "sportsillustrated" })` - **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: 2; maxLength: 128; pattern: `^[A-Za-z0-9._&+*@/-]+$` - **Description:** lnk.bio handle, case preserved, e.g. `sportsillustrated`, `Curate.in`, `S&S` or `@brastel.thai`. A percent-encoded handle is accepted in the public path. ## Responses (status codes) - **200**: 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) Profile. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the public lnk.bio page was found. - **profile** (required) — type `object`; nullable. Profile when found; null when not. - **platform** (required) — type `string`; enum: lnk-bio. Platform id. - **handle** (required) — type `string`; minLength: 1. Canonical handle, with the case the profile uses. - **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 lnk.bio profile URL; a custom domain is in `customDomainUrl`. - **verified** (required) — type `boolean`. Whether the platform marks the profile as verified. - **id** (required) — type `string`; nullable. Numeric profile id; may be negative. - **connectedUsername** (required) — type `string`; nullable. The connected Instagram or TikTok style name, when the profile has one. - **timezone** (required) — type `string`; nullable. IANA time zone, when known. - **customDomainUrl** (required) — type `string`; minLength: 1; nullable. The profile's custom domain, when it is served from one and it is not lnk.bio. - **shareImageUrl** (required) — type `string`; minLength: 1; nullable. Social share image URL, when valid. - **welcomePlaceholder** (required) — type `boolean`. True when the profile shows Lnk.Bio's `Welcome to Lnk.Bio` placeholder instead of content. - **pages** (required) — type `array`. The page tabs the profile carries, in document order. - _items:_ - **links** (required) — type `array`. Links on the profile's main page, in display order. - _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; nullable. Destination URL; null for a block link such as a contact form. - **type** (required) — type `string`; nullable. Platform link type when available (e.g. CLASSIC, SPOTIFY_ALBUM). - **thumbnailUrl** (required) — type `string`; minLength: 1; nullable. Optional thumbnail image URL for the link. - **position** (required) — type `integer`; minimum: 0; nullable. Zero-based position in the profile's link list when known; on search, null for links not in the profile's first 48. - **group** (required) — type `object`; nullable. The group heading shown above this link, when any. - **badge** (required) — type `string`; nullable. Badge text shown on the link box, e.g. `TOP`. - **blockType** (required) — type `string`; nullable. Block type when the link opens a block instead of a URL, e.g. `form`. - **socials** (required) — type `array`. Social icons. - _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. - **title** (required) — type `string`; nullable. Icon title on the profile, e.g. `Instagram`. - **networkCode** (required) — type `string`; minLength: 1. Lnk.Bio's own code for the icon, for example `SOCIAL_IG`. - **linksTotal** (required) — type `integer`; minimum: 0; nullable. Total number of links when known, otherwise null; list the links for the full count. - **linksTruncated** (required) — type `boolean`. True when the links list may be incomplete; call the links route for the full list. - **embeds** (required) — type `array`. Embed blocks printed on the main page. - _items:_ - **provider** (required) — type `string`; minLength: 1. Provider inferred from the embed host, e.g. `youtube`. - **url** (required) — type `string`; minLength: 1. The iframe source URL. - **title** (required) — type `string`; nullable. Heading printed before the embed, when the page has one. - **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. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "profile": { "platform": "lnk-bio", "handle": "sportsillustrated", "id": "179450081", "connectedUsername": "sportsillustrated", "displayName": null, "bio": null, "avatarUrl": "https://cdn2.lnk.bi/profilepics/179450081_20240621581.jpg", "profileUrl": "https://lnk.bio/sportsillustrated", "verified": true, "timezone": "America/New_York", "customDomainUrl": null, "shareImageUrl": "https://cdn2.lnk.bi/profilepics/179450081_20240621581.jpg", "welcomePlaceholder": false, "pages": [ { "id": "PAGE_LNKS", "title": null, "heading": null, "text": null } ] }, "links": [ { "id": "14703345", "title": "Ranking the 25 Greatest Coaches in College Football History", "url": "https://www.si.com/college-football/ranking-25-greatest-coaches-in-college-football-history", "type": "biolink", "thumbnailUrl": "https://cdn2.lnk.bi/uploads/14703345_20261104223627586-1024.jpg?lu=2026-11-04+16%3A15%3A30", "position": 0, "group": { "id": "u", "title": "My Favorite Lnks" }, "badge": null, "blockType": null } ], "socials": [], "linksTotal": null, "linksTruncated": false, "embeds": [] }, "meta": { "requestId": "req_01example_lnk_bio_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.lnkBio.getProfile({ handle: "sportsillustrated", }); 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/lnk-bio/profiles/sportsillustrated", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/lnk-bio/profiles/sportsillustrated" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/lnk-bio/profiles/sportsillustrated", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```