{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper: Videos, Shorts, Channels, Playlists", "description": "Scrape YouTube search results by keyword: one row per video, Short, channel or playlist with views, upload date, duration, channel, thumbnail, description snippet and badges (live, 4K, CC). Filter by type, upload date, duration, features, country and language. Batch keywords. No login, no API key.", "version": "0.1", "x-build-id": "nHjdolnecEcwvkv9D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-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/themineworks~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-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", "properties": { "searchQueries": { "title": "Keywords", "type": "array", "description": "What you would type in the YouTube search box, one keyword per line. Each keyword is one search. You can also paste a youtube.com/results link copied from your browser: its own filters are used for that line. Up to 500 keywords per run.", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The most rows to return for each keyword, 1 to 1,000. YouTube serves about 20 results a page and a video search usually ends near 380 results.", "default": 50 }, "type": { "title": "Result type", "enum": [ "video", "shorts", "channel", "playlist", "all" ], "type": "string", "description": "Videos (Shorts that YouTube lists among the videos are included and marked is_short), Shorts only, channels, playlists, or everything YouTube shows on its All tab.", "default": "video" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only results uploaded inside this window. Rows are also checked against the window, so results YouTube lets through from outside it are dropped and never charged.", "default": "any" }, "duration": { "title": "Duration", "enum": [ "any", "under3", "3to20", "over20" ], "type": "string", "description": "Video length, as YouTube's own duration filter.", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "popularity", "date" ], "type": "string", "description": "Relevance and Popularity (most viewed first) are YouTube's own orders. Newest first: YouTube no longer sorts search by upload date, so the actor reads every page YouTube serves for the keyword and returns the newest results first, by the upload age shown on each video. Pair it with an upload date filter for a complete list of recent uploads.", "default": "relevance" }, "features": { "title": "Features", "uniqueItems": true, "type": "array", "description": "YouTube's feature filters. Several together must all match.", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creative_commons", "360", "vr180", "3d", "hdr", "location" ], "enumTitles": [ "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location" ] }, "default": [] }, "country": { "title": "Country", "type": "string", "description": "Two letter country code YouTube ranks the results for, for example US, GB, IN, DE or BR.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "YouTube interface language, for example en, es, de, pt, hi or ja. It changes the ranking (results in that language come first) and the language of the upload date and view texts. Estimated upload dates are worked out for about 20 major languages.", "default": "en" }, "excludeShorts": { "title": "Leave out Shorts", "type": "boolean", "description": "On: Shorts that YouTube mixes into video results are dropped and not charged, so you get long form videos only.", "default": false }, "deduplicate": { "title": "Return each result once per run", "type": "boolean", "description": "On: a video, channel or playlist that two of your keywords find is delivered and charged once, under the first keyword. Off: it is returned for every keyword that finds it, with its rank in each, which suits rank tracking.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is used by default and is included in the price. Change it only if you know you need to.", "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 } } } } } } } } } }