{ "openapi": "3.0.1", "info": { "title": "YouTube Shorts Scraper", "description": "Scrape YouTube Shorts from channels, search terms, hashtags and Short links. Exact views, likes and comment counts, publish date, hashtags, sound, channel details with social links and comments. Fast and low cost.", "version": "0.0", "x-build-id": "ly4bxHCwfcpf7Wn7s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/calm_builder~youtube-shorts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-calm_builder-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/calm_builder~youtube-shorts-scraper/runs": { "post": { "operationId": "runs-sync-calm_builder-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/calm_builder~youtube-shorts-scraper/run-sync": { "post": { "operationId": "run-sync-calm_builder-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": { "searchQueries": { "title": "Search terms or hashtags", "type": "array", "description": "Keywords to search for Shorts, one per row. Start with # for a hashtag (e.g. #cooking).", "items": { "type": "string" } }, "startUrls": { "title": "Channels, Shorts and hashtag links", "type": "array", "description": "One per row: channel @handle or URL (its Shorts tab is used), Short links (youtube.com/shorts/...), hashtag pages (youtube.com/hashtag/...) and YouTube search links.", "items": { "type": "string" } }, "maxShorts": { "title": "Shorts per channel, search or hashtag", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Shorts to collect for each channel, search term and hashtag. Short links are always used.", "default": 20 }, "channelSortBy": { "title": "Channel Shorts order", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "Order of a channel's Shorts tab: latest, most popular or oldest first.", "default": "latest" }, "searchSortBy": { "title": "Sort by", "enum": [ "relevance", "popularity" ], "type": "string", "description": "YouTube's 'Prioritize' option.", "default": "relevance" }, "searchUploadDate": { "title": "Upload date", "enum": [ "", "today", "week", "month", "year" ], "type": "string", "description": "Only videos uploaded within this period.", "default": "" }, "publishedAfter": { "title": "Published after", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Only Shorts published after this date (exact date or e.g. '7 days'). Short links you paste are always kept." }, "includeShortsSound": { "title": "$ Add Shorts sound", "type": "boolean", "description": "Extra charge per Short. Adds the sound / song the Short uses (or 'Original sound').", "default": false }, "includeChannelInfo": { "title": "$ Add channel details", "type": "boolean", "description": "Extra charge per channel. Adds one row per channel in its own table: subscribers, total views, video count, country, join date, description and all social / website links. Each channel is collected and charged once per run.", "default": false }, "maxComments": { "title": "$ Comments per Short", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Charged per comment. Top-level comments to collect for each Short (0 = none), in their own table.", "default": 0 }, "commentsSortBy": { "title": "Comments order", "enum": [ "top", "newest" ], "type": "string", "description": "YouTube's comment order.", "default": "top" }, "maxReplyDepth": { "title": "Reply depth", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many levels of replies to collect: 0 = no replies, 1 = direct replies, up to 6 for replies to replies.", "default": 0 }, "maxRepliesPerComment": { "title": "Maximum replies per comment", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Replies to collect under each comment, at every level.", "default": 5 }, "country": { "title": "Country", "enum": [ "US", "GB", "CA", "AU", "IN", "PK", "DE", "FR", "ES", "IT", "NL", "BR", "MX", "JP", "KR", "ID", "PH", "TR", "AE", "SA" ], "type": "string", "description": "YouTube shows search results and availability for this country.", "default": "US" } } }, "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 } } } } } } } } } }