{ "openapi": "3.0.1", "info": { "title": "Youtube Search Scraper", "description": "Automate YouTube search scraping with this actor. Collect video results for any keyword including titles, URLs, channels, views, thumbnails, and publish dates for marketing research, SEO analysis, and content intelligence.", "version": "0.2", "x-build-id": "jPEwMHICXdEoQWzn2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-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/api-empire~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-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/api-empire~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-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": { "queries": { "title": "๐Ÿ”Ž Search queries", "type": "array", "description": "๐Ÿ“ One search query or URL per line. Examples: ยซ python programming ยป, ยซ best cooking channels ยป, or a full URL like https://www.youtube.com/watch?v=... or https://www.youtube.com/@ChannelName. Mix keywords and URLs in the same run.", "items": { "type": "string" }, "default": [ "python programming" ] }, "maxResults": { "title": "๐Ÿ“Š Max results per query", "minimum": 1, "maximum": 2000, "type": "integer", "description": "๐Ÿ“ˆ Maximum number of results to fetch for each query (1โ€“2000). Higher values mean more data but longer runs. Default 10 is good for quick tests.", "default": 10 }, "sortBy": { "title": "โ†•๏ธ Sort by", "enum": [ "relevance", "date", "viewCount", "rating" ], "type": "string", "description": "๐Ÿ”€ How YouTube results are ordered: by relevance, upload date, view count, or rating. Same options youโ€™d see on YouTubeโ€™s sort dropdown.", "default": "relevance" }, "uploadDate": { "title": "๐Ÿ“… Upload date filter", "enum": [ "", "lastHour", "today", "thisWeek", "thisMonth", "thisYear" ], "type": "string", "description": "๐Ÿ“† Restrict results to videos uploaded in this time window: last hour, today, this week, month, or year. Leave ยซ None ยป for no date filter.", "default": "" }, "duration": { "title": "โฑ๏ธ Duration filter", "enum": [ "", "short", "medium", "long" ], "type": "string", "description": "โฑ๏ธ Only include videos in this length range: Short (<4 min), Medium (4โ€“20 min), or Long (>20 min). Leave ยซ None ยป to allow any duration.", "default": "" }, "type": { "title": "๐Ÿ“บ Search type", "enum": [ "video", "channel", "playlist", "movie" ], "type": "string", "description": "๐ŸŽฌ Type of results to return: Video, Channel, Playlist, or Movie. Use ยซ Video ยป for standard search results.", "default": "video" }, "proxyConfiguration": { "title": "๐ŸŒ Proxy (optional)", "type": "object", "description": "๐ŸŒ No proxy by default. If YouTube blocks the run, the actor automatically switches to RESIDENTIAL proxy. You can also set a custom proxy here (e.g. Apify proxy) if you prefer." }, "debug": { "title": "๐Ÿ› Verbose logging", "type": "boolean", "description": "๐Ÿ› Turn on for extra log output (requests, retries, proxy switches). Useful for troubleshooting; leave off for normal runs.", "default": false } } }, "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 } } }, "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 } } } } } } } } } }