{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper Pro: Search, Channels, Videos & Shorts", "description": "Scrape YouTube search results, channels, playlists and videos: views, likes, comment count, subscribers, description, tags, duration, exact publish date. Shorts included. Filters by date, views, duration. No API key. From $1 per 1,000 videos.", "version": "0.0", "x-build-id": "RcEaJmVtGiIY5xTDU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muarafa~youtube-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muarafa-youtube-scraper-pro", "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/muarafa~youtube-scraper-pro/runs": { "post": { "operationId": "runs-sync-muarafa-youtube-scraper-pro", "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/muarafa~youtube-scraper-pro/run-sync": { "post": { "operationId": "run-sync-muarafa-youtube-scraper-pro", "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 terms", "type": "array", "description": "What you would type into the YouTube search box. One search per line.", "items": { "type": "string" } }, "startUrls": { "title": "YouTube URLs", "type": "array", "description": "Video, Shorts, channel (@handle, /channel/, /c/, /user/) or playlist URLs. Channels return their latest videos.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max videos per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many videos to return for each search term.", "default": 50 }, "maxVideosPerChannel": { "title": "Max videos per channel / playlist", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Newest first. For channels the limit applies to long videos and Shorts separately.", "default": 50 }, "includeDetails": { "title": "Full video details", "type": "boolean", "description": "Adds likes, comment count, channel subscribers, full description, tags and exact publish date (+$0.0005 per video). Turn off for the cheapest, fastest lists.", "default": true }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Include YouTube Shorts in channel and search results.", "default": true }, "sortBy": { "title": "Search: sort by", "enum": [ "relevance", "date", "views", "rating" ], "type": "string", "description": "Order of search results (search terms only).", "default": "relevance" }, "uploadDate": { "title": "Search: upload date", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded within this period (search terms only).", "default": "any" }, "duration": { "title": "Search: duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Only videos of this length (search terms only).", "default": "any" }, "features": { "title": "Search: features", "type": "array", "description": "Only videos with these features.", "items": { "type": "string", "enum": [ "hd", "4k", "subtitles", "creative_commons", "live" ], "enumTitles": [ "HD", "4K", "Subtitles/CC", "Creative Commons", "Live" ] }, "default": [] }, "language": { "title": "Interface language (optional)", "type": "string", "description": "Language code for YouTube's texts, e.g. en, ar, es. Default: en." }, "maxTotalItems": { "title": "Max total videos", "minimum": 1, "type": "integer", "description": "Hard limit for the whole run. Also set Maximum cost per run in the run options to cap spend.", "default": 1000 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos are processed in parallel.", "default": 5 }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times a failed request is retried with a new session before giving up.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended. The scraper switches to residential IPs automatically if YouTube starts blocking.", "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 } } } } } } } } } }