{
"openapi": "3.0.1",
"info": {
"title": "YouTube Comments Scraper",
"description": "Comments and replies of YouTube videos, playlists and channels: text, author, likes, replies, pinned and creator hearts, video metadata. Top or newest first, date cut. A row per video says why when there are none. No login, no browser.",
"version": "1.0",
"x-build-id": "8k44RLrIorlWJg8Tv"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~youtube-comments-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-youtube-comments-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/steadyscrape~youtube-comments-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-youtube-comments-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/steadyscrape~youtube-comments-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-youtube-comments-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": "Videos, playlists or channels",
"type": "array",
"description": "One per line: a video link in any shape (watch?v=, youtu.be, Shorts, live, embed) or a bare video id; a playlist link or id; a channel link (@handle, /channel/UC…, /c/, /user/) or a bare @handle. A playlist or channel expands to its videos, newest first for channels.",
"items": {
"type": "string"
}
},
"maxCommentsPerVideo": {
"title": "Max comments per video",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Top-level comments to read per video, in the order chosen below (YouTube pages by 20). Replies are counted apart.",
"default": 100
},
"sortBy": {
"title": "Order",
"enum": [
"top",
"newest"
],
"type": "string",
"description": "YouTube's own two orders: top (what the page shows first) or newest.",
"default": "top"
},
"includeReplies": {
"title": "Include replies",
"type": "boolean",
"description": "Also read the replies of each comment (one request per 10 replies). Reply rows have isReply true and parentCommentId.",
"default": false
},
"maxRepliesPerComment": {
"title": "Max replies per comment",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "With replies on: how many replies to read under each comment.",
"default": 50
},
"publishedAfter": {
"title": "Only comments from this day on",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "YYYY-MM-DD. Walks the comments newest first (the order switches to newest) and stops at the first older one. YouTube only says \"3 weeks ago\", so the cut is as exact as that."
},
"maxVideosPerSource": {
"title": "Max videos per playlist or channel",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Stop expanding each playlist or channel after this many videos. Videos given directly are not counted.",
"default": 20
},
"residentialFallback": {
"title": "Residential proxy fallback",
"type": "boolean",
"description": "A video refused on the direct route and on a datacenter proxy is retried through Apify's residential proxy (about 1.5 KB per comment, charged by Apify as proxy traffic). Off: such videos end with status blocked.",
"default": 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
}
}
}
}
}
}
}
}
}
}