{ "openapi": "3.0.1", "info": { "title": "YouTube Search Scraper", "description": "Export YouTube keyword search results: videos, Shorts, channels or playlists. Apply YouTube's filters, language and country. Optional likes, comments and publish day for videos.", "version": "0.1", "x-build-id": "nYL7I9ajJMWYGXsdY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/danthedataman~youtube-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-danthedataman-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/danthedataman~youtube-search-scraper/runs": { "post": { "operationId": "runs-sync-danthedataman-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/danthedataman~youtube-search-scraper/run-sync": { "post": { "operationId": "run-sync-danthedataman-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": "Keywords to search. The form prefill is an example; omitted or empty queries collect no rows.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results per query", "minimum": 0, "type": "integer", "description": "Maximum delivered rows per query. Zero collects no rows. Continuations stop when reached, exhausted, blocked or the collection time budget ends.", "default": 20 }, "resultType": { "title": "Result type", "enum": [ "video", "short", "channel", "playlist" ], "type": "string", "description": "Search for videos, Shorts, channels or playlists.", "default": "video" }, "uploadDate": { "title": "Upload date bucket", "enum": [ "any", "today", "week", "month", "year" ], "type": "string", "description": "YouTube upload-date bucket. Exact calendar bounds are separate inputs.", "default": "any" }, "duration": { "title": "Video duration", "enum": [ "any", "under3", "3to20", "over20" ], "type": "string", "description": "YouTube duration buckets: under 3, 3–20 or over 20 minutes.", "default": "any" }, "features": { "title": "Video features", "type": "array", "description": "Compose YouTube feature filters. These are the source's filter semantics; not every feature is exposed on result rows.", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creativeCommons", "360", "vr180", "3d", "hdr", "location", "purchased" ] }, "default": [] }, "sort": { "title": "Sort", "enum": [ "relevance", "popularity" ], "type": "string", "description": "YouTube relevance or popularity order. There is no newest-first order.", "default": "relevance" }, "hl": { "title": "Language", "type": "string", "description": "YouTube search language code. Enrichment date labels are requested in English so source calendar dates can be parsed.", "default": "en" }, "gl": { "title": "Country", "type": "string", "description": "Two-letter YouTube search country code; for example DE.", "default": "US" }, "details": { "title": "Video details", "type": "boolean", "description": "Read source publication day, likes, comments count, subscribers and full description for videos or Shorts. Adds requests; unsupported source values remain null.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify automatic datacenter selection by default. Buyers may supply their proxy configuration; no account-specific group is required." }, "publishedAfter": { "title": "Published on or after", "type": "string", "description": "Inclusive source calendar date, YYYY-MM-DD. Automatically reads video details and over-fetches candidates until enough matching rows, exhaustion or the time budget." }, "publishedBefore": { "title": "Published on or before", "type": "string", "description": "Inclusive source calendar date, YYYY-MM-DD. No inferred timestamp or relative-age conversion. Videos and Shorts only." } } }, "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 } } } } } } } } } }