{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper - Videos, Comments & Channels", "description": "Scrape YouTube without an API key: search videos by keyword, get all uploads of a channel, full video details, comments with replies and channel profiles. Numbers are parsed into numeric fields. No login needed.", "version": "1.0", "x-build-id": "fQlCcGioCJFA9sJUw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pipiagent~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pipiagent-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/pipiagent~youtube-scraper/runs": { "post": { "operationId": "runs-sync-pipiagent-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/pipiagent~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-pipiagent-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": { "mode": { "title": "What to scrape", "enum": [ "search", "channelVideos", "videoDetails", "comments", "channelDetails" ], "type": "string", "description": "Choose the kind of data you need. Each mode uses the matching input below.", "default": "search" }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Used in search mode. One keyword or phrase per line, for example \"web scraping\" or \"iphone 17 review\".", "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "Used in video details and comments modes. Accepts watch URLs, youtu.be links, Shorts URLs and 11-character video ids.", "items": { "type": "string" } }, "channelUrls": { "title": "Channels", "type": "array", "description": "Used in channel videos and channel details modes. Accepts channel URLs (youtube.com/@handle, /channel/UC..., /c/name, /user/name), handles like @MrBeast and channel ids.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of results to save in this run.", "default": 100 }, "maxItemsPerQuery": { "title": "Max results per keyword, channel or video", "minimum": 1, "type": "integer", "description": "Optional. Limits results for each keyword, each channel or each video, so that one big source does not use up the whole run." }, "sortBy": { "title": "Sort search results by", "enum": [ "relevance", "date", "views" ], "type": "string", "description": "Used in search mode. With \"Recent videos first\" YouTube returns new videos, but the order is not strictly by date.", "default": "relevance" }, "uploadDate": { "title": "Uploaded", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Used in search mode. Keeps only videos uploaded in this period.", "default": "any" }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Used in channel videos mode. Also saves the Shorts of the channel. YouTube shows only the title and the view count of Shorts in this list.", "default": false }, "includeLive": { "title": "Include live streams", "type": "boolean", "description": "Used in channel videos mode. Also saves past and current live streams of the channel.", "default": false }, "commentSort": { "title": "Sort comments by", "enum": [ "top", "newest" ], "type": "string", "description": "Used in comments mode.", "default": "top" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Used in comments mode. Also saves the replies under each comment. Every reply counts as one result.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The Actor works without a proxy. Turn one on only if runs start failing with blocked requests.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }