> **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, 264 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 an Instagram topic (https://www.socialfetch.dev/docs/api/v2/instagram/topics/topic/get) ## Summary Get an Instagram Popular topic: its title, description and related searches, plus its curated posts. **Tags:** `Instagram` ## HTTP - **Method:** GET - **Path:** `/v2/instagram/topics/{topic}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.instagram.getTopicV2({ topic, cursor? })` - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Agent notes - **Disambiguation:** Instagram's Popular page for a topic: its title, description and related searches, plus the posts Instagram curates for it. For a hashtag use GET /v2/instagram/hashtags/{hashtag}. - **Empty results:** Check `data.lookupStatus`: `not_found` comes back with `topic: null` and an empty `media` list and means Instagram has no Popular page for that topic (try a broader word). `topic` is filled on the first page only; follow `page.nextCursor` with the same `{topic}` while `page.hasMore` is true, and each page is billed once. This feed is intermittently unavailable and answers `503 temporarily_unavailable` (with a Retry-After header) when it is; nothing is charged for a 503, so retry the same request after a few seconds. ## 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 ### `topic` (path) - **Required:** yes - **Constraints:** type `string` - **Description:** A topic such as `harry potter`, or its instagram.com/popular link. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 16384 - **Description:** `nextCursor` from the previous page. ## 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**: An Instagram Popular topic and its posts. - **400**: Invalid topic or cursor, or bad request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: The topic page is temporarily unavailable. This happens now and then; nothing is charged, and the same request is safe to retry after a few seconds (see the Retry-After header). ## Response body (200) An Instagram Popular topic and its posts. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` when Instagram has a Popular page for the topic; `not_found` when it has none (the topic is too rare or unknown). A later page is always `found`. - **topic** (required) — type `object`; nullable. The topic, on the first page only. Null on later pages and when `lookupStatus` is `not_found`. - **title** (required) — type `string`; nullable. Topic title as Instagram shows it. - **description** (required) — type `string`; nullable. Short generated description of the topic. Null when Instagram gives none. - **sourceUrls** (required) — type `array`; nullable. Pages the description draws on, in the order its footnote markers cite them. Null when there is no description. - _items:_ - type `string`; minLength: 1 - **mediaCount** (required) — type `integer`; minimum: 0; nullable. Posts Instagram counts under the topic. Null when not given. - **relatedTerms** (required) — type `array`; nullable. Related searches Instagram suggests for the topic. Null when not given. - _items:_ - type `string`; minLength: 1 - **media** (required) — type `array`. One page of the posts Instagram curates for the topic, in its ranking (not chronological). Empty when `lookupStatus` is `not_found`. - _items:_ - **id** (required) — type `string`; pattern: `^\d+$`. Media id. - **shortcode** (required) — type `string`; nullable. Shortcode used in the media URL. Null for stories. - **url** (required) — type `string`; nullable. Public URL: `/reel/` for Reels, `/p/` otherwise. Null for stories. - **kind** (required) — type `string`; enum: post, reel, story. `post`, `reel` or `story`. - **mediaType** (required) — type `string`; enum: image, video, carousel, null; nullable. `image`, `video` or `carousel`. Null when unknown. - **caption** (required) — type `string`; nullable. Caption text. - **altText** (required) — type `string`; nullable. Alt text Instagram generated or the owner wrote. Null when none or not reported. - **createdAt** (required) — type `string`; nullable. When it was posted. - **owner** (required) — type `object`; nullable. The account that posted it. Null when unknown. - **metrics** (required) — type `object`. Engagement counts. Null when this view doesn't report one. - **imageUrl** (required) — type `string`; nullable. Image, or a video's cover image. Instagram CDN URL; it expires after a while. - **thumbnailUrl** (required) — type `string`; nullable. Small preview image. Instagram CDN URL; it expires after a while. - **videoUrl** (required) — type `string`; nullable. Video file. Instagram CDN URL; it expires after a while. - **durationSec** (required) — type `number`; nullable. Video length in seconds, to the millisecond. - **dimensions** (required) — type `object`; nullable. Pixel size. Null when unknown. - **carousel** (required) — type `array`; nullable. Every item of a carousel, in order. Null when not a carousel. - _items:_ - **audio** (required) — type `object`; nullable. Music or original audio. On a story, the music sticker. Null when none. - **coauthors** (required) — type `array`. Collab co-authors. Empty when none. - _items:_ - **taggedUsers** (required) — type `array`; nullable. Accounts tagged in the media. Empty when none. Null when this view doesn't carry tags. - _items:_ - **location** (required) — type `object`; nullable. Tagged location. Null when none. - **isPaidPartnership** (required) — type `boolean`; nullable. Whether it is labelled as a paid partnership. - **sponsors** (required) — type `array`; nullable. Brands named in the paid-partnership label. Empty when it is not a partnership. Null when this view doesn't say. - _items:_ - **commentsDisabled** (required) — type `boolean`; nullable. Whether the owner turned comments off. Null when this view doesn't say. - **isPinned** (required) — type `boolean`; nullable. Whether the owner pinned it to their profile (to the Reels tab, when listed there). Null when this view doesn't say. - **story** (required) — type `object`; nullable. Story-only details. Null for posts and Reels. - **page** (required) — type `object`. Pagination state. Pass `nextCursor` as `cursor` for the next page while `hasMore` is true. - **kind** (required) — type `string`; enum: cursor, offset, page - **nextCursor** (required) — type `string`; nullable - **hasMore** (required) — type `boolean`; nullable. Null when continuation is unknown for this page. - **start** (required) — type `integer`; minimum: 0; nullable - **page** (required) — type `integer`; minimum: 0; nullable - **count** (required) — type `integer`; minimum: 0; nullable - **returnedCount** (required) — type `integer`; minimum: 0 - **total** (required) — type `integer`; minimum: 0; nullable - **totalPages** (required) — type `integer`; minimum: 0; nullable - **meta** (required) — type `object`. Metadata about the API response. - **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: v2. Public API version that served the response. ### Example JSON (not_found) ```json { "data": { "lookupStatus": "not_found", "topic": null, "media": [], "page": { "kind": "cursor", "nextCursor": null, "hasMore": false, "start": null, "page": null, "count": null, "returnedCount": 0, "total": null, "totalPages": null } }, "meta": { "requestId": "req_01example_instagram_topic_v2", "creditsCharged": 1, "version": "v2" } } ``` ### 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 topic or cursor, or bad 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 from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: The topic page is temporarily unavailable. This happens now and then; nothing is charged, and the same request is safe to retry after a few seconds (see the Retry-After header). **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.instagram.getTopicV2({ topic: "morning coffee routine", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v2/instagram/topics/morning%20coffee%20routine", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v2/instagram/topics/morning%20coffee%20routine" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v2/instagram/topics/morning%20coffee%20routine", 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/v2/instagram/topics/value"); 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(); } ```