API reference
Snapchat Spotlight API
One Spotlight: description, content and thumbnail URLs, duration, upload time, creator and view, share, comment, boost and recommend counts.
Endpoint
GET/v1/snapchat/spotlightlive · proven4 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
url | yes | Spotlight URL | https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYaHNzY2NxbWZ0AZTYE3AmAZTYE2UcAAAAAA |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FW7_EDlXWTBiXAEEniNoMPwAAYaHNzY2NxbWZ0AZTYE3AmAZTYE2UcAAAAAA" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FW7_EDlXWTBiXAEEniNoMPwAAYaHNzY2NxbWZ0AZTYE3AmAZTYE2UcAAAAAA",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/snapchat/spotlight?url=https%3A%2F%2Fwww.snapchat.com%2Fspotlight%2FW7_EDlXWTBiXAEEniNoMPwAAYaHNzY2NxbWZ0AZTYE3AmAZTYE2UcAAAAAA",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "snapchat",
"endpoint": "/v1/snapchat/spotlight",
"data": {
"id": "example",
"description": "Illustrative caption."
},
"credits_used": 4,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
id | string | null | Exact source identifier; preserve it as a string. |
story_id | string | null | story id |
description | string | null | description |
content_url | string | null | content url |
thumbnail_url | string | null | thumbnail url |
uploaded_at | string | null | uploaded at |
creator | string | null | creator |
duration_ms | number | null | Milliseconds. |
stats | object | null | Nested response fields; optional unless explicitly documented. |
stats.views | number | null | views; null is unknown. |
stats.shares | number | null | shares; null is unknown. |
stats.comments | number | null | comments; null is unknown. |
stats.boosts | number | null | boosts; null is unknown. |
stats.recommends | number | null | recommends; null is unknown. |
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference