{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper", "description": "Scrape YouTube search results, videos, playlists and channels. Views, likes, comment count, description and exact date on every video, with YouTube's search filters. 2 USD per 1,000 videos, no minimum charge per run.", "version": "0.1", "x-build-id": "erJGA4nLmAi0fYyny" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vakitek~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vakitek-youtube-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/vakitek~youtube-scraper/runs": { "post": { "operationId": "runs-sync-vakitek-youtube-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/vakitek~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-vakitek-youtube-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 terms", "type": "array", "description": "Enter search terms just like you would enter them in YouTube's search bar.", "items": { "type": "string" } }, "startUrls": { "title": "Direct URLs", "type": "array", "description": "YouTube video, playlist, channel or search-results-page URLs. Ignored fields from search terms below don't apply to these (a channel URL, for instance, always uses maxResults as its video cap, not maxResultsShorts/maxResultStreams).", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max regular videos per search term / URL", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of regular videos to scrape per search term or URL.", "default": 10 }, "maxResultsShorts": { "title": "Max Shorts per search term", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of Shorts to scrape per search term. Only applies to searchQueries, not startUrls.", "default": 0 }, "maxResultStreams": { "title": "Max streams per search term", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum number of live/past streams to scrape per search term. Only applies to searchQueries, not startUrls. YouTube's search has no dedicated stream filter, so streams are recognized from the same regular-video results (Streamed .../currently-live), not fetched separately.", "default": 0 }, "sortingOrder": { "title": "Sorting order", "enum": [ "relevance", "rating", "date", "views" ], "type": "string", "description": "YouTube sorting parameter for search. Only applies to searchQueries.", "default": "relevance" }, "dateFilter": { "title": "Date filter", "enum": [ "", "hour", "today", "week", "month", "year" ], "type": "string", "description": "YouTube upload date filter for search. Only applies to searchQueries.", "default": "" }, "videoType": { "title": "Video type filter", "enum": [ "", "video", "movie" ], "type": "string", "description": "YouTube video type filter for search. Only applies to searchQueries.", "default": "" }, "lengthFilter": { "title": "Length filter", "enum": [ "", "under4", "between420", "plus20" ], "type": "string", "description": "YouTube video length filter for search. Only applies to searchQueries.", "default": "" }, "maxComments": { "title": "Top comments per video (0 = off)", "minimum": 0, "maximum": 20, "type": "integer", "description": "Number of top comments to add to each video (0 to 20). 0 = off, no extra request. First page of top comments only, replies not included. Free during beta.", "default": 0 }, "language": { "title": "YouTube interface language (titles, dates)", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Interface language (hl) requested from YouTube, as an ISO 639-1 code (e.g. fr, de, ja). Controls which language translated titles/descriptions come back in. It does NOT change the transcript or video content language, only YouTube's own UI strings.", "default": "en" }, "country": { "title": "Country", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Geolocation (gl) requested from YouTube, as an ISO 3166-1 alpha-2 code (e.g. FR, DE, JP).", "default": "US" }, "timeBudgetSecs": { "title": "Time budget (seconds)", "minimum": 0, "maximum": 3600, "type": "integer", "description": "Stop and return what is ready after this many seconds, so n8n/Make run-sync calls never time out. 0 = no limit.", "default": 240 } } }, "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 } } } } } } } } } }