Snapchat Spotlight video API
  1. Docs
  2. Snapchat
  3. Snapchat Spotlight video API

Snapchat Spotlight video API

One public Spotlight video by link: id, description, creator, engagement counts, thumbnail and content URL, where Snapchat shows them.

GET /v1/snapchat/spotlight

GET /v1/snapchat/spotlight

One public Spotlight video by link: id, description, creator, engagement counts, thumbnail and content URL, where Snapchat shows them.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
urlURLyesSpotlight URL (snapchat.com/@user/spotlight/...). Accepted hosts: snapchat.com.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/snapchat/spotlight" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "url=https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ"

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_f001e75e6a68811e22be5b8b",8  "data": {9    "object": "post",10    "platform": "snapchat",11    "id": "W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ",12    "url": "https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ",13    "type": "video",14    "author": {15      "id": null,16      "handle": "jack.scalise",17      "name": "Jack Scalise",18      "url": "https://www.snapchat.com/@jack.scalise",19      "avatar_url": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvWDcyaUthUWtVYW1QaTA3cEFVTEVGP2JvPUVnMGFBQm9BTWdFRVNBSlFHV0FCJnVjPTI1._RS0,640_FMjpeg",20      "verified": null21    },22    "title": null,23    "text": "You are my favorite notification!😄❤️",24    "published_at": "2025-03-23T15:00:25.631000Z",25    "duration_seconds": 11.0,26    "language": null,27    "hashtags": null,28    "mentions": null,29    "stats": {30      "views": 359953,31      "likes": 1820,32      "comments": 636,33      "shares": 35059,34      "saves": null,35      "dislikes": null36    },37    "media": {38      "thumbnail_url": "https://cf-st.sc-cdn.net/d/xL5FK70SP9np2rtr6jkMt.256.IRZXSOY?mo=GkMaCTIBBEgCUC5gAVoQRGZMYXJnZVRodW1ibmFpbKIBEAiAAiILEgAqB0lSWlhTT1miARAImgoiCxIAKgdJUlpYU09Z&uc=46",39      "video_url": "https://cf-st.sc-cdn.net/d/xL5FK70SP9np2rtr6jkMt.27.IRZXSOY?mo=Gk8aCTIBBEgCUC5gAVoQU3BvdGxpZ2h0U2hhcmluZ6IBKwgbEhoKGAjssDMgAUoOCglJICIpKB4jKSEQ9ANoAiILEgAqB0lSWlhTT1mQA8BX&uc=46",40      "audio_url": null,41      "image_urls": null,42      "width": 540,43      "height": 96044    },45    "song": {46      "id": null,47      "title": "Original Sound",48      "artist": "jack.scalise",49      "url": null50    },51    "location": null,52    "is_pinned": null,53    "is_sponsored": null,54    "extra": {55      "boost_count": 35666,56      "creator_has_badge": true,57      "description_generated": "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 b...",58      "keywords": [59        "relationship",60        "communication",61        "support"62      ],63      "keywords_generated": [64        "how to get noticed online",65        "engagement tips for creators",66        "create viral content"67      ],68      "recommend_count": 1820,69      "transcript": "disturb me update me tell me how your day was because i love hearing from you",70      "transcript_url": "https://bolt-gcdn.sc-cdn.net/3/qFbYrpUtxHtWW3OTCKXnH.vtt?bo=EgkyAX1IAlAuYAE%3D&uc=46"71    }72  },73  "cursor": null,74  "has_more": null75}

Response#

A Post object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

1{2  "ok": false,3  "error": {4    "code": "not_found",5    "message": "The platform says this profile, post or item does not exist.",6    "retryable": false7  },8  "credits_charged": 0,9  "request_id": "req_9acc3644304236fecbd84caa"10}