{ "openapi": "3.0.1", "info": { "title": "YouTube Video Scraper", "description": "Collect public YouTube videos in a few clicks. Search by keyword, collect a channel, paste YouTube URLs, or get Trending. Results include title, description, channel, views, likes, duration, thumbnail, and publish time.", "version": "1.0", "x-build-id": "rW7zs9LZ3pFdgiB1i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amats-core~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amats-core-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/amats-core~youtube-scraper/runs": { "post": { "operationId": "runs-sync-amats-core-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/amats-core~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-amats-core-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", "required": [ "mode" ], "properties": { "mode": { "title": "What do you want to collect?", "enum": [ "search", "channel", "urls", "trending" ], "type": "string", "description": "Search public videos by keyword, collect a channel, paste YouTube URLs, or get Trending.", "default": "search" }, "keywords": { "title": "Keywords", "type": "array", "description": "Topics to search for. Each keyword is searched in order until the video limit is reached. Used only for “Search by keywords”. Example: coffee, travel.", "items": { "type": "string" } }, "youtubeHandles": { "title": "Channel handles", "type": "array", "description": "Public channel handles, one per line. Used only for “Channel”. Example: @yourchannel", "items": { "type": "string" } }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Used only for “Channel”. Also collect Shorts from the channel.", "default": false }, "startUrls": { "title": "YouTube URLs", "type": "array", "description": "Video, channel, playlist, Shorts, or search result links. Used only for “YouTube URLs”. Search filters apply only if the URL is a search page. Example: https://www.youtube.com/results?search_query=travel", "items": { "type": "string" } }, "maxItems": { "title": "Number of videos", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of videos to collect. For search, this is the total across all keywords.", "default": 20 }, "gl": { "title": "Country", "type": "string", "description": "Two-letter country code such as us, gb, or id. Used in every mode.", "default": "us" }, "hl": { "title": "Language", "type": "string", "description": "Language code such as en, id, or es. Used in every mode.", "default": "en" }, "uploadDate": { "title": "Upload date", "enum": [ "all", "l", "t", "w", "m", "y" ], "type": "string", "description": "Only for “Search by keywords” and search result URLs. Ignored for Channel, Trending, video URLs, playlists, and channel URLs. Leave as Any if you do not want a date filter.", "default": "all" }, "duration": { "title": "Duration", "enum": [ "all", "s", "l" ], "type": "string", "description": "Only for “Search by keywords” and search result URLs. Short is under about 4 minutes. Long is over about 20 minutes. Ignored for Channel, Trending, and other URL types.", "default": "all" }, "features": { "title": "Features", "enum": [ "all", "h", "hd", "s", "c", "3d", "3", "li", "lo", "4" ], "type": "string", "description": "Only for “Search by keywords” and search result URLs. Leave as Any if you do not need a feature filter. Ignored for Channel, Trending, and other URL types.", "default": "all" }, "sort": { "title": "Sort by", "enum": [ "r", "ra", "u", "v" ], "type": "string", "description": "Only for “Search by keywords” and search result URLs. Ignored for Channel, Trending, and other URL types.", "default": "r" } } }, "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 } } } } } } } } } }