{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper API: Videos, Transcripts, Shorts & Channels", "description": "Scrape YouTube videos, Shorts and live streams from search results, channels and playlists, with the full transcript of each video at no extra cost. Exact views, likes, publish date, duration, tags and description. No API key, no quota, no login; also via MCP. $2 per 1,000 videos.", "version": "0.1", "x-build-id": "KtigBdwmDSPsuBCDZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sauliusautomatesit~youtube-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sauliusautomatesit-youtube-scraper-api", "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/sauliusautomatesit~youtube-scraper-api/runs": { "post": { "operationId": "runs-sync-sauliusautomatesit-youtube-scraper-api", "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/sauliusautomatesit~youtube-scraper-api/run-sync": { "post": { "operationId": "run-sync-sauliusautomatesit-youtube-scraper-api", "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 queries", "type": "array", "description": "One keyword or phrase per line, as you would type it into YouTube search. Each query returns up to \"Max videos per input\" videos.", "items": { "type": "string" } }, "startUrls": { "title": "YouTube URLs", "type": "array", "description": "Video, Short, channel, playlist or search URLs, one per line: `https://www.youtube.com/watch?v=...`, `https://www.youtube.com/shorts/...`, `https://www.youtube.com/@handle`, `https://www.youtube.com/channel/UC...`, `https://www.youtube.com/playlist?list=...`.", "items": { "type": "string" } }, "maxResults": { "title": "Max videos per input", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most videos to return for each search query, playlist and channel tab. A video URL always returns one video.", "default": 50 }, "sortBy": { "title": "Search: sort by", "enum": [ "relevance", "date", "views", "rating" ], "type": "string", "description": "Order of search results. Applies to search queries only.", "default": "relevance" }, "uploadDate": { "title": "Search: upload date", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded in this period. Applies to search queries only.", "default": "any" }, "duration": { "title": "Search: duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Only videos of this length: short is under 4 minutes, medium 4 to 20 minutes, long over 20 minutes. Applies to search queries only.", "default": "any" }, "channelContent": { "title": "Channels: what to collect", "type": "array", "description": "Which channel tabs to read for channel URLs: long videos, Shorts, live streams. A URL that already ends in /videos, /shorts or /streams uses that tab only.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live streams" ] }, "default": [ "videos" ] }, "includeTranscripts": { "title": "Include transcripts", "type": "boolean", "description": "Add each video's transcript (captions or YouTube's auto captions) to its row as plain text. Included in the per video price, no extra charge. Videos without captions get transcriptError NO_CAPTIONS.", "default": false }, "transcriptLanguages": { "title": "Transcripts: languages", "type": "array", "description": "Preferred caption languages, best first, as codes like en, es, de. When none match, English or the first available track is used.", "default": [ "en" ], "items": { "type": "string" } }, "transcriptTimestamps": { "title": "Transcripts: add timestamps", "type": "boolean", "description": "Also add transcriptSegments: every caption line with its start and duration in seconds.", "default": false }, "concurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many videos are fetched at the same time.", "default": 20 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is used by default and is included in the price. Change only if you know you need to.", "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 } } } } } } } } } }