Get a Snapchat Spotlight video

Try in Playground

Retrieve a public Spotlight video with its creator, caption, media, dimensions, timestamps, hashtags, sound context, engagement and generated metadata.

GET/v1/snapchat/spotlightx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Required HTTPS Snapchat Spotlight URL; canonical and creator-qualified Spotlight links are accepted.

max 4096 chars

Examplehttps://www.snapchat.com/spotlight/Synthetic_Spotlight_Identifier_001

Response fields

requestIdstring

Request correlation UUID.

Upstream request count, decoded response bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Upstream HTTP attempts used by this request.

≥ 0

accounting.responseBytesinteger

Decoded source response bytes.

≥ 0

accounting.durationMsnumber

Elapsed retrieval milliseconds.

≥ 0

successboolean

True when usable Snapchat data is returned.

statusenum

success or partial for usable data. Failure responses use failed or challenged.

one of: success, partial

sourceUrlstring

Canonical Snapchat page or Spotlight URL.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Source, completeness and warnings for the returned public records.

coverage.sourceenum

public_page or public_comments.

one of: public_page, public_comments

coverage.completeboolean

Whether the selected source response was returned without a reported omission.

coverage.warningsstring[]

Warning codes describing omitted or additional records.

coverage.orderenumoptional

Returned record order, such as ranked or source_order.

one of: source_order, ranked

spotlightobject

Spotlight summary with snapId, storyId, description, generated text, creator, numeric counts, duration, dimensions, timestamps and media URLs.

storyobject

Source story ID, title, thumbnail and ordered snapList with media IDs, types, URLs and timestamps.

metadataobject

Original public-source video and creator metadata, context cards, hashtags, engagementStats, description, generated text and extensions; source count strings remain unchanged.

videoMetadataobjectnullable

Published page-level video metadata with source creator identity, URLs, duration and counts; null when absent.

linkPreviewobjectnullable

Published link-preview metadata, or null.

pageMetadataobjectnullable

Published page metadata, or null.

transcriptMapobject

Public transcript data published by the page, preserving the original source map.

Normalized Spotlight metadata alongside the preserved source records.

video.idstring

Snapchat Spotlight story identifier, preserved as a string.

video.urlstring

Canonical public Spotlight URL.

absolute HTTPS URL

video.captionstringnullable

Published description or caption, or null.

video.generatedTitlestringnullable

Source generated title, or null.

video.generatedDescriptionstringnullable

Source generated description, or null.

video.keywordsstring[]

Published generated or video keywords.

up to 100 items

video.hashtagsstring[]

Published hashtags.

up to 100 items

Published sound title and creator handle, or null.

video.sound.titlestringnullable

Sound title.

video.sound.creatorHandlestringnullable

Sound creator handle.

video.thumbnailUrlstringnullable

Published thumbnail URL.

video.videoUrlstringnullable

Published video media URL.

video.durationSecondsnumbernullable

Video duration in seconds, or null.

video.widthintegernullable

Video width in pixels, or null.

video.heightintegernullable

Video height in pixels, or null.

video.createdAtstringnullable

UTC upload time, or null.

Creator handle, display name, profile URL and avatar URL.

video.author.handlestringnullable

Creator handle.

video.author.displayNamestringnullable

Creator display name.

video.author.profileUrlstringnullable

Public creator profile URL.

video.author.avatarUrlstringnullable

Creator avatar URL, or null.

Public views, shares, comments, boosts and recommends. An unreported counter is null.

video.metrics.viewsintegernullable

Published view count.

video.metrics.sharesintegernullable

Published share count.

video.metrics.commentsintegernullable

Published comment count.

video.metrics.boostsintegernullable

Published boost count.

video.metrics.recommendsintegernullable

Published recommend count.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, unknown or malformed parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The requested page reports restricted access.
404	`not_found`	The requested public record was not found.
429	`upstream_rate_limited`	Snapchat temporarily rate limited retrieval.
502	`upstream_challenged`	Snapchat challenged the request.
502	`unsupported_page`	The public source does not validate against the supported structure.
502	`response_too_large` `payload_too_complex`	The source exceeded byte or structural bounds.
502	`unsafe_redirect` `request_limit` `upstream_error`	Retrieval could not complete within its source and request bounds.
503	`busy`	The worker admission queue is full or its wait deadline was exceeded.
504	`timeout`	The request exceeded its deadline.

