{ "openapi": "3.0.1", "info": { "title": "YouTube Shorts Scraper - Views, Channels, Hashtags & Transcript", "description": "Scrape YouTube Shorts from channels, hashtags, keyword searches or URLs: exact views, likes, comment count, publish date and time, duration, hashtags, sound, tagged products, channel subscribers and transcript. Monitor mode returns only new Shorts or count changes.", "version": "0.1", "x-build-id": "W55ua0Dfywchmhz5D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~youtube-shorts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-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/topapi~youtube-shorts-scraper/runs": { "post": { "operationId": "runs-sync-topapi-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/topapi~youtube-shorts-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-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": "Channels whose Shorts tab to collect: a handle with or without @, a channel URL or a channel id. e.g. \"@MrBeast\", \"nasa\", \"https://www.youtube.com/@mkbhd/shorts\", \"UCX6OQ3DkcsbYNE6H8uQQuVA\".", "items": { "type": "string" } }, "hashtags": { "title": "#️⃣ Hashtags", "type": "array", "description": "Hashtags whose Shorts feed to collect, with or without #. e.g. \"cooking\", \"#asmr\", \"https://www.youtube.com/hashtag/fitness/shorts\". One word per hashtag.", "items": { "type": "string" } }, "searchQueries": { "title": "🔎 Search keywords", "type": "array", "description": "Keywords to search on YouTube with the Shorts filter on. e.g. \"kitchen hacks\", \"iphone 17 review\". Only Shorts are returned.", "items": { "type": "string" } }, "shortUrls": { "title": "🔗 Short URLs or ids", "type": "array", "description": "Individual Shorts: /shorts/ links, youtu.be links, watch?v= links or bare 11-character ids. e.g. \"https://www.youtube.com/shorts/CEJXqm2eiJ0\", \"CEJXqm2eiJ0\".", "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "default", "latest", "popular", "oldest" ], "type": "string", "description": "Order in which Shorts are collected. Channels support all three; searches support newest and most viewed; hashtag feeds always use YouTube's own order.", "default": "default" }, "postedAfter": { "title": "📅 Posted after", "type": "string", "description": "Only Shorts published on or after this date: an ISO date or a relative window. e.g. \"2026-09-01\", \"7 days\", \"24 hours\". Newest-first feeds stop paging once they pass it." }, "postedBefore": { "title": "📅 Posted before", "type": "string", "description": "Only Shorts published on or before this date. e.g. \"2026-09-30\", \"1 day\". Leave empty for no upper limit." }, "minViews": { "title": "Minimum views", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Drop Shorts with fewer views (exact count). e.g. 100000. 0 = no minimum." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Drop Shorts with fewer likes (exact count). Shorts whose creator hides likes are dropped when this is set. 0 = no minimum." }, "titleKeywords": { "title": "Title must contain", "type": "array", "description": "Keep only Shorts whose title or hashtags contain at least one of these words (case-insensitive). e.g. \"recipe\", \"#tutorial\". Empty = keep all.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude words", "type": "array", "description": "Drop Shorts whose title or description contains any of these words. e.g. \"giveaway\", \"#ad\".", "items": { "type": "string" } }, "includeTranscript": { "title": "Add transcript", "type": "boolean", "description": "Add the spoken text from YouTube's own caption track (creator or auto-generated) with timestamps. Charged as the transcript add-on only on Shorts that have one.", "default": false }, "includeChannelDetails": { "title": "Add channel details", "type": "boolean", "description": "Add each creator's subscribers, verified badge, banner, About text, join date, country, lifetime views, video count and links. Free; one lookup per unique channel.", "default": true }, "monitorMode": { "title": "Monitor mode", "enum": [ "off", "new", "newAndChanged" ], "type": "string", "description": "Remember delivered Shorts between runs (pairs with a daily schedule). \"New only\" returns only Shorts not delivered before; \"New + count changes\" also re-delivers known Shorts whose views, likes or comments moved, with deltas.", "default": "off" }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that holds the monitor memory. Use a different name per watch list. e.g. \"shorts-competitors\".", "default": "youtube-shorts-monitor" }, "maxResultsPerSource": { "title": "Max Shorts per source", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap per channel, hashtag or search. A channel's Shorts tab pages through every Short it has; a search runs dry at a few hundred. 0 = no cap.", "default": 30 }, "maxItems": { "title": "Max Shorts in total", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Overall cap for the run across all sources. 0 = no overall cap (each source still stops at its own cap).", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (id, url, title, counts, date, duration, hashtags, channel, sound, transcript) - sized for AI agents and MCP.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Fallback proxy. YouTube is read from the run's own IP first; this proxy (and RESIDENTIAL for the publish-date call) is used only where YouTube walls that IP.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many Shorts are read at the same time. Throughput is CPU-bound: 10 at the default 512 MB read about 100 Shorts a minute.", "default": 10 } } }, "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 } } } } } } } } } }