{ "openapi": "3.0.1", "info": { "title": "â–ļī¸ YouTube Scraper", "description": "Scrape YouTube videos, Shorts, channels, playlists, comments, and search results, no API key or quota limit. Extract subtitles, transcripts, channel emails, and a computed virality score for creator research and content analysis.", "version": "1.0", "x-build-id": "jRmYpA5ezC9hYGakH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/citrine_venus~youtube-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-citrine_venus-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/citrine_venus~youtube-scraper/runs": { "post": { "operationId": "runs-sync-citrine_venus-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/citrine_venus~youtube-scraper/run-sync": { "post": { "operationId": "run-sync-citrine_venus-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": [ "urls" ], "properties": { "urls": { "title": "🔗 YouTube URLs", "type": "array", "description": "đŸŽŦ Video, Shorts, channel, playlist, hashtag or search-results links — one per line, or upload a file. Example: `https://www.youtube.com/watch?v=...`, `https://www.youtube.com/@channelhandle`, `https://www.youtube.com/playlist?list=...`.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "🔎 Search queries", "type": "array", "description": "đŸ—ēī¸ Plain search terms to run on YouTube search — for example `sports highlights`, `react tutorial`. Each line is searched separately, same as typing into the YouTube search box.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "đŸŽŦ Max videos per source", "minimum": 0, "maximum": 5000, "type": "integer", "description": "đŸ“Ŧ How many regular videos to collect per search term, channel or playlist. Start small for a quick sample, raise it for a full harvest.", "default": 10 }, "maxResultsShorts": { "title": "📱 Max Shorts per source", "minimum": 0, "maximum": 5000, "type": "integer", "description": "📱 How many Shorts to collect per search term or channel. 0 = don't collect Shorts.", "default": 0 }, "maxResultStreams": { "title": "🔴 Max streams per source", "minimum": 0, "maximum": 5000, "type": "integer", "description": "🔴 How many live/upcoming streams to collect per search term or channel. 0 = don't collect streams.", "default": 0 }, "sortingOrder": { "title": "🔃 Sort results by", "enum": [ "", "relevance", "rating", "date", "views" ], "type": "string", "description": "🔃 How YouTube orders the search results.", "default": "" }, "dateFilter": { "title": "📅 Upload date", "enum": [ "", "hour", "today", "week", "month", "year" ], "type": "string", "description": "📅 Only include videos uploaded within this window.", "default": "" }, "videoType": { "title": "🎞ī¸ Content type", "enum": [ "", "video", "movie" ], "type": "string", "description": "🎞ī¸ Restrict to videos or movies only.", "default": "" }, "lengthFilter": { "title": "⏱ī¸ Video length", "enum": [ "", "under4", "between420", "plus20" ], "type": "string", "description": "⏱ī¸ Filter by video duration.", "default": "" }, "isHD": { "title": "đŸ“ē HD only", "type": "boolean", "description": "đŸ“ē Only include HD videos.", "default": false }, "hasSubtitles": { "title": "đŸ’Ŧ Has subtitles/CC", "type": "boolean", "description": "đŸ’Ŧ Only include videos with subtitles or closed captions available.", "default": false }, "hasCC": { "title": "Šī¸ Creative Commons", "type": "boolean", "description": "Šī¸ Only include videos licensed under Creative Commons.", "default": false }, "is3D": { "title": "đŸ•ļī¸ 3D", "type": "boolean", "description": "đŸ•ļī¸ Only include 3D videos.", "default": false }, "isLive": { "title": "🔴 Live now", "type": "boolean", "description": "🔴 Only include videos that are currently live.", "default": false }, "isBought": { "title": "🛒 Purchased", "type": "boolean", "description": "🛒 Only include content you've purchased (account-dependent).", "default": false }, "is4K": { "title": "🎞ī¸ 4K", "type": "boolean", "description": "🎞ī¸ Only include 4K videos.", "default": false }, "is360": { "title": "🌐 360°", "type": "boolean", "description": "🌐 Only include 360° videos.", "default": false }, "isHDR": { "title": "🌈 HDR", "type": "boolean", "description": "🌈 Only include HDR videos.", "default": false }, "hasLocation": { "title": "📍 Has location", "type": "boolean", "description": "📍 Only include videos tagged with a location.", "default": false }, "isVR180": { "title": "đŸĨŊ VR180", "type": "boolean", "description": "đŸĨŊ Only include VR180 videos.", "default": false }, "sortVideosBy": { "title": "📚 Channel video order", "enum": [ "NEWEST", "POPULAR", "OLDEST" ], "type": "string", "description": "📚 For channel URLs: which order to read the Videos/Shorts/Live tab in.", "default": "NEWEST" }, "extractComments": { "title": "đŸ’Ŧ Extract comments", "type": "boolean", "description": "đŸ’Ŧ Collect top comments for every video (author, text, likes, replies).", "default": false }, "maxComments": { "title": "đŸ”ĸ Max comments per video", "minimum": 0, "maximum": 5000, "type": "integer", "description": "đŸ”ĸ Stop collecting comments for a video after this many.", "default": 20 }, "downloadSubtitles": { "title": "📝 Download subtitles", "type": "boolean", "description": "📝 Collect the subtitle/caption track for every video, when available.", "default": false }, "subtitlesLanguage": { "title": "đŸ—Ŗī¸ Subtitle language", "type": "string", "description": "đŸ—Ŗī¸ Language code to prefer — for example `en`, `es`, `hi`. Use `any` to accept whatever is available.", "default": "en" }, "subtitlesFormat": { "title": "📄 Subtitle format", "enum": [ "srt", "vtt", "plaintext", "json3" ], "type": "string", "description": "📄 File format for the collected subtitle text.", "default": "srt" }, "preferAutoGeneratedSubtitles": { "title": "🤖 Prefer auto-generated", "type": "boolean", "description": "🤖 Prefer YouTube's auto-generated captions over manually-uploaded ones when both exist.", "default": false }, "computeOutlierScore": { "title": "🚀 Outlier score & engagement rate", "type": "boolean", "description": "🚀 Score each video against the channel's own recent median views (virality) and compute (likes + comments) / views as an engagement rate.", "default": true }, "extractChannelDetails": { "title": "đŸ“ē Channel About panel", "type": "boolean", "description": "đŸ“ē For channel URLs: also read the About panel — description, country, join date, total views/videos, external links and emails found in the description.", "default": true }, "monitorMode": { "title": "🔁 Skip previously-seen videos", "type": "boolean", "description": "🔁 Remembers every video ID collected by a previous run of this Actor (same account) and skips them next time — perfect for a daily/weekly schedule that should only report new uploads.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "đŸšĻ By default the run starts on a direct connection and automatically switches to a datacenter and then a residential route only if YouTube pushes back. Pick your own route here to override that.", "default": { "useApifyProxy": false } }, "browserFallback": { "title": "🧭 Browser rescue", "type": "boolean", "description": "🧭 As a last resort, retry stubborn requests inside a real browser session.", "default": true }, "maxConcurrency": { "title": "⚡ Sources in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "🏎ī¸ How many URLs/search queries to process at the same time.", "default": 5 }, "maxRequestRetries": { "title": "🔁 Retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "🛡ī¸ Attempts before a request is considered failed on the current network route.", "default": 3 }, "maxScanned": { "title": "🧮 Max rows scanned per search", "minimum": 100, "maximum": 200000, "type": "integer", "description": "🧮 Safety cap on how many search-result rows are examined per query before giving up.", "default": 20000 } } }, "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 } } } } } } } } } }