> **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 Instagram highlight (https://www.socialfetch.dev/docs/api/v2/instagram/highlights/highlightid/get) ## Summary Get a saved Instagram highlight and the stories inside it by highlight id. **Tags:** `Instagram` ## HTTP - **Method:** GET - **Path:** `/v2/instagram/highlights/{highlightId}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.instagram.getHighlightV2({ highlightId })` - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Agent notes - **Disambiguation:** One story highlight by its id (or an instagram.com /stories/highlights/ URL): the highlight and every story inside it, in the same media object every v2 list returns, with `kind: story`. Get highlight ids from GET /v2/instagram/profiles/{profile}/highlights. - **Empty results:** `not_found` has a null `highlight` and an empty `media`: the highlight doesn't exist, was deleted, or can't be shown (for example when its account is private). It still costs 1 credit. ## 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 ### `highlightId` (path) - **Required:** yes - **Constraints:** type `string` - **Description:** Numeric Instagram highlight id, or an Instagram /stories/highlights/{id} URL. ## Responses (status codes) - **200**: Instagram highlight with its stories. - **400**: Invalid highlight id or query parameter - **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**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Instagram highlight with its stories. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found`, or `not_found` when the highlight doesn't exist or can't be shown (for example when its account is private). - **highlight** (required) — type `object`; nullable. The highlight. Null when not found. - **id** (required) — type `string`; pattern: `^\d+$`. Highlight id. - **title** (required) — type `string`; nullable. Highlight title. - **coverUrl** (required) — type `string`; nullable. Cover image. On a profile's first lookup it can be a smaller one. Instagram CDN URL; it expires after a while. - **mediaCount** (required) — type `integer`; minimum: 0; nullable. Stories in the highlight. Can be null on a profile's first lookup. - **createdAt** (required) — type `string`; nullable. When it was created. Can be null on a profile's first lookup. - **updatedAt** (required) — type `string`; nullable. When it was last changed: a story was added, or it was edited. Never before `createdAt`. Can be null on a profile's first lookup. - **media** (required) — type `array`. The stories in the highlight, in order, each with `kind: story`. Empty when 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. - **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 (found) ```json { "data": { "lookupStatus": "found", "highlight": { "id": "17975319242920589", "title": "Just Do It", "coverUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/2834592cc0f1.jpg?stp=example", "mediaCount": 48, "createdAt": "2025-09-10T18:33:44.000Z", "updatedAt": "2025-09-19T16:48:25.000Z" }, "media": [ { "id": "3713636227774800082", "shortcode": null, "url": null, "kind": "story", "mediaType": "video", "caption": null, "altText": null, "createdAt": "2025-09-03T17:19:17.000Z", "owner": { "id": "13460080", "handle": "nike", "displayName": "Nike", "avatarUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/acfaea167cbc.jpg?stp=example", "verified": true, "privateAccount": false }, "metrics": { "likeCount": null, "commentCount": null, "playCount": null, "shareCount": null, "saveCount": null, "likesHidden": null }, "imageUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/2fdc8ff4719c.jpg?stp=example", "thumbnailUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/2fdc8ff4719c.jpg?stp=example", "videoUrl": "https://scontent.cdninstagram.com/v/t50.2886-16/c18b43fcba76.mp4?stp=example", "durationSec": 9.8, "dimensions": { "width": 1080, "height": 1920 }, "carousel": null, "audio": null, "coauthors": [], "taggedUsers": null, "location": null, "isPaidPartnership": null, "sponsors": null, "commentsDisabled": null, "isPinned": null, "story": { "expiresAt": "2025-09-04T17:19:17.000Z", "linkStickers": [], "mentions": [], "sharedMedia": { "id": "3713567590305427525", "shortcode": "DOJPgxNjvBF" } } } ] }, "meta": { "requestId": "req_01example_instagram_highlight_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 highlight id or query parameter **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**: 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.instagram.getHighlightV2({ highlightId: "18195781759377100", }); 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/highlights/18195781759377100", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v2/instagram/highlights/18195781759377100" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v2/instagram/highlights/18195781759377100", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```