{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper", "description": "All-in-one YouTube scraper: search, channels, playlists, video URLs, and transcripts in a single run. Powered by TranscriptAPI.", "version": "0.1", "x-build-id": "waC3GTSrx6gJimqzV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zeropointstudio~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zeropointstudio-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/zeropointstudio~youtube-scraper/runs": { "post": { "operationId": "runs-sync-zeropointstudio-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/zeropointstudio~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-zeropointstudio-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Free-text YouTube searches. Each query is fetched separately and capped by 'maxResults'. Use 'searchType' to pick whether each query returns videos or channels.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste any mix of video URLs (watch, youtu.be, shorts, embed, bare 11-char ID), channel URLs (/channel/UC…, /@handle, /c/…, /user/…), or playlist URLs (?list=PL…). We auto-detect each.", "default": [], "items": { "type": "string" } }, "searchType": { "title": "Search type", "enum": [ "video", "channel" ], "type": "string", "description": "What 'searchQueries' should return. 'video' = video results. 'channel' = channel results.", "default": "video" }, "maxResults": { "title": "Max results (per source)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Per-search-query, per-channel, and per-playlist cap. 20 is a safe default; raise for bulk runs.", "default": 20 }, "downloadSubtitles": { "title": "Download transcripts", "type": "boolean", "description": "When true, fetches a transcript for every video discovered (search, channel, playlist, or direct URL) and merges it onto the same item. Each successful transcript is billed at the 'transcript-fetched' rate.", "default": false }, "subtitlesFormat": { "title": "Transcript format", "enum": [ "json", "text", "srt", "vtt" ], "type": "string", "description": "Output format for transcripts. JSON = list of timed segments. Text = single concatenated string. SRT / VTT = standard subtitle file formats.", "default": "json" }, "includeTimestamps": { "title": "Include timestamps", "type": "boolean", "description": "When 'subtitlesFormat' is 'json' or 'text', include per-segment timestamps. Always on for SRT and VTT.", "default": true }, "subtitlesLanguage": { "title": "Transcript language", "type": "string", "description": "Caption language preference. Most videos return English by default; transcripts come back in the video's primary published caption language.", "default": "en" }, "includeVideoMetadata": { "title": "Include video metadata on transcript items", "type": "boolean", "description": "When fetching transcripts, also include video title, channel, and thumbnail.", "default": true }, "saveSubsToKVS": { "title": "Save transcripts to Key-Value Store", "type": "boolean", "description": "When true, each transcript is also written to the default Key-Value Store as 'transcript-' (raw payload). Useful for piping transcripts to downstream actors or storing them separately from the dataset.", "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 } } } } } } } } } }