{ "openapi": "3.0.1", "info": { "title": "Snapchat Scraper: Profiles, Spotlight, Stories & Highlights", "description": "Scrape public Snapchat profiles: display name, subscribers, bio, website, category, verified badge, related accounts and lenses. Plus Spotlight videos with views, shares, comments, boosts and video URL, saved Story highlights and the current public Story.", "version": "1.0", "x-build-id": "BdIPeNCTswW90o0Bk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~snapchat-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-snapchat-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/ksvan~snapchat-scraper/runs": { "post": { "operationId": "runs-sync-ksvan-snapchat-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/ksvan~snapchat-scraper/run-sync": { "post": { "operationId": "run-sync-ksvan-snapchat-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", "properties": { "profiles": { "title": "Usernames or profile links", "type": "array", "description": "Public Snapchat accounts: kyliejenner, @djkhaled305, https://www.snapchat.com/add/nasa, https://www.snapchat.com/@mrbeast.", "items": { "type": "string" } }, "spotlightUrls": { "title": "Spotlight links", "type": "array", "description": "Single Spotlight videos: https://www.snapchat.com/spotlight/.", "items": { "type": "string" } }, "includeSpotlights": { "title": "Spotlight videos", "type": "boolean", "description": "Save the Spotlight videos shown on each profile (views, shares, comments, boosts, video URL, sound).", "default": true }, "includeHighlights": { "title": "Story highlights", "type": "boolean", "description": "Save the profile's saved Story highlights.", "default": true }, "includeStory": { "title": "Current Story", "type": "boolean", "description": "Save the current public Story (last 24 hours) with every snap's media URL.", "default": true }, "includeSnapList": { "title": "Snaps inside highlights", "type": "boolean", "description": "Add the list of snaps (media URL, type, date) to every highlight record.", "default": false }, "maxItems": { "title": "Max records in total", "minimum": 0, "type": "integer", "description": "0 = no limit. Counts profiles, Spotlight videos, highlights and stories.", "default": 0 }, "maxConcurrency": { "title": "Parallel profiles", "minimum": 1, "maximum": 20, "type": "integer", "description": "Profiles loaded at the same time.", "default": 8 }, "maxRetries": { "title": "Max retries per page", "minimum": 2, "maximum": 10, "type": "integer", "description": "Each retry uses a new proxy IP.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default: datacenter proxy with automatic switch to residential when Snapchat blocks.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }