{ "openapi": "3.0.1", "info": { "title": "Snapchat User Stories Scraper & Spotlight Videos Scraper", "description": "Snapchat User Stories & Spotlight Videos Scraper extracts public stories and Spotlight videos, including usernames, captions, video URLs, timestamps, engagement, and creator data. Ideal for content research, trend analysis, competitor monitoring, and social media insights.", "version": "0.1", "x-build-id": "JbdnYHn05VShxrOGI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~snapchat-user-stories-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-snapchat-user-stories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/api-empire~snapchat-user-stories-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-snapchat-user-stories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/api-empire~snapchat-user-stories-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-snapchat-user-stories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "🎥 Snapchat Profiles to Scan", "type": "array", "description": "One or more Snapchat usernames (e.g. fcbarcelona) or profile URLs (e.g. https://www.snapchat.com/@fcbarcelona). Each profile is scanned for its current Story, all Highlights, and all public Spotlight videos.", "items": { "type": "string" } }, "maxSnaps": { "title": "🎞️ Max Snaps per Story/Highlight", "minimum": 1, "type": "integer", "description": "Cap on how many individual snaps to collect per Story or Highlight. Example: maxSnaps=20 keeps only the first 20 snaps of each Story/Highlight. Default is 100. (Does not affect Spotlight videos -- each Spotlight video is always one row.)", "default": 100 }, "includeSpotlight": { "title": "🎬 Include Spotlight Videos", "type": "boolean", "description": "When ON (default), also collect every public Spotlight video for each profile as its own dataset row (type=\"spotlight\") -- id, title, media URL, views/plays, shares, comments, hashtags, duration, width/height, upload date, and deeplink. Turn OFF to only collect Story/Highlight snaps, matching the base actor's original scope.", "default": true }, "minSpotlightViews": { "title": "👁️ Minimum Spotlight Views", "minimum": 0, "type": "integer", "description": "Skip Spotlight videos with fewer plays/views than this. 0 = no filter (default). Only affects Spotlight rows -- Story/Highlight rows are never filtered by this.", "default": 0 }, "minSpotlightShares": { "title": "🔁 Minimum Spotlight Shares", "minimum": 0, "type": "integer", "description": "Skip Spotlight videos with fewer shares than this. 0 = no filter (default). Only affects Spotlight rows.", "default": 0 }, "maxSpotlightItems": { "title": "🎯 Max Spotlight Videos per Profile", "minimum": 0, "type": "integer", "description": "Cap on how many Spotlight video rows to save per profile. 0 = unlimited (default) -- collects every public Spotlight video found on the profile page.", "default": 0 }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Choose which proxies to use. By default, no proxy is used. If Snapchat rejects or blocks the request, the actor automatically falls back to a datacenter proxy, then a residential proxy with 3 retries." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }