{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper — Channels, Videos, Shorts & Search", "description": "Scrape YouTube search results, channels, Shorts, live streams and playlists, plus optional full video details: views, likes, comments, tags, chapters, subscribers.", "version": "0.1", "x-build-id": "oZGdkijYBd2NWumvR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~youtube-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": "Keywords to search on YouTube, one per line. Each term returns up to 'Max results per search / channel tab / playlist' results (videos, Shorts, channels and playlists, or only the type you pick below).", "items": { "type": "string" } }, "searchType": { "title": "Result type", "enum": [ "all", "video", "shorts", "channel", "playlist", "movie" ], "type": "string", "description": "Only return this kind of result (YouTube's 'Type' filter). 'All' keeps YouTube's mixed results page, including its Shorts shelves.", "default": "all" }, "uploadDate": { "title": "Upload date", "enum": [ "any", "today", "week", "month", "year" ], "type": "string", "description": "YouTube's 'Upload date' filter. YouTube removed 'Last hour' and sorting by upload date in 2025; use 'Today' or 'This week' to find recent videos.", "default": "any" }, "duration": { "title": "Duration", "enum": [ "any", "under3", "3to20", "over20" ], "type": "string", "description": "YouTube's 'Duration' filter.", "default": "any" }, "features": { "title": "Features", "type": "array", "description": "YouTube's 'Features' filters; a result must have all selected features.", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creativeCommons", "360", "vr180", "3d", "hdr", "location", "purchased" ], "enumTitles": [ "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location", "Purchased" ] } }, "sortBy": { "title": "Prioritize", "enum": [ "relevance", "popularity" ], "type": "string", "description": "YouTube's 'Prioritize' option: relevance (default) or popularity (view count).", "default": "relevance" }, "urls": { "title": "YouTube URLs", "type": "array", "description": "One per line: channel URLs (`/@handle`, `/channel/UC...`, `/c/name`, optionally ending in `/videos`, `/shorts` or `/streams`) or bare @handles, playlist URLs, video or Shorts URLs (always returned with full details), and search result URLs (`/results?search_query=...&sp=...`, filters kept).", "items": { "type": "string" } }, "channelTabs": { "title": "Channel tabs", "type": "array", "description": "Which lists to scrape for each channel URL: Videos, Shorts and/or Live (past, current and upcoming streams). A channel URL ending in `/shorts`, `/videos` or `/streams` uses only that tab. Leave empty to get only the channel row.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live" ] }, "default": [ "videos" ] }, "channelSort": { "title": "Channel sort", "enum": [ "newest", "popular", "oldest" ], "type": "string", "description": "Order of the channel tab lists: newest first (default), most popular, or oldest first.", "default": "newest" }, "includeChannelInfo": { "title": "Channel row", "type": "boolean", "description": "Save one row per channel URL with subscribers, video count, total views, joined date, country, description, links from the About panel, avatar, banner and verified badge. Charged as one result.", "default": true }, "maxResultsPerSource": { "title": "Max results per search / channel tab / playlist", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop each search term, each channel tab and each playlist after this many results. Set a high number (e.g. 10000) to get a whole channel or playlist. 0 = channel rows only.", "default": 50 }, "includeVideoDetails": { "title": "Full video details", "type": "boolean", "description": "Also open every video and Short from searches, channels and playlists for likes, comment count, exact views, publish date and time, duration, tags, category, description, chapters and channel subscribers. Charged as a 'video details' event instead of a list result. Video URLs always get details.", "default": false }, "includeChannelDetails": { "title": "Full details for channels found by search", "type": "boolean", "description": "For channels in search results, also read the About panel (total views, joined date, country, links). No extra charge; channel URLs always get it.", "default": false }, "maxItems": { "title": "Max results (total)", "minimum": 1, "type": "integer", "description": "Stop the whole run after this many saved rows. Every saved row is charged, so this caps the cost.", "default": 1000 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only new videos, Shorts and playlists, plus channel rows whose subscriber or video count changed. Use with a Schedule; unchanged items are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same input stay separate; defaults to a key derived from the input" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) works for search, channel, playlist and video pages and is the cheapest option. Full video details also make one small request (about 10 KB) per video through Apify RESIDENTIAL proxy, because YouTube asks datacenter IPs to sign in for duration, tags and category: about $0.0001 of proxy traffic per video.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }