{ "openapi": "3.0.1", "info": { "title": "YouTube Search API — Videos, Channels & Playlists", "description": "Scrape YouTube search results by keyword. Extract videos, channels, playlists, Shorts shelves, views and thumbnails. Filters, country/language settings and pagination. Pay per successful request, not result.", "version": "1.0", "x-build-id": "oN7pCmN4uJg6y9aZv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gauravlabs~youtube-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gauravlabs-youtube-search-api", "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/gauravlabs~youtube-search-api/runs": { "post": { "operationId": "runs-sync-gauravlabs-youtube-search-api", "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/gauravlabs~youtube-search-api/run-sync": { "post": { "operationId": "run-sync-gauravlabs-youtube-search-api", "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", "required": [ "queries" ], "properties": { "queries": { "title": "Search keywords", "type": "array", "description": "Keyword searches, not video or channel URLs. Duplicate keywords are skipped.", "items": { "type": "string" } }, "searchPreset": { "title": "Search type or filter", "enum": [ "all", "videos", "channels", "playlists", "rating", "newest", "views", "short", "medium", "long", "4k", "hd", "live", "captions", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Choose one preset. Presets cannot be combined. Advanced combinations require a valid sp token.", "default": "all" }, "num": { "title": "Compact mode: video count (optional)", "minimum": 1, "maximum": 30, "type": "integer", "description": "1–30 videos in one request. Omit for standard metadata and mixed results. Cannot combine with filters, sp, or multiple pages. Counts can be rounded; snippets and pagination are unavailable." }, "maxPagesPerQuery": { "title": "Maximum pages per keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Each successful page is one billable request. Requires standard mode (omit num). Stops when no continuation is available.", "default": 1 }, "maxRequests": { "title": "Maximum requests per run", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global cap across all keywords and pages, including failed attempts. Not a lifetime account quota.", "default": 10 }, "hl": { "title": "Language code", "type": "string", "description": "Example en, de, fr, es, hi. Controls localized metadata text.", "default": "en" }, "gl": { "title": "Country code", "type": "string", "description": "Two-letter lowercase code, e.g. us, gb, in, de. Influences ranking.", "default": "us" }, "device": { "title": "Device layout", "enum": [ "desktop", "mobile" ], "type": "string", "description": "YouTube desktop or mobile search layout.", "default": "desktop" }, "includeShorts": { "title": "Include available Shorts shelves", "type": "boolean", "description": "Best-effort standard-mode shelves, not a dedicated Shorts search.", "default": true }, "includeDiscovery": { "title": "Include recommendation shelves", "type": "boolean", "description": "Include recommendation shelves when supplied.", "default": true }, "includeAds": { "title": "Include available ads", "type": "boolean", "description": "Include promoted search entries when supplied.", "default": false }, "sp": { "title": "Advanced filter or continuation token", "type": "string", "description": "Optional opaque YouTube token. Requires one keyword and Mixed results preset. Cannot combine with num. Use nextPageToken from SUMMARY to resume." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "No automatic Actor retries; failed requests are not charged by this Actor.", "default": 90 } } }, "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 } } } } } } } } } }