{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper - Videos, Transcripts & Comments", "description": "The all-in-one YouTube scraper. One run takes a channel, playlist, handle or keyword search and returns every video with its details, its full transcript as clean text, and top comments. No API key needed. Pay only for the videos you get.", "version": "0.1", "x-build-id": "sUym9r2doeCgZnfog" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swerve~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swerve-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/swerve~youtube-scraper/runs": { "post": { "operationId": "runs-sync-swerve-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/swerve~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-swerve-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": { "startUrls": { "title": "YouTube URLs", "type": "array", "description": "Paste YouTube video, channel, playlist or @handle URLs. A channel or playlist URL returns every video it contains; a video URL returns just that video. Examples: https://www.youtube.com/watch?v=dQw4w9WgXcQ , https://www.youtube.com/@mkbhd , https://www.youtube.com/playlist?list=PL5vtqDuUM1DmwLtG9CxJfOxL5A_r6H5s6 , https://youtu.be/dQw4w9WgXcQ", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Or find videos by keyword, e.g. iphone review, tomato soup recipe, react tutorial. Each term returns the top matching videos.", "items": { "type": "string" } }, "includeTranscript": { "title": "Include transcript", "type": "boolean", "description": "Pull the full spoken transcript (captions) for every video, as one text field plus the video's caption language. On by default. Turn off for a faster, metadata-only run.", "default": true }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Also pull top-level comments for every video (author, text, likes, date). Slower and adds nested comment data to each row, so it is off by default.", "default": false }, "transcriptLanguage": { "title": "Preferred transcript language", "type": "string", "description": "Optional. If a video has captions in several languages, prefer this one, e.g. English, Spanish, Hebrew. Leave blank to use the video's default caption track." }, "maxVideosPerSource": { "title": "Max videos per channel / playlist / search", "minimum": 1, "type": "integer", "description": "For each channel, playlist or search term, how many of its most recent videos to take. Default 50. Does not apply to single video URLs (those always return the one video).", "default": 50 }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "type": "integer", "description": "When comments are on, how many top comments to keep per video. Default 50.", "default": 50 }, "maxItems": { "title": "Max videos in total", "minimum": 1, "type": "integer", "description": "Optional overall cap on how many videos the whole run returns. Leave blank for everything your inputs point to." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Transcripts are fetched through a residential proxy (YouTube blocks caption downloads from datacenter IPs), so residential is the default. You can switch it off for a faster, metadata-only run without transcripts.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }