> **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 Mastodon profile (https://www.socialfetch.dev/docs/api/v1/mastodon/profiles/handle/get) ## Summary Get a Mastodon account's public profile by handle, with the owner's discoverability and indexing flags. **Tags:** `Mastodon` ## HTTP - **Method:** GET - **Path:** `/v1/mastodon/profiles/{handle}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.mastodon.getProfile({ handle: "Gargron@mastodon.social" })` - **Accepted identifiers:** `handle` (path) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `restricted`, `unsupported`, `not_compatible` ## 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` - **Description:** Account handle with its home server, e.g. `Gargron@mastodon.social`. A leading `acct:` or `@`, or a profile URL (`https://mastodon.social/@Gargron`, `https://mastodon.social/web/@Gargron`) is also accepted. ### `include` (query) - **Required:** no - **Constraints:** type `string`; enum: featuredTags - **Description:** `featuredTags` also returns the hashtags the account features. ## Responses (status codes) - **200**: The account, or why it cannot be shown. - **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) The account, or why it cannot be shown. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted, unsupported, not_compatible. `found`, `not_found`, `restricted` (login required or closed), `unsupported` (this server does not offer it) or `not_compatible` (the host is not a Mastodon-compatible server). See `reason`. - **host** (required) — type `string`. The server that was asked. - **software** (optional) — type `string`; nullable. Only on a `not_compatible` result (and always on the server endpoint): the software the host runs, from its NodeInfo, e.g. `misskey` or `lemmy`; null when it does not say. Absent otherwise. - **reason** (required) — type `object`; nullable. Why `lookupStatus` is not `found`, or null when it is `found`. - **code** (required) — type `string`; enum: login_required, closed_by_operator, hidden_by_owner, suspended, not_implemented, disabled_by_operator, not_a_mastodon_server, unsupported_server_software, host_not_found, post_not_visible. Machine-readable reason. - **message** (required) — type `string`. Plain-language explanation. - **profile** (required) — type `object`; nullable. The account when `lookupStatus` is `found`; otherwise null. - **id** (required) — type `string`. Account id on `host`. - **host** (required) — type `string`. The server this record came from. - **handle** (required) — type `string`. `user@host`, with the account's home server. - **username** (required) — type `string`. Username without the host. - **url** (required) — type `string`; nullable. Profile page. - **actorUri** (required) — type `string`; nullable. ActivityPub id, when the server shows it. - **displayName** (required) — type `string`; nullable. Display name. - **bioHtml** (required) — type `string`; nullable. Bio as sanitised HTML. - **bio** (required) — type `string`; nullable. Bio as plain text. - **avatar** (required) — type `object`. An avatar or header image. - **url** (required) — type `string`; nullable. Image URL on the server or its media store. - **staticUrl** (required) — type `string`; nullable. Still frame of an animated image. - **description** (required) — type `string`; nullable. Alt text. - **header** (required) — type `object`. An avatar or header image. - **url** (required) — type `string`; nullable. Image URL on the server or its media store. - **staticUrl** (required) — type `string`; nullable. Still frame of an animated image. - **description** (required) — type `string`; nullable. Alt text. - **createdAt** (required) — type `string`; nullable. Account creation, rounded to midnight UTC by the server. - **lastPostDate** (required) — type `string`; nullable. Date of the latest post (a date, not a time). - **stats** (required) — type `object`. The server's own counters. - **followers** (required) — type `integer`; nullable. Accounts following this account. - **following** (required) — type `integer`; nullable. Accounts this account follows. - **posts** (required) — type `integer`; nullable. Posts by this account. - **isBot** (required) — type `boolean`. True when the account is marked as a bot. - **isGroup** (required) — type `boolean`. True when the account is a group. - **isLocked** (required) — type `boolean`. Follow requests need approval. Public posts are still public. - **isLimited** (required) — type `boolean`. The server's moderators limited (silenced) the account. - **isSuspended** (required) — type `boolean`. True when the server suspended the account. - **isDiscoverable** (required) — type `boolean`; nullable. The owner's opt-in to the profile directory and recommendations. null on servers that do not report it. - **isIndexable** (required) — type `boolean`; nullable. The owner's opt-in to search engines indexing public posts. null when not reported. - **noIndex** (required) — type `boolean`; nullable. The owner asks search engines to skip the profile. null when not reported. - **hidesNetwork** (required) — type `boolean`; nullable. The owner hides the follower and following lists. null when not reported. - **movedTo** (required) — type `object`; nullable. The account this one moved to. - **id** (required) — type `string`; nullable. Account id on the server that returned it. - **handle** (required) — type `string`. `user@host` of the account this one moved to. - **url** (required) — type `string`; nullable. Profile page of the new account. - **displayName** (required) — type `string`; nullable. Display name of the new account. - **fields** (required) — type `array`. Profile metadata fields, in the owner's order. - _items:_ - **emojis** (required) — type `array`. Custom emojis used in the display name or bio. - _items:_ - **roles** (required) — type `array`. Public badges such as Owner or Moderator. - _items:_ - **featuredTags** (required) — type `array`; nullable. Featured hashtags when `include=featuredTags`, else null. - _items:_ - **name** (required) — type `string`. Hashtag name without the `#`. - **url** (required) — type `string`; nullable. Hashtag page on the server. - **posts** (required) — type `integer`; nullable. Posts the account published with this hashtag. - **lastPostDate** (required) — type `string`; nullable. Date of the latest post with this hashtag, or null. - **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", "host": "mastodon.social", "reason": null, "profile": { "id": "1", "host": "mastodon.social", "handle": "Gargron@mastodon.social", "username": "Gargron", "url": "https://mastodon.social/@Gargron", "actorUri": "https://mastodon.social/users/Gargron", "displayName": "Eugen Rochko", "bioHtml": "

Executive Strategy & Product Advisor of @Mastodon. Film photography, prog metal, Dota 2. Likes all things analog. Luddite.

", "bio": "Executive Strategy & Product Advisor of @Mastodon. Film photography, prog metal, Dota 2. Likes all things analog. Luddite.", "avatar": { "url": "https://files.mastodon.social/accounts/avatars/000/000/001/original/6b2384b33799a0dd.png", "staticUrl": "https://files.mastodon.social/accounts/avatars/000/000/001/original/6b2384b33799a0dd.png", "description": "A white man with medium-length black hair, a short beard and a mustache, wearing dark-framed glasses and a white t-shirt, holding a Pentax 6x7 camera." }, "header": { "url": "https://files.mastodon.social/accounts/headers/000/000/001/original/d13e4417706a5fec.jpg", "staticUrl": "https://files.mastodon.social/accounts/headers/000/000/001/original/d13e4417706a5fec.jpg", "description": null }, "createdAt": "2016-03-16T00:00:00.000Z", "lastPostDate": "2026-11-07", "stats": { "followers": 381198, "following": 769, "posts": 82777 }, "isBot": false, "isGroup": false, "isLocked": false, "isLimited": false, "isSuspended": false, "isDiscoverable": true, "isIndexable": true, "noIndex": true, "hidesNetwork": false, "movedTo": null, "fields": [ { "name": "GitHub", "valueHtml": "https://github.com/Gargron", "value": "https://github.com/Gargron", "verifiedAt": "2023-02-07T23:24:40.347+00:00" } ], "emojis": [], "roles": [] }, "featuredTags": null }, "meta": { "requestId": "req_6a3cc53b-0b0b-45a8-9e55-5e4cc41c752d", "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.mastodon.getProfile({ handle: "Gargron@mastodon.social", }); 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/mastodon/profiles/Gargron%40mastodon.social", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/mastodon/profiles/Gargron%40mastodon.social" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/mastodon/profiles/Gargron%40mastodon.social", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```