{ "openapi": "3.0.1", "info": { "title": "Snapchat Scraper – Profiles, Stories, Spotlight & Lenses", "description": "Scrape public Snapchat profiles, Stories, Highlights, Spotlight videos, comments, Discover, Explore, Lenses, Snapcodes, media, and transcripts.", "version": "0.0", "x-build-id": "y1Ep3yEgsbnq1K7ui" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~snapchat-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~snapchat-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~snapchat-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "profileBundle", "profiles", "spotlightDetails", "spotlightFeed", "discover", "explore", "lenses", "snapcodes", "monitor", "auto" ], "type": "string", "description": "Choose which public Snapchat surface or entity type to extract.", "default": "profileBundle" }, "usernames": { "title": "Usernames", "type": "array", "description": "Public Snapchat usernames to extract or monitor.", "items": { "type": "string" }, "default": [ "nba" ] }, "startUrls": { "title": "Public Snapchat URLs", "type": "array", "description": "Public profile, Spotlight, Explore, or Lens URLs to process.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "queries": { "title": "Explore topics", "type": "array", "description": "Topics to extract from public Snapchat Explore pages.", "items": { "type": "string" }, "default": [ "skincare" ] }, "lensCategories": { "title": "Lens categories", "type": "array", "description": "Lens categories such as for_you, trending, face, world, music, creators, or web_live.", "items": { "type": "string" }, "default": [ "for_you" ] }, "snapcodeFormat": { "title": "Snapcode format", "enum": [ "SVG", "PNG" ], "type": "string", "description": "Image format used when retrieving public Snapcodes.", "default": "SVG" }, "maxItems": { "title": "Maximum results per input", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of result records to save for each username, URL, topic, or category.", "default": 1000 }, "maxPages": { "title": "Maximum Lens pages", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of cursor pages to request for each Lens category.", "default": 20 }, "includeRelatedAccounts": { "title": "Include related profiles", "type": "boolean", "description": "Include publicly related Snapchat profiles in profile results.", "default": true }, "includeInitialComments": { "title": "Include public initial comments", "type": "boolean", "description": "Include initial public Spotlight replies when Snapchat publishes them.", "default": true }, "downloadMedia": { "title": "Download media to storage", "type": "boolean", "description": "Download public media to Key-value store; disabled by default because videos can dominate transfer cost.", "default": false }, "downloadTranscripts": { "title": "Download transcripts to storage", "type": "boolean", "description": "Download available public transcript assets to Key-value store.", "default": false }, "maxDownloads": { "title": "Maximum optional downloads per input", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of optional media, transcript, or Snapcode downloads for each input.", "default": 20 }, "maxAssetBytes": { "title": "Maximum bytes per downloaded asset", "minimum": 1000000, "maximum": 500000000, "type": "integer", "description": "Maximum accepted size in bytes for each optional downloaded asset.", "default": 50000000 }, "monitorMode": { "title": "Monitoring output", "enum": [ "off", "onlyNew", "newAndChanged" ], "type": "string", "description": "Return all records, only newly discovered records, or new and changed records.", "default": "off" }, "monitorKey": { "title": "Monitor state key", "type": "string", "description": "Stable key used to keep public profile monitoring state between scheduled runs.", "default": "default" }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Maximum number of public HTTP requests processed in parallel.", "default": 5 }, "includeRaw": { "title": "Include sanitized source payload", "type": "boolean", "description": "Include sanitized source objects for advanced downstream processing.", "default": false } } }, "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 } } } } } } } } } }