{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper & API: Videos, Channels, Playlists", "description": "Scrape YouTube search results for any keyword: videos, Shorts, channels and playlists with every YouTube filter, newest first (YouTube dropped that sort), without Shorts on request, by country. Exact views, dates, channels. A YouTube Data API alternative without quota or key.", "version": "0.1", "x-build-id": "JjumZUgqVkCE8NVEb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-youtube-search-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/s_actors~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-s_actors-youtube-search-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/s_actors~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-s_actors-youtube-search-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", "required": [ "searchQueries" ], "properties": { "searchQueries": { "title": "🔍 Search queries", "type": "array", "description": "Keywords to search on YouTube, one per line, exactly as you would type them.", "items": { "type": "string" } }, "resultType": { "title": "🎞️ Result type", "enum": [ "videos", "shorts", "channels", "playlists", "all" ], "type": "string", "description": "What to search for, like the Type filter on YouTube.", "default": "videos" }, "maxResults": { "title": "🔢 Max results per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many results to return per query. YouTube lists up to about 500-700 for a query.", "default": 50 }, "sortBy": { "title": "↕️ Sort by", "enum": [ "relevance", "popular", "newest" ], "type": "string", "description": "YouTube removed sorting by upload date. Newest first reads three times more results (videos and Shorts) and sorts them by upload time; combine it with Upload date for the latest uploads.", "default": "relevance" }, "uploadDate": { "title": "📅 Upload date", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded in this period. Older videos that YouTube mixes in are removed.", "default": "any" }, "duration": { "title": "⏱️ Duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Video length, as the YouTube filter.", "default": "any" }, "features": { "title": "✨ Features", "type": "array", "description": "Only videos with all of these features, as the YouTube filters.", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creativeCommons", "360", "vr180", "3d", "hdr", "location", "purchased" ], "enumTitles": [ "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location", "Purchased" ] } }, "excludeShorts": { "title": "🚫 Exclude Shorts", "type": "boolean", "description": "Drop Shorts from video results: only regular videos. Skipped Shorts are free.", "default": false }, "minViews": { "title": "👀 Minimum views", "minimum": 0, "type": "integer", "description": "Only videos with at least this many views. Skipped videos are free." }, "country": { "title": "🌍 Country", "type": "string", "description": "Two-letter country the search runs from (us, gb, de, in, br...): results differ by country.", "default": "us" }, "videoDetails": { "title": "🔎 Exact video details", "type": "boolean", "description": "Open every video for likes, comment count, exact publish date, full description and channel subscribers. Slower, same price.", "default": false }, "onlyNew": { "title": "🔔 Only new results", "type": "boolean", "description": "For scheduled runs. The first run returns the results and remembers the top 100; later runs return only videos that were not there before and were published since the previous run. Best with Upload date: This week.", "default": false }, "monitorName": { "title": "🏷️ Monitor name", "type": "string", "description": "Name of the memory used by Only new results. Use a different name for each task.", "default": "default" }, "maxConcurrency": { "title": "⚡ Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many requests to YouTube run at the same time.", "default": 10 }, "proxyConfiguration": { "title": "🛡️ Proxy", "type": "object", "description": "Requests go direct first and switch to Apify datacenter proxies when YouTube refuses them. The default works for most runs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }