{ "openapi": "3.0.1", "info": { "title": "Youtube Shorts Scraper Pro", "description": "Fast and reliable YouTube Shorts data extractor powered by Supadata API and YouTube Data API v3. Extract complete Shorts metadata with 100% field population and guaranteed reliability for short-form vertical content.", "version": "2.3", "x-build-id": "M23bewejayOsoXDha" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~youtube-shorts-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-youtube-shorts-scraper-pro", "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/coregent~youtube-shorts-scraper-pro/runs": { "post": { "operationId": "runs-sync-coregent-youtube-shorts-scraper-pro", "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/coregent~youtube-shorts-scraper-pro/run-sync": { "post": { "operationId": "run-sync-coregent-youtube-shorts-scraper-pro", "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": { "searchQueries": { "title": "Search, Channels, Playlists & Videos", "type": "array", "description": "Discovery sources — each entry is auto-detected as one of: (1) a search keyword or #hashtag (e.g. \"cooking\", \"#viral\"), or a youtube.com/hashtag/ URL — searched via TikHub Shorts search (single keywords, hashtags, and multi-word phrases all work); hashtag entries are attributed sourceType: \"hashtag\". (2) a channel — URL, @handle, /channel/UC…, /c/…, /user/…, or a bare channel ID; (3) a playlist — URL (…?list=…) or a bare playlist ID (PL…, UU…); (4) a video URL or 11-char video ID, treated as a SEED — its owning channel is found and that channel's Shorts are returned. Each source is capped by \"Max Shorts per source\". To fetch one specific video as-is, use the Direct Shorts URLs section further below.", "items": { "type": "string" }, "default": [] }, "maxResultsPerQuery": { "title": "Max Shorts per source", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum videos to take from EACH discovery source (keyword, channel, playlist, or seed-video channel) before filtering to Shorts. Does not affect the Direct Shorts URLs section.", "default": 50 }, "maxTotalResults": { "title": "Max Total Results (optional)", "minimum": 0, "type": "integer", "description": "Global cap on candidate videos across all discovery sources, applied before metadata is fetched. Useful to bound cost on large runs. Leave 0 for unlimited.", "default": 0 }, "regionCode": { "title": "Country", "enum": [ "US", "GB", "CA", "AU", "IN", "DE", "FR", "JP", "BR", "MX", "ES", "IT", "KR", "RU" ], "type": "string", "description": "Country for localization (ISO 3166-1 alpha-2). Affects search results and regional trends.", "default": "US" }, "language": { "title": "Language", "enum": [ "en", "es", "de", "fr", "pt", "ja", "hi", "zh", "ko", "ru", "ar", "it" ], "type": "string", "description": "Preferred language (IETF BCP-47).", "default": "en" }, "fromDate": { "title": "From Date (optional)", "type": "string", "description": "Only include Shorts published on or after this date (ISO 8601: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ)", "default": "" }, "toDate": { "title": "To Date (optional)", "type": "string", "description": "Only include Shorts published on or before this date (ISO 8601: YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ)", "default": "" }, "sortShorts": { "title": "Sort shorts by (optional)", "enum": [ "newest", "oldest", "popular" ], "type": "string", "description": "Sort extracted Shorts by newest first, oldest first, or most popular.", "default": "newest" }, "minViews": { "title": "Min Views (optional)", "minimum": 0, "type": "integer", "description": "Only include Shorts with at least this many views. 0 = no filter.", "default": 0 }, "minLikes": { "title": "Min Likes (optional)", "minimum": 0, "type": "integer", "description": "Only include Shorts with at least this many likes. 0 = no filter.", "default": 0 }, "minComments": { "title": "Min Comments (optional)", "minimum": 0, "type": "integer", "description": "Only include Shorts with at least this many comments. 0 = no filter.", "default": 0 }, "shortsUrls": { "title": "Direct Shorts URLs", "type": "array", "description": "Direct videos — one output record per entry, for that video only (no channel expansion, returned as-is even if it is not ≤180s, and exempt from the discovery filters above). Accepts Shorts/watch/youtu.be URLs or bare 11-char video IDs. Enter manually, upload a text file, or link a remote text file. Channel/playlist/keyword entries here are skipped — put those in Search & Discovery.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeTranscript": { "title": "Include Transcript", "type": "boolean", "description": "Extract transcript/captions for each result via TikHub. Adds 1-2 seconds per video. About 60-80% of Shorts have transcripts available.", "default": false }, "transcriptLanguage": { "title": "Transcript Language", "enum": [ "", "en", "es", "fr", "de", "pt", "ru", "ja", "ko", "zh", "zh-TW", "ar", "hi", "it", "nl", "tr", "pl", "sv", "da", "no", "fi", "cs", "hu", "el", "he", "th", "id", "ms", "vi", "ro", "uk" ], "type": "string", "description": "Select preferred transcript language. Auto-detect will use the first available language. Only used if Include Transcript is enabled.", "default": "" } } }, "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 } } } } } } } } } }