{ "openapi": "3.0.1", "info": { "title": "YouTube Search API: Rankings, Views & Transcripts", "description": "Search YouTube by keyword and get ranked videos, Shorts, views, channels and publish dates, plus optional likes, comments count, subscriber count, tags and transcripts for any video. No login, no browser, no proxies to manage.", "version": "0.1", "x-build-id": "ekFWxfgQcOdGeGxgU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steady-scrape~youtube-search-video-stats/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steady-scrape-youtube-search-video-stats", "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/steady-scrape~youtube-search-video-stats/runs": { "post": { "operationId": "runs-sync-steady-scrape-youtube-search-video-stats", "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/steady-scrape~youtube-search-video-stats/run-sync": { "post": { "operationId": "run-sync-steady-scrape-youtube-search-video-stats", "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": "Keywords to search on YouTube, one per line. Each query returns the results in the same order YouTube ranks them. Duplicates are removed; queries over 300 characters are reported for free.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max results per query", "minimum": 1, "maximum": 700, "type": "integer", "description": "How many ranked results to return per query (1-700). You only pay for rows you get.", "default": 20 }, "country": { "title": "Country", "type": "string", "description": "Country to search from, as a 2-letter code (US, GB, DE, IN...) or an English name. Rankings differ by country.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Interface language code, e.g. en, es, de, fr, pt, ja.", "default": "en" }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Keep YouTube Shorts in search results. Each row has isShort so you can filter later.", "default": true }, "includeChannelsAndPlaylists": { "title": "Include channel and playlist results", "type": "boolean", "description": "Also return channel and playlist cards that appear in search results (off = videos and Shorts only).", "default": false }, "videos": { "title": "Video URLs or IDs", "type": "array", "description": "Optional. Look up specific videos directly (watch, youtu.be, Shorts, embed URLs or 11-character IDs). Each returns full video stats.", "items": { "type": "string" } }, "addVideoDetails": { "title": "Add full video stats to search results", "type": "boolean", "description": "Adds likes, comment count, channel subscriber count, tags, category, full description and caption languages to each video in search results. Charged per video enriched.", "default": false }, "addTranscripts": { "title": "Add transcripts", "type": "boolean", "description": "Adds the video transcript (captions) to each video in search results and to each video URL. Charged per transcript found; videos without captions are free.", "default": false }, "transcriptSegments": { "title": "Include timestamped transcript segments", "type": "boolean", "description": "Also return transcript segments with start/end times, not just the plain text.", "default": false }, "transcriptLanguage": { "title": "Translate transcripts to", "type": "string", "description": "Optional language code (e.g. en, es). Leave empty to get the original captions." }, "trackChannels": { "title": "Track my channels (rank check)", "type": "array", "description": "Optional channel URLs, @handles or channel IDs. Rows from these channels get isTrackedChannel = true and the run summary lists each query's best position for them, so you can schedule a daily rank check.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }