{ "openapi": "3.0.1", "info": { "title": "YouTube Search API: Videos, Views & Channels as JSON", "description": "YouTube Search API: search results as JSON for any keyword, with video title, URL, views, channel, duration, upload date and position. Date, length, Shorts and live filters. No API key, no quota. Pay per video plus a small start fee; only-new-videos mode adds a fee per 20 results checked.", "version": "0.1", "x-build-id": "dlFMbx4m8DnXizDVK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plainrows~youtube-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plainrows-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/plainrows~youtube-search-api/runs": { "post": { "operationId": "runs-sync-plainrows-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/plainrows~youtube-search-api/run-sync": { "post": { "operationId": "run-sync-plainrows-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": [ "searchQueries" ], "properties": { "searchQueries": { "title": "Search queries", "minItems": 1, "maxItems": 2000, "type": "array", "description": "What you would type in the YouTube search box, one per line: \"how to make sourdough bread\", \"iphone 17 review\", \"lofi hip hop\". Up to 1,000 queries per run.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max videos per query", "minimum": 1, "maximum": 200, "type": "integer", "description": "YouTube shows up to about 200 videos per search. Each video returned is billed; see Pricing.", "default": 50 }, "country": { "title": "Country", "enum": [ "US", "GB", "CA", "AU", "IE", "IN", "DE", "AT", "CH", "FR", "BE", "ES", "MX", "IT", "NL", "PT", "BR", "PL", "SE", "JP" ], "type": "string", "description": "Country whose YouTube results you want (YouTube ranks videos differently per country).", "default": "US" }, "languageCode": { "title": "Language (optional)", "pattern": "^([a-zA-Z]{2})?$", "type": "string", "description": "Two-letter language code, e.g. \"en\" or \"fr\". Leave empty to use the country's main language (for example German for Switzerland, French for Belgium)." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "popularity" ], "type": "string", "description": "Same as YouTube's \"Prioritize\" filter.", "default": "relevance" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded in this period (YouTube's upload date filter). Useful to monitor new videos for a keyword.", "default": "any" }, "duration": { "title": "Duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "YouTube's duration filter.", "default": "any" }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Turn off to get regular videos only (uses YouTube's \"Videos\" type filter). Shorts removed are not billed.", "default": true }, "includeLive": { "title": "Include live streams", "type": "boolean", "description": "Turn off to skip streams that are live right now. Skipped streams are not billed.", "default": true }, "onlyNewVideos": { "title": "Only new videos (monitoring)", "type": "boolean", "description": "Return only videos this tool has never delivered to you for the same query, country and language. The first run returns every video and remembers them; later runs (for example a daily schedule) return and bill only new videos.", "default": false }, "monitorName": { "title": "Monitor name (optional)", "pattern": "^([a-z0-9][a-z0-9-]{0,61}[a-z0-9]|[a-z0-9])?$", "type": "string", "description": "Name of the key-value store in your Apify account that remembers delivered videos (default \"plainrows-youtube-monitor\"). Use a different name per monitoring task to keep separate histories, or a new name to start over. Lowercase letters, digits and hyphens." } } }, "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 } } } } } } } } } }