{ "openapi": "3.0.1", "info": { "title": "Youtube Metadata Scraper", "description": "YouTube Metadata Scraper extracts detailed data from any YouTube video or channel. Collect titles, tags, thumbnails, descriptions, stats, and metadata fast. Ideal for research, SEO analysis, trend tracking, and workflows requiring structured YouTube data.", "version": "0.1", "x-build-id": "RaywAsuGdIU2r3p1R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~youtube-metadata-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-youtube-metadata-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/api-empire~youtube-metadata-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-youtube-metadata-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/api-empire~youtube-metadata-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-youtube-metadata-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": { "urls": { "title": "Video URLs or IDs", "type": "array", "description": "Provide YouTube video URLs or IDs. You can mix URLs and plain keywords; each entry is one target.", "items": { "type": "string" } }, "keywords": { "title": "Search Keywords", "type": "array", "description": "Search YouTube by keyword(s). Results can be sorted and paged.", "items": { "type": "string" } }, "sort_order": { "title": "Sort / Filter by", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "type": "string", "description": "Sort keyword search results: relevance, upload date, view count, or rating.", "default": "relevance" }, "max_results_per_keyword": { "title": "Max Videos per Keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of videos to fetch per keyword (with paging).", "default": 10 }, "max_comments": { "title": "Maximum Comments", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of top-level comments to retrieve per video.", "default": 20 }, "include_transcripts": { "title": "Include Transcripts", "type": "boolean", "description": "Toggle to download closed captions and transcripts when available.", "default": true }, "transcript_format": { "title": "Transcript Format", "enum": [ "text", "timestamps" ], "type": "string", "description": "Choose whether transcripts are returned as plain text or with timestamps.", "default": "text" }, "include_english_auto": { "title": "Include English Auto-generated", "type": "boolean", "description": "Enable to include YouTube's auto-generated English captions.", "default": false }, "include_non_english": { "title": "Include Non-English", "type": "boolean", "description": "Enable to include transcripts in non-English languages.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure Apify proxies. Leave as default to start without a proxy and allow automatic fallback management.", "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 } } }, "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 } } } } } } } } } }