{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper: Keyword Video & Shorts Monitor", "description": "Search YouTube by keyword and get the matching videos and Shorts: title, URL, channel, view count, duration in seconds, upload date, live flag and a Shorts flag. Filter by upload date, length or type, and monitor keywords for new videos only. $1 per 1,000 results; failed searches are free.", "version": "1.0", "x-build-id": "4dB8FEJELTP0m4y2T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tenfoldfleet~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tenfoldfleet-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/tenfoldfleet~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-tenfoldfleet-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/tenfoldfleet~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-tenfoldfleet-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 keywords", "type": "array", "description": "What you would type into the YouTube search box, one keyword or phrase per line. Each keyword is searched separately. This actor takes keywords; to scrape a channel, a hashtag or a list of URLs, use our YouTube channel or Shorts scrapers.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max results per keyword", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many results to check for each keyword (videos and Shorts count the same). YouTube usually has several hundred results per keyword. In monitor mode this is how deep each search looks; only new videos among them are returned.", "default": 50 }, "resultType": { "title": "Result type", "enum": [ "all", "videos", "shorts" ], "type": "string", "description": "All results (long videos, live streams and Shorts, each with an isShort flag), long videos only, or Shorts only.", "default": "all" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded within this period (the upload date filter of YouTube search).", "default": "any" }, "duration": { "title": "Video length", "enum": [ "any", "under4", "4to20", "over20" ], "type": "string", "description": "The length filter of YouTube search: under 4 minutes, 4 to 20 minutes, or over 20 minutes.", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "popularity" ], "type": "string", "description": "Relevance (the default YouTube order) or popularity (most viewed first).", "default": "relevance" }, "onlyNewVideos": { "title": "Monitor mode: only new videos", "type": "boolean", "description": "Remember every video ID returned in a named key-value store and, on later runs, return and charge only videos that were not returned before. Schedule the actor daily to get a feed of new uploads for your keywords. The first run returns everything it finds.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Name of the key-value store in your Apify account that holds the seen video IDs. Use a different name per monitor (for example one per client or topic). Lower-case letters, digits and dashes.", "default": "youtube-search-monitor" }, "language": { "title": "Interface language", "type": "string", "description": "YouTube interface language code (hl), for example en, de, es. View counts and dates are parsed best in English.", "default": "en" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code (gl) that YouTube uses to rank results, for example US, GB, IN.", "default": "US" }, "maxItems": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Stop after this many charged results across all keywords. 0 = no limit. The Apify free plan ($5 of monthly credit) covers about 5,000 results a month.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The Apify datacenter proxy (the default) works for YouTube search. Residential proxy is not needed and is replaced with datacenter.", "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 } } } } } } } } } }