{ "openapi": "3.0.1", "info": { "title": "Youtube Scraper", "description": "YouTube Scraper extracts bulk public data beyond official API limits. Grab video metadata, view counts, comments, and live like counters from channels, playlists, streams, and search results. Export to JSON, CSV, or Excel via API endpoints, webhooks, or our Python & Node.js SDKs.", "version": "0.0", "x-build-id": "o7tIcidSTCyiphjG2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lisbuenas~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lisbuenas-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/lisbuenas~youtube-scraper/runs": { "post": { "operationId": "runs-sync-lisbuenas-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/lisbuenas~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-lisbuenas-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": "Direct URLs of YouTube videos, channels, playlists or search result pages. You can mix all types.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search terms", "type": "array", "description": "Keywords, exactly as you would type them into the YouTube search bar.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum number of videos", "minimum": 0, "type": "integer", "description": "How many regular videos to scrape per URL or search term. Set 0 to exclude regular videos from search results.", "default": 10 }, "maxResultsShorts": { "title": "Maximum number of Shorts", "minimum": 0, "type": "integer", "description": "How many Shorts to scrape per search term (search terms only). Set 0 to exclude Shorts.", "default": 10 }, "maxResultStreams": { "title": "Maximum number of streams", "minimum": 0, "type": "integer", "description": "How many live streams to scrape per search term (search terms only). Set 0 to exclude streams.", "default": 10 }, "sortingOrder": { "title": "Sorting order", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "type": "string", "description": "How YouTube should sort the search results.", "default": "relevance" }, "dateFilter": { "title": "Date filter", "enum": [ "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only return videos published within the selected period." }, "oldestPostDate": { "title": "Date range (applicable only to scraping by channels URL)", "type": "string", "description": "Only keep videos published after this date. Accepts an absolute date (e.g. \"2024-01-31\") or a relative period (e.g. \"2 weeks\", \"3 months\")." }, "sortVideosBy": { "title": "Sort channel videos by", "enum": [ "NEWEST", "POPULAR", "OLDEST" ], "type": "string", "description": "Order used on the channel Videos tab before collecting.", "default": "NEWEST" }, "downloadSubtitles": { "title": "Download subtitles", "type": "boolean", "description": "If enabled, every collected video is opened in detail and its subtitles are attached to the output item.", "default": false }, "saveSubsToKVS": { "title": "Save subtitles to key-value store", "type": "boolean", "description": "Also persist each downloaded subtitle file to the run's key-value store (for later use in other Actors or automations).", "default": false }, "subtitlesLanguage": { "title": "Subtitles language", "enum": [ "any", "en", "es", "pt", "fr", "de", "it", "ja", "ko", "ru", "hi", "ar" ], "type": "string", "description": "Preferred subtitles language. \"Any\" picks the first available track.", "default": "any" }, "subtitlesFormat": { "title": "Subtitles format", "enum": [ "srt", "vtt", "xml", "plaintext" ], "type": "string", "description": "Format of the downloaded subtitles.", "default": "srt" }, "preferAutoGeneratedSubtitles": { "title": "Prefer auto-generated subtitles", "type": "boolean", "description": "Pick the auto-generated track even when a user-created one exists.", "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 } } } } } } } } } }