{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper", "description": "Videos and Shorts from any YouTube search, with YouTube's own filters, no login and no duplicates. Optional exact views, likes and publish dates.", "version": "0.1", "x-build-id": "h28nppWPxedMoOIRe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sedgelabs~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sedgelabs-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/sedgelabs~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-sedgelabs-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/sedgelabs~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-sedgelabs-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": [ "queries" ], "properties": { "queries": { "title": "Search terms", "type": "array", "description": "One search per line, as you would type it on YouTube.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max results per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop after this many unique videos and Shorts per search. One YouTube search ends after about 300 unique results, so higher numbers may not be reached.", "default": 50 }, "type": { "title": "Type", "enum": [ "all", "videos", "shorts" ], "type": "string", "description": "What YouTube's own type filter allows.", "default": "all" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "today", "this_week", "this_month", "this_year" ], "type": "string", "description": "YouTube's upload-date filter. With Shorts only, YouTube itself returns nothing for This week and This month.", "default": "any" }, "duration": { "title": "Length", "enum": [ "any", "under_3", "3_to_20", "over_20" ], "type": "string", "description": "YouTube's length filter. Not for Shorts only.", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "popularity" ], "type": "string", "description": "YouTube's sort. Not for Shorts only.", "default": "relevance" }, "includeDetails": { "title": "Exact details", "type": "boolean", "description": "Also fetch each video's exact views, likes, publish date, full description, keywords and category. One extra request per result, charged as a separate small event. Off: rows show what the search page shows (views, length, \"3 weeks ago\").", "default": false }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code YouTube ranks results for, like US, GB, IN or DE.", "default": "US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy for the search and channel pages. Apify's datacenter proxy works for these. Exact details always go through Apify residential IPs at no extra proxy cost to you; YouTube refuses them from datacenter IPs.", "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 } } } } } } } } } }