> **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):** [https://www.socialfetch.dev/docs/api/v1/snapchat/spotlights/get](https://www.socialfetch.dev/docs/api/v1/snapchat/spotlights/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/snapchat/spotlights/get.mdx](https://www.socialfetch.dev/docs/api/v1/snapchat/spotlights/get.mdx) ## 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:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/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, 240 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 Snapchat Spotlight (https://www.socialfetch.dev/docs/api/v1/snapchat/spotlights/get) ## Summary Get a Snapchat Spotlight video by URL. **Tags:** `Snapchat` ## HTTP - **Method:** GET - **Path:** `/v1/snapchat/spotlights` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.snapchat.getSpotlight({ url })` - **Accepted identifiers:** `url` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Agent notes - **Disambiguation:** Pass a Spotlight video URL, not a profile URL. Use GET /v1/snapchat/profiles/{handle} for profiles. ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 0 credits charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `url` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Link to the Snapchat Spotlight video. ## Responses (status codes) - **200**: Snapchat Spotlight lookup result. - **400**: Invalid query 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**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Snapchat Spotlight lookup result. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the Spotlight was found. - **spotlight** (required) — type `object`; nullable. Spotlight details when found. - **id** (required) — type `string`; minLength: 1. Spotlight snap identifier. - **url** (required) — type `string`; minLength: 1. Canonical public Snapchat Spotlight URL. - **caption** (required) — type `string`; nullable. Caption written by the creator. - **generatedTitle** (required) — type `string`; nullable. Auto-generated title when available. - **generatedDescription** (required) — type `string`; nullable. Auto-generated description when available. - **keywords** (required) — type `array`. Auto-generated keywords (may be empty). - _items:_ - type `string` - **hashtags** (required) — type `array`. Hashtags on the video (may be empty). - _items:_ - type `string` - **sound** (required) — type `object`; nullable. Sound used in the video when available. - **title** (required) — type `string`. Sound title. - **creatorHandle** (required) — type `string`; nullable. Snapchat username of the sound's creator when available. - **thumbnailUrl** (required) — type `string`; nullable. Thumbnail image URL when available. - **videoUrl** (required) — type `string`; nullable. Video file URL when available. - **durationSeconds** (required) — type `number`; minimum: 0; nullable. Video duration in seconds when available. - **width** (required) — type `integer`; minimum: 0; nullable. Video width in pixels when available. - **height** (required) — type `integer`; minimum: 0; nullable. Video height in pixels when available. - **createdAt** (required) — type `string`; nullable. ISO-8601 timestamp when the video was posted. - **author** (required) — type `object`; nullable. Creator of the video when available. - **handle** (required) — type `string`; nullable. Snapchat username without the leading @. - **displayName** (required) — type `string`; nullable. Public display name when available. - **profileUrl** (required) — type `string`; nullable. Public Snapchat profile URL when available. - **avatarUrl** (required) — type `string`; nullable. Profile image URL when available. - **metrics** (required) — type `object`. Engagement metrics for the video. - **views** (required) — type `integer`; minimum: 0; nullable. View count when available. - **shares** (required) — type `integer`; minimum: 0; nullable. Share count when available. - **comments** (required) — type `integer`; minimum: 0; nullable. Comment count when available. - **boosts** (required) — type `integer`; minimum: 0; nullable. Boost count when available. - **recommends** (required) — type `integer`; minimum: 0; nullable. Recommend count when available. - **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. - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "spotlight": { "id": "W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ", "url": "https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ", "caption": "You are my favorite notification!😄❤️", "generatedTitle": "Jack Scalise's 'Disturb Me' Challenge: How to Get Noticed Online", "generatedDescription": "This short-form content features Jack Scalise, a popular social media personality, inviting his audience to participate in a trending 'disturb me' challenge. The video opens with him speaking directly to the camera against scenic mountain backdrops, using text overlays like 'DISTURB ME UPDATE ME' and 'TELL ME HOW YOUR…", "keywords": [ "how to get noticed online" ], "hashtags": [], "sound": { "title": "Original Sound", "creatorHandle": "jack.scalise" }, "thumbnailUrl": "https://cf-st.sc-cdn.net/d/xL5FK70SP9np2rtr6jkMt.256.IRZXSOY?mo=GkMaCTIBBEgCUC5gAVoQRGZMYXJnZVRodW1ibmFpbKIBEAiAAiILEgAqB0lSWlhTT1miARAImgoiCxIAKgdJUlpYU09Z&uc=46", "videoUrl": "https://cf-st.sc-cdn.net/d/xL5FK70SP9np2rtr6jkMt.27.IRZXSOY?mo=Gk8aCTIBBEgCUC5gAVoQU3BvdGxpZ2h0U2hhcmluZ6IBKwgbEhoKGAjssDMgAUoOCglJICIpKB4jKSEQ9ANoAiILEgAqB0lSWlhTT1mQA8BX&uc=46", "durationSeconds": 11.2, "width": 540, "height": 960, "createdAt": "2025-03-23T15:00:25.631Z", "author": { "handle": "jack.scalise", "displayName": "Jack Scalise", "profileUrl": "https://www.snapchat.com/@jack.scalise", "avatarUrl": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvWDcyaUthUWtVYW1QaTA3cEFVTEVGP2JvPUVnMGFBQm9BTWdFRVNBSlFHV0FCJnVjPTI1._RS0,640_FMjpeg" }, "metrics": { "views": 359945, "shares": 35059, "comments": 636, "boosts": 35666, "recommends": 1834 } } }, "meta": { "requestId": "req_01example", "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 query 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**: 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.snapchat.getSpotlight({ url: "https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYdWhydHdsZWhwAaB_Ig5YAaB_FRlfAAAAAQ", }); 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/snapchat/spotlights?url=https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYdWhydHdsZWhwAaB_Ig5YAaB_FRlfAAAAAQ", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/snapchat/spotlights?url=https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYdWhydHdsZWhwAaB_Ig5YAaB_FRlfAAAAAQ" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/snapchat/spotlights?url=https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYdWhydHdsZWhwAaB_Ig5YAaB_FRlfAAAAAQ", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```