Code example

curl "https://api.scrapeatlas.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FSynthetic_Spotlight_Identifier_001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FSynthetic_Spotlight_Identifier_001",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FSynthetic_Spotlight_Identifier_001",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Snapchat request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/snapchat/spotlight",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.snapchat.com/spotlight/Synthetic_Spotlight_Identifier_001"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FSynthetic_Spotlight_Identifier_001", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FSynthetic_Spotlight_Identifier_001"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://www.snapchat.com/spotlight/Synthetic_Spotlight_Identifier_001",
  "fetchedAt": "2026-10-06T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 9000,
    "durationMs": 450
  },
  "spotlight": {
    "snapId": "Synthetic_Spotlight_Identifier_001",
    "storyId": "Synthetic_Spotlight_Identifier_001",
    "description": "Synthetic caption",
    "llmTitle": "Synthetic generated title",
    "llmDescription": "Synthetic generated description",
    "viewCount": 500,
    "shareCount": 10,
    "commentCount": 2,
    "boostCount": 7,
    "recommendCount": 3,
    "engagementStats": {
      "viewCount": 500,
      "shareCount": 10,
      "commentCount": 2,
      "boostCount": 7,
      "recommendCount": 3
    },
    "creator": {
      "$case": "personCreator",
      "personCreator": {
        "username": "example.creator",
        "url": "https://www.snapchat.com/@example.creator",
        "name": "Example Creator",
        "followerCount": "1200",
        "websiteUrl": "https://example.test"
      }
    },
    "durationMs": 12500,
    "width": 540,
    "height": 960,
    "uploadDateMs": 1700000000000,
    "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
    "contentUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
    "raw": {
      "story": {
        "storyType": 1,
        "snapList": [
          {
            "snapIndex": 0,
            "snapId": {
              "value": "Synthetic_Spotlight_Identifier_001"
            },
            "snapMediaType": 1,
            "snapUrls": {
              "mediaUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
              "mediaPreviewUrl": {
                "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
              },
              "overlayUrl": null,
              "attachmentUrl": null
            },
            "timestampInSec": {
              "value": "1700000000"
            },
            "snapTitle": null
          }
        ],
        "storyId": {
          "value": "Synthetic_Spotlight_Identifier_001"
        },
        "storyTitle": null,
        "thumbnailUrl": {
          "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
        },
        "storyTapId": "",
        "thumbnailTiles": []
      },
      "metadata": {
        "videoMetadata": {
          "name": "Synthetic generated title",
          "description": "Synthetic caption",
          "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
          "uploadDateMs": "1700000000000",
          "viewCount": "500",
          "contentUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
          "creator": {
            "$case": "personCreator",
            "personCreator": {
              "username": "example.creator",
              "url": "https://www.snapchat.com/@example.creator",
              "name": "Example Creator",
              "followerCount": "1200",
              "websiteUrl": "https://example.test"
            }
          },
          "durationMs": "12500",
          "width": 540,
          "height": 960,
          "keywords": [
            "synthetic"
          ],
          "shareCount": "10",
          "embeddedTextCaption": "Synthetic on-screen text"
        },
        "userMetadata": null,
        "lensMetadata": null,
        "hashtags": [
          "example"
        ],
        "contextCards": [
          {
            "contextType": 2,
            "title": "Original Sound",
            "subtitle": "example.creator",
            "id": "sound-001"
          }
        ],
        "engagementStats": {
          "viewCount": 500,
          "shareCount": 10,
          "commentCount": 2,
          "boostCount": 7,
          "recommendCount": 3
        },
        "description": "Synthetic caption",
        "llmTitle": "Synthetic generated title",
        "llmDescription": "Synthetic generated description",
        "llmKeywords": [
          "synthetic generated keyword"
        ]
      },
      "contentSource": "SPOTLIGHT"
    }
  },
  "story": {
    "storyType": 1,
    "snapList": [
      {
        "snapIndex": 0,
        "snapId": {
          "value": "Synthetic_Spotlight_Identifier_001"
        },
        "snapMediaType": 1,
        "snapUrls": {
          "mediaUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
          "mediaPreviewUrl": {
            "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
          },
          "overlayUrl": null,
          "attachmentUrl": null
        },
        "timestampInSec": {
          "value": "1700000000"
        },
        "snapTitle": null
      }
    ],
    "storyId": {
      "value": "Synthetic_Spotlight_Identifier_001"
    },
    "storyTitle": null,
    "thumbnailUrl": {
      "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
    },
    "storyTapId": "",
    "thumbnailTiles": []
  },
  "metadata": {
    "videoMetadata": {
      "name": "Synthetic generated title",
      "description": "Synthetic caption",
      "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
      "uploadDateMs": "1700000000000",
      "viewCount": "500",
      "contentUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
      "creator": {
        "$case": "personCreator",
        "personCreator": {
          "username": "example.creator",
          "url": "https://www.snapchat.com/@example.creator",
          "name": "Example Creator",
          "followerCount": "1200",
          "websiteUrl": "https://example.test"
        }
      },
      "durationMs": "12500",
      "width": 540,
      "height": 960,
      "keywords": [
        "synthetic"
      ],
      "shareCount": "10",
      "embeddedTextCaption": "Synthetic on-screen text"
    },
    "userMetadata": null,
    "lensMetadata": null,
    "hashtags": [
      "example"
    ],
    "contextCards": [
      {
        "contextType": 2,
        "title": "Original Sound",
        "subtitle": "example.creator",
        "id": "sound-001"
      }
    ],
    "engagementStats": {
      "viewCount": "500",
      "shareCount": "10",
      "commentCount": "2",
      "boostCount": "7",
      "recommendCount": "3"
    },
    "description": "Synthetic caption",
    "llmTitle": "Synthetic generated title",
    "llmDescription": "Synthetic generated description",
    "llmKeywords": [
      "synthetic generated keyword"
    ]
  },
  "videoMetadata": {
    "name": "Synthetic generated title",
    "description": "Synthetic caption",
    "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
    "uploadDateMs": "1700000000000",
    "viewCount": "500",
    "contentUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
    "creator": {
      "$case": "personCreator",
      "personCreator": {
        "username": "example.creator",
        "url": "https://www.snapchat.com/@example.creator",
        "name": "Example Creator",
        "followerCount": "1200",
        "websiteUrl": "https://example.test"
      }
    },
    "durationMs": "12500",
    "width": 540,
    "height": 960,
    "keywords": [
      "synthetic"
    ],
    "shareCount": "10",
    "embeddedTextCaption": "Synthetic on-screen text"
  },
  "linkPreview": null,
  "pageMetadata": null,
  "transcriptMap": {},
  "video": {
    "id": "Synthetic_Spotlight_Identifier_001",
    "url": "https://www.snapchat.com/spotlight/Synthetic_Spotlight_Identifier_001",
    "caption": "Synthetic caption",
    "generatedTitle": "Synthetic generated title",
    "generatedDescription": "Synthetic generated description",
    "keywords": [
      "synthetic generated keyword"
    ],
    "hashtags": [
      "example"
    ],
    "sound": {
      "title": "Original Sound",
      "creatorHandle": "example.creator"
    },
    "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
    "videoUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
    "durationSeconds": 12.5,
    "width": 540,
    "height": 960,
    "createdAt": "2023-11-14T22:13:20.000Z",
    "author": {
      "handle": "example.creator",
      "displayName": "Example Creator",
      "profileUrl": "https://www.snapchat.com/@example.creator",
      "avatarUrl": null
    },
    "metrics": {
      "views": 500,
      "shares": 10,
      "comments": 2,
      "boosts": 7,
      "recommends": 3
    }
  }
}

Missing, duplicate, unknown or malformed parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}