{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper - Search, Channels & Playlists", "description": "Scrape YouTube by search query, channel, playlist or video URL. Every video returns as a flat row with title, URL, thumbnail, duration, upload date, view count and channel profile. Filter by date, duration, type and features. No API key and no quota. Export to CSV, Excel or JSON.", "version": "0.0", "x-build-id": "suvx4Glhhz2RiZUOR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-youtube-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/parseforge~youtube-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-youtube-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/parseforge~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-youtube-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": { "playlistUrls": { "title": "YouTube playlist URLs", "type": "array", "description": "YouTube playlist URLs. Each playlist is read in full, up to maxItems.", "items": { "type": "string" } }, "startUrls": { "title": "Channel or video URLs", "type": "array", "description": "YouTube channel URLs (https://www.youtube.com/@channel), channel handles (@channel) or individual video URLs. A channel returns its uploads; a video URL returns that single video and needs a residential proxy, because YouTube answers LOGIN_REQUIRED to a datacenter address on the watch page.", "items": { "type": "string" } }, "searchQueries": { "title": "YouTube search queries", "type": "array", "description": "Search terms to run on YouTube. For channels and video URLs use the field above.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum videos per input", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many videos to collect per input." }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "type": "string", "description": "How to sort search results (applies to search queries only, not playlists)", "default": "relevance" }, "uploadDate": { "title": "Upload Date", "enum": [ "any", "last_hour", "today", "this_week", "this_month", "this_year" ], "type": "string", "description": "Filter search results by upload date", "default": "any" }, "videoDuration": { "title": "Video Duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Filter search results by video length", "default": "any" }, "videoType": { "title": "Video Type", "enum": [ "video", "film" ], "type": "string", "description": "Filter search results by video type", "default": "video" }, "features": { "title": "Features", "uniqueItems": true, "type": "array", "description": "Filter search results by video features (select multiple)", "items": { "type": "string", "enum": [ "hd", "subtitles", "creative_commons", "3d", "live", "purchased", "4k", "360", "location", "hdr", "vr180" ] } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Datacenter proxy is enough for search, channels and playlists. Individual video URLs need residential, because YouTube refuses the watch page from datacenter addresses.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "BUYPROXIES94952" ] } } } }, "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 } } } } } } } } } }