{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper Pro", "description": "All-in-one YouTube scraper: search with filters, channel videos, Shorts, live streams, playlists and video details — with subtitle support.", "version": "0.1", "x-build-id": "DBgv0oywl59mW9LaA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/grow_media~youtube-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-grow_media-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/grow_media~youtube-scraper-pro/runs": { "post": { "operationId": "runs-sync-grow_media-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/grow_media~youtube-scraper-pro/run-sync": { "post": { "operationId": "run-sync-grow_media-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 Queries", "type": "array", "description": "Search terms, just like you would enter them in the YouTube search bar.", "items": { "type": "string" } }, "youtubeHandles": { "title": "YouTube Handles", "type": "array", "description": "Channel handles (with or without @) to scrape videos from, e.g. @MrBeast, mkbhd. Full handle URLs are also accepted, e.g. https://www.youtube.com/@MrBeast.", "items": { "type": "string" } }, "channelIds": { "title": "Channel IDs", "type": "array", "description": "Channel IDs (e.g. UCX6OQ3DkcsbYNE6H8uQQuVA) or full channel URLs (e.g. https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA).", "items": { "type": "string" } }, "maxResults": { "title": "Max Videos per Channel/Search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of regular videos to scrape per channel or search query (1-1000).", "default": 50 }, "maxResultsShorts": { "title": "Max Shorts per Channel", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of Shorts to scrape per channel (0-1000). Set 0 to skip Shorts.", "default": 0 }, "maxResultStreams": { "title": "Max Live Streams per Channel", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of live streams to scrape per channel (0-1000). Set 0 to skip live streams.", "default": 0 }, "maxItems": { "title": "Max Total Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on the total number of results pushed to the dataset across all sources. Leave empty for no global cap." }, "uploadDate": { "title": "Upload Date (search)", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Upload date filter for search queries only.", "default": "any" }, "duration": { "title": "Duration (search)", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Video duration filter for search queries only.", "default": "any" }, "features": { "title": "Features (search)", "enum": [ "any", "4k", "hd", "live", "movie", "cc", "3d", "hdr", "location", "purchased", "subtitles", "vr180", "vr360" ], "type": "string", "description": "Video feature filter for search queries only.", "default": "any" }, "sort": { "title": "Sort By (search)", "enum": [ "relevance", "date", "viewCount", "rating", "title", "videoCount" ], "type": "string", "description": "Sorting order for search queries only.", "default": "relevance" }, "gl": { "title": "Geolocation (search)", "type": "string", "description": "Region for search results, ISO 3166-1 alpha-2 country code (e.g. US, DE, IN).", "default": "us" }, "hl": { "title": "Language (search)", "type": "string", "description": "Language for search results, ISO 639-1 two-letter code (e.g. en, es, fr).", "default": "en" }, "sortVideosBy": { "title": "Sort Channel Videos By", "enum": [ "NEWEST", "POPULAR", "OLDEST" ], "type": "string", "description": "Maps to the sorting buttons on the channel's Videos, Shorts and Live pages.", "default": "NEWEST" }, "oldestPostDate": { "title": "Oldest Post Date (channel)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Only videos uploaded after or on this date (YYYY-MM-DD) will be scraped. The channel is scanned newest-first up to this date boundary, then results are ordered according to Sort Channel Videos By." }, "fetchVideoDetails": { "title": "Fetch Video Details", "type": "boolean", "description": "Enrich every video with full metadata (likes, comments, description, tags, channel stats) via batched Data API requests.", "default": 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 } } } } } } } } } }