> **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 Ko-fi profile (https://www.socialfetch.dev/docs/api/v1/ko-fi/profiles/handle/get) ## Summary Get a Ko-fi creator's public profile: identity, bio, links, support settings, goal and badges. **Tags:** `Ko-fi` ## HTTP - **Method:** GET - **Path:** `/v1/ko-fi/profiles/{handle}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.koFi.getProfile({ handle: "ligianunes" })` - **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: 64; pattern: `^[A-Za-z0-9_-]+$` - **Description:** A creator's Ko-fi handle (e.g. `ligianunes`) or page id (e.g. `A644275F`). Case-insensitive. ## Responses (status codes) - **200**: Get a Ko-fi 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) Get a Ko-fi profile. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the requested entity exists. - **profile** (required) — type `object`; nullable. The profile when `lookupStatus` is `found`; otherwise null. - **id** (required) — type `string`. Creator page id, e.g. `A644275F`. - **handle** (required) — type `string`; nullable. Canonical handle from the profile's canonical URL; null when not published. - **name** (required) — type `string`; nullable. Display name. - **avatarUrl** (required) — type `string`; nullable. Avatar image URL. - **coverUrl** (required) — type `string`; nullable. Cover image URL; null when the page has no cover. - **isGold** (required) — type `boolean`. Whether the creator is a Ko-fi Gold member. - **followers** (required) — type `object`; nullable. The follower/supporter count in the profile header; null when not shown. - **kind** (required) — type `string`; enum: followers, supporters. Whether the header count names followers or supporters. - **count** (required) — type `integer`; minimum: 0; nullable. Displayed count; null when Ko-fi shows only a label or a link. - **approximate** (required) — type `boolean`. True when Ko-fi rounds the count (e.g. `2.8M Followers`), so `count` is approximate. - **pageMode** (required) — type `string`; enum: tip, membership, shop, commissions, supporter, null; nullable. Kind of page; null when the title does not say. - **bio** (required) — type `string`; nullable. About text, with line breaks kept. - **website** (required) — type `string`; nullable. Website link from the About section. - **socials** (required) — type `array`. Social links from the About section. - _items:_ - **tags** (required) — type `array`. Tags on the creator's profile. - _items:_ - type `string` - **goal** (required) — type `object`; nullable. The creator's goal widget; null when the page has none. - **title** (required) — type `string`; nullable. Goal title. - **percent** (required) — type `number`; minimum: 0; maximum: 100; nullable. Percent of the goal reached, as Ko-fi displays it. Ko-fi never publishes the amount. - **description** (required) — type `string`; nullable. Goal description as text. - **badges** (required) — type `array`. Visible badges. - _items:_ - type `string` - **commissions** (required) — type `object`; nullable. Commission widget summary; null when the page has no commission widget. - **slotsText** (required) — type `string`; nullable. The slots line, e.g. `1 slots left`. - **slotsLeft** (required) — type `integer`; minimum: 0; nullable. The number in the creator's `N slots left` line; it is the creator's text, not a live availability check. - **support** (required) — type `object`; nullable. The embedded checkout/support model; null for a supporter account or a creator who cannot receive support. - **currency** (required) — type `string`; nullable. Currency code from the checkout model, e.g. `USD`, `EUR`, `GBP`. - **itemName** (required) — type `string`; nullable. The creator's own wording for a unit of support, e.g. `Coffee`, `Ramen`. - **actionLabel** (required) — type `string`; nullable. The call-to-action wording, e.g. `Tip` or `Donate`. - **unitAmount** (required) — type `number`; minimum: 0; nullable. Default amount of one unit. - **minimumAmount** (required) — type `number`; minimum: 0; nullable. Minimum amount the checkout accepts. - **suggestedAmounts** (required) — type `array`. Suggested one-off amounts; empty when the page suggests none. - _items:_ - type `number`; minimum: 0 - **recurring** (required) — type `boolean`; nullable. Whether the creator accepts recurring support. - **discordRewards** (required) — type `boolean`; nullable. Whether Discord rewards are available. - **discordRewardsSubscribersOnly** (required) — type `boolean`; nullable. Whether Discord rewards are limited to subscribers. - **membership** (required) — type `object`; nullable. Membership benefit counts from the checkout model; null when there is no model. - **unlockable** (required) — type `object`. Monthly benefits a membership unlocks, as counted by the profile. - **og** (required) — type `object`. Open Graph metadata. - **title** (required) — type `string`; nullable. Open Graph title. - **description** (required) — type `string`; nullable. Open Graph description. - **imageUrl** (required) — type `string`; nullable. Open Graph share image. - **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": { "id": "A354LPQ", "handle": "ligianunes", "name": "LigiaNunes", "avatarUrl": "https://storage.ko-fi.com/cdn/useruploads/9d978d54-d6b5-4efe-afbf-45460dfb4bbc_92a1e8ec-dc3f-48e9-b3d0-85d9f4605e14.png", "coverUrl": "https://storage.ko-fi.com/cdn/useruploads/e6ce7f64-8cf2-4651-bd33-f8c6023fa7ab_jpg_656958e0-5e74-4b89-b766-ff8481c69d9acover.jpg?v=1b7f202a-dce6-48cd-be15-36360424c8be", "isGold": true, "followers": { "kind": "followers", "count": 229, "approximate": false }, "pageMode": "membership", "bio": "Hi! I'm Ligia Nunes, and I write sci-fi and fantasy diverse and inclusive books/games filled with romance and humor.\n\nI believe in justice, love, feminism, and equal rights for everyone.\n\nIf you're like me, then my books and games were written especially for you. You're one of us now; welcome to the family! ♥", "website": "http://ligianunes.com/", "socials": [ { "platform": "TUMBLR", "url": "https://ligiawrites.tumblr.com/", "label": "ligiawrites" } ], "tags": [ "Writing" ], "goal": { "title": "Would you like to help me with rent?", "percent": 95, "description": "Now that I'm focusing on my creative career, all of my money will come from the sales I make in my books, games, and from ko-fi. While I'm still establishing myself, though, these sales are quite small, haha! So, if you would like to support me in my career through ko-fi, I'd be super thankful!" }, "badges": [ "Gold member" ], "commissions": { "slotsText": "1 slots left", "slotsLeft": 1 }, "support": { "currency": "USD", "itemName": "Coffee", "actionLabel": "Tip", "unitAmount": 3, "minimumAmount": 3, "suggestedAmounts": [], "recurring": false, "discordRewards": false, "discordRewardsSubscribersOnly": false }, "membership": { "unlockable": { "posts": 9, "galleryItems": 2, "shopItems": 0, "commissions": 0, "discounts": 2, "polls": 0 } }, "og": { "title": "Join LigiaNunes's membership", "description": "Support LigiaNunes monthly", "imageUrl": "https://storage.ko-fi.com/cdn/generated/gy94nptwchqvm/2026-06-01_rest-bf7507a494c2dcb8fe35b47dc7867c80-uzhupb7j.jpg" } } }, "meta": { "requestId": "req_92d1fb8e-5344-497c-831b-de5e4ee33035", "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.koFi.getProfile({ handle: "ligianunes", }); 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/ko-fi/profiles/ligianunes", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/ko-fi/profiles/ligianunes" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/ko-fi/profiles/ligianunes", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```