{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper", "description": "YouTube Search Scraper API extracts data from any YouTube channel, including video lists, titles, views, likes, upload dates, and metadata. Great for research, competitor analysis, or content tracking. Export structured results in JSON, CSV, or Excel for seamless analysis and reporting.", "version": "0.3", "x-build-id": "uwcIdPbc30NPV2hHG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-youtube-search-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/scraper-engine~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-youtube-search-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/scraper-engine~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-youtube-search-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": { "queries": { "title": "Search queries or URLs", "type": "array", "description": "One search query or URL per line. Examples: 'python programming', 'best cooking channels', https://www.youtube.com/watch?v=... or https://www.youtube.com/@ChannelName. Keywords return search results; a video URL returns that video; a channel URL returns that channel's About data including its external links.", "items": { "type": "string" }, "default": [ "python programming" ] }, "maxResults": { "title": "Max results per query", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum results per search query. COST WARNING: video results are extracted in full (likes, comment counts, tags, full description), which moves roughly 587 KB of proxy traffic PER ROW. 50 results is about 29 MB; 2000 results is about 1.1 GB. The run logs a size projection before it starts. Channel and playlist result types are read from the search page only, at about 2 KB per row.", "default": 5 }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "date", "viewCount", "rating" ], "type": "string", "description": "Result ordering. 'View count' and 'Upload date' are sent to YouTube AND re-sorted here from the real view counts and publish timestamps, so those two are verifiable. 'Rating' is passed through to YouTube only - YouTube exposes no rating figure anywhere in the payload, so it cannot be re-sorted or checked. YouTube blends relevance back into its own sort orders, so ordering is strongest at the top of the set.", "default": "relevance" }, "uploadDate": { "title": "Upload date filter", "enum": [ "", "lastHour", "today", "thisWeek", "thisMonth", "thisYear" ], "type": "string", "description": "Restrict results to videos uploaded within this window. Applied as YouTube's own search filter. Only applies to video results.", "default": "" }, "duration": { "title": "Duration filter", "enum": [ "", "short", "medium", "long" ], "type": "string", "description": "Only include videos in this length band: Short (under 4 min), Medium (4-20 min) or Long (over 20 min). Applied as YouTube's own search filter. Ignored when the result type is Channel or Playlist - the log says so when that happens.", "default": "" }, "type": { "title": "Search type", "enum": [ "video", "channel", "playlist", "movie" ], "type": "string", "description": "What kind of result to return. Channel and Playlist rows use the same columns as video rows, with the video-only fields left empty rather than filled with zeros, and are read from the search page only (about 2 KB per row, no residential proxy needed). Movie is passed to YouTube unchanged but YouTube rarely returns movie rows for general queries.", "default": "video" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Your proxy choice is used first. Note: full per-video extraction is bot-walled on datacenter IPs (measured: 0 rows, 'Sign in to confirm you're not a bot'), so if no proxy is selected - or if the one you select gets blocked - video searches fall back to Apify RESIDENTIAL, which is the only exit that returns rows. The log states which proxy each request used. Channel and playlist searches need no proxy at all." }, "debug": { "title": "Verbose logging", "type": "boolean", "description": "Log every request, retry and proxy switch. Useful for troubleshooting.", "default": 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 } } }, "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 } } } } } } } } } }