{ "openapi": "3.0.1", "info": { "title": "Snapchat Spotlight Hashtag Video Extractor", "description": "Pull Snapchat Spotlight videos published under a hashtag or topic, with engagement stats, creator details, AI-generated descriptions and related topic tags.", "version": "1.0", "x-build-id": "Y6tGkzMqVIlFeVcQD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~snapchat-spotlight-hashtag-video-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-snapchat-spotlight-hashtag-video-extractor", "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/vexaloom-labs~snapchat-spotlight-hashtag-video-extractor/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-snapchat-spotlight-hashtag-video-extractor", "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/vexaloom-labs~snapchat-spotlight-hashtag-video-extractor/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-snapchat-spotlight-hashtag-video-extractor", "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": { "mode": { "title": "Mode", "enum": [ "hashtagFeed", "spotlightFeed", "spotlightUrls" ], "type": "string", "description": "Choose what to collect: videos for hashtags/topics, a paginated Spotlight feed, or specific Spotlight URLs.", "default": "hashtagFeed" }, "hashtags": { "title": "Hashtags, topics, or URLs", "type": "array", "description": "Used in Hashtag or topic videos mode. Bare words (food), hash-prefixed tags (#travel), path forms (/tag/food, /topic/cappuccino-foam-technique), or full Snapchat URLs (https://www.snapchat.com/tag/food, https://www.snapchat.com/topic/cappuccino-foam-technique).", "items": { "type": "string" }, "default": [] }, "resultsPerHashtag": { "title": "Max videos per hashtag", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum videos to keep for each hashtag after combining the tag/topic page with Explore results. Snapchat serves about 32 videos per tag page plus about 20-25 Explore cards.", "default": 50 }, "includeVideoUrls": { "title": "Include video URLs", "type": "boolean", "description": "Include the watermarked and unwatermarked MP4 CDN URLs. These URLs carry expiring Snapchat tokens, so download or re-host media soon after scraping.", "default": true }, "includeRelatedTopics": { "title": "Include related topics and tags", "type": "boolean", "description": "Include related topics, related hashtags, and scene-to-interest (S2I) content tags when the page provides them.", "default": true }, "includeLlmMetadata": { "title": "Include AI metadata", "type": "boolean", "description": "Include Snapchat's AI-generated title, description, and keywords when present.", "default": true }, "includeHashtagMetadata": { "title": "Include hashtag metadata", "type": "boolean", "description": "Include hashtag identity fields (id, name, URL, source, description, and total video count when Snapchat exposes it) in every record.", "default": true }, "enrichDetails": { "title": "Enrich with video details", "type": "boolean", "description": "Batch-fetch Snapchat's public video details endpoint to fill unwatermarked MP4 URLs, hashtags, AI metadata, duration, and exact engagement counts. Adds one request per 30 videos.", "default": true }, "spotlightUrls": { "title": "Spotlight URLs or IDs", "type": "array", "description": "Used in Specific Spotlight URLs mode, or as the optional first seed in Paginated Spotlight feed mode. Accepts full Spotlight links (https://www.snapchat.com/@user/spotlight/ID), /spotlight/ID links, or raw IDs.", "items": { "type": "string" }, "default": [] }, "feedPages": { "title": "Feed pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages of the Spotlight up-next feed to request in Paginated Spotlight feed mode. Each page adds about 20-23 videos; pagination stops early when Snapchat runs out.", "default": 5 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on the total number of video rows saved across the whole run.", "default": 1000 }, "minViews": { "title": "Minimum views", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Keep only videos with at least this many views. Use 0 to keep everything.", "default": 0 }, "minLikes": { "title": "Minimum likes", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Keep only videos with at least this many likes. Use 0 to keep everything.", "default": 0 }, "sinceDate": { "title": "Uploaded since", "type": "string", "description": "Keep only videos uploaded on or after this date. Use YYYY-MM-DD (for example 2026-01-01). Leave empty to keep all dates.", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "source", "newest", "mostViewed", "mostLiked" ], "type": "string", "description": "Order within each hashtag/topic group. Hashtags stay in the order you enter them; feed mode sorts the whole feed. Source order keeps Snapchat's own ranking.", "default": "source" } } }, "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 } } } } } } } } } }