{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper — Shorts, Videos & Search", "description": "Shorts, channel videos and search results from YouTube — videoId, title, view count, publish date, duration, thumbnail — paginated through InnerTube, cached and paced.", "version": "0.1", "x-build-id": "UkfUXsSWJeL9a3TLm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leonguyen2808~youtube-shorts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leonguyen2808-youtube-shorts-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/leonguyen2808~youtube-shorts-scraper/runs": { "post": { "operationId": "runs-sync-leonguyen2808-youtube-shorts-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/leonguyen2808~youtube-shorts-scraper/run-sync": { "post": { "operationId": "run-sync-leonguyen2808-youtube-shorts-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": { "channels": { "title": "Channels", "type": "array", "description": "One per line. Accepts a handle (@MrBeast), a bare name (MrBeast), a channel id (UCX6OQ3DkcsbYNE6H8uQQuVA) or a full channel URL — any /shorts or /videos suffix is replaced by the tab you pick below.", "items": { "type": "string" } }, "channelTabs": { "title": "Which channel tab(s) to scrape", "type": "array", "description": "Applies to every entry in Channels. `shorts` = the Shorts tab (48 rows/request). `videos` = the regular videos tab (30 rows/request, and each row carries a publish date). Pick both to get both, billed per row either way.", "items": { "type": "string", "enum": [ "shorts", "videos" ], "enumTitles": [ "Shorts tab", "Videos tab" ] }, "default": [ "shorts" ] }, "searchQueries": { "title": "Search queries (optional)", "type": "array", "description": "One per line. Returns YouTube search results newest-relevance-first — these rows additionally carry `channelName`, `durationText` and a description snippet, which channel listings do not. Can be used instead of, or alongside, Channels.", "default": [], "items": { "type": "string" } }, "maxShortsPerChannel": { "title": "Max rows per listing", "minimum": 1, "type": "integer", "description": "Per channel-tab and per search query. YouTube returns 48 rows/request for Shorts and ~20-30 for videos and search, so this rounds up to whole pages. Pagination stops early when the listing runs out — it never wastes requests padding to your number.", "default": 96 }, "oneItemPerShort": { "title": "One dataset row per video", "type": "boolean", "description": "On (default): one row per video with the channel or query repeated — ready for a spreadsheet or a database with no join. Off: one row per listing with a nested array.", "default": true }, "cacheMaxAgeMinutes": { "title": "Accept cached results up to (minutes)", "minimum": 0, "type": "integer", "description": "A channel's listing changes a few times a week, not a few times a minute, so a recent cached answer is the same answer — and serving it costs YouTube nothing, which is why this Actor rarely gets throttled. Set 0 to force a live fetch.", "default": 180 }, "useApifyProxy": { "title": "Use Apify Proxy (recommended)", "type": "boolean", "description": "Recommended. YouTube does not answer overload with a clean error — it serves a consent or challenge page that still returns HTTP 200. Rotating IPs avoids reaching that point.", "default": true }, "apifyProxyGroups": { "title": "Proxy groups", "type": "array", "description": "Leave empty for datacenter proxies (cheapest, and sufficient in testing). Use RESIDENTIAL only if datacenter IPs start getting consent pages.", "default": [], "items": { "type": "string" } }, "apifyProxyCountry": { "title": "Proxy country", "type": "string", "description": "Optional two-letter code. Affects which regional YouTube edge answers; leave empty unless you need a specific country's results.", "default": "" }, "minRequestGapSeconds": { "title": "Minimum gap between requests (seconds)", "type": "string", "description": "Default 1.0s. Lower it only with your own proxy pool.", "default": "1.0" } } }, "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 } } } } } } } } } }