{
"openapi": "3.0.1",
"info": {
"title": "YouTube Search Scraper - Results with All Filters",
"description": "Scrape YouTube search results with every filter YouTube offers: videos, Shorts, channels, playlists or movies, upload date, duration, 4K, HD, subtitles, Creative Commons, live and more. Views, duration, channel, publish time. No API key.",
"version": "0.1",
"x-build-id": "51GOUWKR6Hp5GnAF2"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/dataspace~youtube-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-dataspace-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/dataspace~youtube-search-scraper/runs": {
"post": {
"operationId": "runs-sync-dataspace-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/dataspace~youtube-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-dataspace-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": "Search queries",
"type": "array",
"description": "Search YouTube like in the search box, one query per line, e.g. python tutorial, iphone 17 review.",
"items": {
"type": "string"
}
},
"maxResultsPerQuery": {
"title": "Max results per query",
"minimum": 1,
"type": "integer",
"description": "How many results to return for each query. YouTube usually shows up to a few hundred results per search.",
"default": 50
},
"type": {
"title": "Type",
"enum": [
"videos",
"shorts",
"channels",
"playlists",
"movies"
],
"type": "string",
"description": "What to search for — the same as YouTube's 'Type' filter.",
"default": "videos"
},
"sortBy": {
"title": "Prioritize",
"enum": [
"relevance",
"popularity",
"date"
],
"type": "string",
"description": "Relevance (YouTube's default), popularity (most views) or upload date (newest first).",
"default": "relevance"
},
"uploadDate": {
"title": "Upload date",
"enum": [
"any",
"today",
"week",
"month",
"year"
],
"type": "string",
"description": "Only results uploaded in this period.",
"default": "any"
},
"duration": {
"title": "Duration",
"enum": [
"any",
"under3",
"3to20",
"over20"
],
"type": "string",
"description": "Only videos of this length (YouTube's current duration filter).",
"default": "any"
},
"features": {
"title": "Features",
"type": "array",
"description": "Only results with all selected features, e.g. 4K + Subtitles/CC.",
"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"
]
}
},
"includeVideoDetails": {
"title": "Add video details",
"type": "boolean",
"description": "Also get each video's like count, comment count, exact publish date, full description and hashtags. Slower (one extra request per video), same price per result.",
"default": false
},
"country": {
"title": "Country",
"type": "string",
"description": "Two-letter country code to search as a viewer from that country, e.g. US, GB, IN, DE.",
"default": "US"
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "The scraper connects directly first and switches to a new proxy IP only if YouTube slows it down. 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
}
}
}
}
}
}
}
}
}
}