{ "openapi": "3.0.1", "info": { "title": "YouTube Scraper — Channel, Videos, Shorts & Comments — $3.7/1k", "description": "YouTube scraper for channels, videos, Shorts, search and comments. Channel About info, subscriber counts, likes, tags, chapters. Bulk Google Sheet input and new-item monitoring. No API key, no quota. No login or cookies. MCP-ready for AI agents. $3.7 per 1,000 records.", "version": "1.0", "x-build-id": "Yq7rxtOYncti1SysP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chimerical_quicklime~youtube-search-channel-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chimerical_quicklime-youtube-search-channel-video-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/chimerical_quicklime~youtube-search-channel-video-scraper/runs": { "post": { "operationId": "runs-sync-chimerical_quicklime-youtube-search-channel-video-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/chimerical_quicklime~youtube-search-channel-video-scraper/run-sync": { "post": { "operationId": "run-sync-chimerical_quicklime-youtube-search-channel-video-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": { "startUrls": { "title": "YouTube URLs", "type": "array", "description": "Any mix of channel URLs (@handle, /channel/UC…, /c/…, optionally ending in /videos, /shorts or /streams), video or Shorts URLs, playlist URLs and search-results URLs. Plain text lines are treated as search queries.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Search terms; each returns matching videos (or channels / playlists / Shorts, see Search type). Runs a sample search for \"python tutorial\" when nothing at all is given.", "items": { "type": "string" } }, "channelUrls": { "title": "Channels", "type": "array", "description": "Channel URLs, @handles or UC… ids (same as putting them in YouTube URLs).", "items": { "type": "string" } }, "videoUrls": { "title": "Videos", "type": "array", "description": "Video URLs or 11-character ids; returns full details for each.", "items": { "type": "string" } }, "listUrl": { "title": "Import list (CSV / Google Sheet URL)", "type": "string", "description": "Public CSV, TXT or Google Sheet (shared as \"anyone with the link\"). The first column of every row is read as a URL, handle or search query." }, "maxItems": { "title": "Max videos per query / channel / playlist", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Per search query, playlist and channel Videos tab. Alias: maxResults.", "default": 10 }, "channelTabs": { "title": "Channel tabs", "type": "array", "description": "Which channel tabs to read. A URL ending in /shorts or /streams reads only that tab.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live / past streams" ] }, "default": [ "videos" ] }, "maxShorts": { "title": "Max Shorts per channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Overrides Max videos for the Shorts tab; a value above 0 also turns the Shorts tab on. Alias: maxResultsShorts." }, "maxStreams": { "title": "Max streams per channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Overrides Max videos for the Live tab; a value above 0 also turns the Live tab on. Alias: maxResultStreams." }, "channelSortBy": { "title": "Channel sort", "enum": [ "newest", "popular", "oldest" ], "type": "string", "description": "Order of a channel's videos. Alias: sortVideosBy (NEWEST / POPULAR / OLDEST).", "default": "newest" }, "oldestPostDate": { "title": "Only videos published after", "type": "string", "description": "Date (YYYY-MM-DD) or relative age (\"30 days\", \"6 months\", \"1 year\"). Channel tabs stop at the first older page; search results are filtered. Without video details YouTube only gives relative dates (\"3 weeks ago\"), so the cutoff is approximate to that unit." }, "includeChannelInfo": { "title": "Add channel About info", "type": "boolean", "description": "Adds channel description, links, country, joined date, total views, video count, exact subscriber count, verified, avatar, banner, keywords and a monetization hint to every row (two extra requests per distinct channel).", "default": true }, "searchType": { "title": "Search type", "enum": [ "video", "shorts", "movie", "channel", "playlist" ], "type": "string", "description": "What a search returns. Channels and playlists come back as their own row types.", "default": "video" }, "uploadDate": { "title": "Upload date (search)", "enum": [ "any", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Search filter.", "default": "any" }, "duration": { "title": "Duration (search)", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Search filter (YouTube's current buckets).", "default": "any" }, "features": { "title": "Features (search)", "type": "array", "description": "Search filters; all selected must match.", "items": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creative_commons", "360", "vr180", "3d", "hdr", "location", "purchased" ], "enumTitles": [ "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location", "Purchased" ] }, "default": [] }, "sortBy": { "title": "Sort (search)", "enum": [ "relevance", "view_count", "upload_date", "rating" ], "type": "string", "description": "Search order. YouTube now offers only Relevance and Popularity; the old upload-date and rating sorts fall back to relevance.", "default": "relevance" }, "includeVideoDetails": { "title": "Fetch full video details", "type": "boolean", "description": "Adds exact publish timestamp, likes, exact views, duration, full description, tags, hashtags, category, chapters, comment count and channel subscribers to every search / channel / playlist video (two extra requests per video). Video URLs always get details. Alias: fetchDetails." }, "fetchDetails": { "title": "Fetch full details (legacy name)", "type": "boolean", "description": "Same as Fetch full video details; kept for existing integrations.", "default": false }, "includeComments": { "title": "Scrape comments", "type": "boolean", "description": "Adds the top-level comments of every video as separate rows (recordType \"comment\"): author, text, likes, reply count, time, pinned, hearted.", "default": false }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit of comment rows per video.", "default": 20 }, "commentsSort": { "title": "Comments order", "enum": [ "top", "newest" ], "type": "string", "description": "Top comments or newest first.", "default": "top" }, "onlyNew": { "title": "Only new items (monitor)", "type": "boolean", "description": "Remembers every video, channel, playlist and comment returned under the Monitor ID and returns only ones not seen in earlier runs. Schedule the actor to get a feed of new uploads or comments.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of the memory used by Only new items; use different IDs for unrelated monitors.", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy is recommended; YouTube rate-limits datacenter ranges.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "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 } } } } } } } } } }