{ "openapi": "3.0.1", "info": { "title": "YouTube Metadata Scraper", "description": null, "version": "0.1", "x-build-id": "x5fejyInOjTVY5asz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperforge~youtube-metadata-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperforge-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/scraperforge~youtube-metadata-scraper/runs": { "post": { "operationId": "runs-sync-scraperforge-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/scraperforge~youtube-metadata-scraper/run-sync": { "post": { "operationId": "run-sync-scraperforge-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": "One entry per video: full watch links (`youtube.com` / `youtu.be`) or the raw **video ID**. Leave empty if you only want keyword-based discovery.", "items": { "type": "string" } }, "keywords": { "title": "๐Ÿ” Search keywords", "type": "array", "description": "YouTube search phrases โ€” one phrase per line. **Sort** and **Max videos per keyword** in this same panel control ranking and how many videos are collected per phrase.", "items": { "type": "string" } }, "sort_order": { "title": "๐Ÿ“Š Sort keyword results by", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "type": "string", "description": "Applies to **keyword** runs only. Choose how YouTube should order the search results before videos are added to your run.", "default": "relevance" }, "max_results_per_keyword": { "title": "๐Ÿ”ข Max videos per keyword", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety cap for discovery: at most this many videos are taken **per keyword** (YouTube paging under the hood). Lower = faster & lighter; higher = broader coverage.", "default": 10 }, "max_comments": { "title": "๐Ÿ’ฌ Max comments per video", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Top-level comments to store for each video. Set **0** to skip comments entirely and focus on metadata (and transcripts, if enabled).", "default": 2 }, "include_transcripts": { "title": "๐Ÿ“ฅ Include transcripts", "type": "boolean", "description": "When on, the Actor tries to attach caption/transcript text for each video **if YouTube makes it available** for that upload.", "default": true }, "transcript_format": { "title": "๐Ÿงพ Transcript format", "enum": [ "text", "timestamps" ], "type": "string", "description": "Choose a compact paragraph-style transcript or structured segments โ€” whichever fits your downstream tooling best.", "default": "text" }, "include_english_auto": { "title": "๐Ÿค– Include auto-generated English", "type": "boolean", "description": "Also allow **YouTube auto-captions** in English (in addition to creator-uploaded captions, when present).", "default": false }, "include_non_english": { "title": "๐ŸŒ Include non-English captions", "type": "boolean", "description": "When enabled, non-English manual or auto tracks can appear in the transcript list (subject to availability on each video).", "default": false }, "proxyConfiguration": { "title": "๐Ÿ”’ Proxy configuration", "type": "object", "description": "Optional Apify **Proxy** settings for tougher networks or higher-volume runs. Leave off for the default experience; adjust only if your workspace policy or success rate calls for it.", "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 } } } } } } } } } }