> **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`). --- # List Mastodon trending links (https://www.socialfetch.dev/docs/api/v1/mastodon/trends/links/get) ## Summary List the links trending on a Mastodon server. **Tags:** `Mastodon` ## HTTP - **Method:** GET - **Path:** `/v1/mastodon/trends/links` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.mastodon.listTrendingLinks({ host: "mastodon.social", limit: 20, cursor: "eyJ2IjoxLCJrIjoib2Zmc2V0IiwibyI6NX0" })` - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **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 ### `host` (query) - **Required:** yes - **Constraints:** type `string` - **Description:** The Mastodon server to ask, e.g. `mastodon.social`. A server URL is also accepted. The server you name is the one that answers. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 512 - **Description:** Pass `page.nextCursor` from the previous response (a plain number is taken as an offset). The list is ordered live, so a row can appear on two pages; remove repeats by `id`, `name` or `url`. ### `offset` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 100000; nullable - **Description:** Items to skip, as an offset. Prefer `cursor` for the next page. Default: 0. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 20 - **Description:** Items per page, 1 to 20. Default: 20. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: Links trending on one server. - **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) Links trending on one server. ### 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. - **links** (required) — type `array`. Trending links, most shared first. - _items:_ - **url** (required) — type `string`. The link the card points to. - **title** (required) — type `string`. Title of the linked page. - **description** (required) — type `string`; nullable. Short description of the linked page. - **type** (required) — type `string`; nullable. `link`, `photo`, `video` or `rich`. - **providerName** (required) — type `string`; nullable. Site that published the linked page. - **providerUrl** (required) — type `string`; nullable. The publisher's own page. - **authors** (required) — type `array`. Authors of the linked page. - _items:_ - **publishedAt** (required) — type `string`; nullable. When the linked page was published, when known. - **language** (required) — type `string`; nullable. ISO language code of the linked page, when known. - **image** (required) — type `object`; nullable. Preview image, when the link has one. - **history** (required) — type `array`. Daily shares and distinct accounts, newest first. - _items:_ - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. The way to the next page: pass it as `cursor`; null on the last page. - **nextOffset** (required) — type `integer`; nullable. Offset to pass as `offset`; null on the last page. Prefer `nextCursor`. - **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, "links": [ { "url": "https://www.propublica.org/article/burgum-public-land-data-centers-investments", "title": "Trump Official Who Wants Data Centers on Public Lands Has Tens of Millions Invested in AI Industry", "description": "Interior Secretary Doug Burgum, who is heavily invested in the AI industry, is leading the charge to allow tech companies to build data centers on the public lands he oversees.", "type": "link", "providerName": "ProPublica", "providerUrl": null, "authors": [], "publishedAt": "2026-11-06T11:00:00.000Z", "language": "en", "image": { "url": "https://files.mastodon.social/cache/preview_cards/images/213/730/837/original/54478d66f87c23a4.jpg", "description": null, "blurhash": "UdLf~]4UNGIU_MIAM{tQXnS2M{ogxuf5V?WB", "width": 662, "height": 348 }, "history": [ { "date": "2026-11-07", "uses": 22, "accounts": 22 } ] } ], "page": { "hasMore": true, "nextCursor": "eyJ2IjoxLCJrIjoib2Zmc2V0IiwibyI6NX0", "nextOffset": 5 } }, "meta": { "requestId": "req_5bdb354b-701f-467d-81ae-c57448ba0ad0", "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.listTrendingLinks({ host: "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/trends/links?host=mastodon.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/trends/links?host=mastodon.social" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/mastodon/trends/links?host=mastodon.social", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/mastodon/trends/links"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```