{ "openapi": "3.0.1", "info": { "title": "YouTube Comments Scraper", "description": "Comments and replies from any public YouTube video, Short or live replay, with no login. For every video, the run tells you whether you got all the comments, and if not, why.", "version": "0.1", "x-build-id": "GIVUba2aajMjmWMaK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sedgelabs~youtube-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sedgelabs-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/sedgelabs~youtube-comments-scraper/runs": { "post": { "operationId": "runs-sync-sedgelabs-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/sedgelabs~youtube-comments-scraper/run-sync": { "post": { "operationId": "run-sync-sedgelabs-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": [ "videos" ], "properties": { "videos": { "title": "Videos", "type": "array", "description": "YouTube video URLs or 11-character video IDs.", "items": { "type": "string" } }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "type": "integer", "description": "Stop after this many comments per video, replies included.", "default": 100 }, "sort": { "title": "Sort", "enum": [ "top", "newest" ], "type": "string", "description": "Top comments or newest first.", "default": "top" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also fetch replies to each comment.", "default": false }, "includeAuthor": { "title": "Include author fields", "type": "boolean", "description": "Add author name, channel ID and handle to each row. Turn off to leave personal data out.", "default": true }, "oldestCommentDate": { "title": "Comments from", "type": "string", "description": "Only comments posted on or after this. A date (2026-01-31) or an age (7 days, 2 weeks, 3 months). Stops at the first older comment, so you only pay for the newer ones. Needs Sort set to Newest. YouTube shows dates as \"3 weeks ago\", so dates are estimates; see the \"Posted around\" column." }, "newestCommentDate": { "title": "Comments until", "type": "string", "description": "Only comments posted on or before this. Same formats; a date includes that whole day. For example, Comments from \"14 days\" until \"7 days\" gives the week before last. Comments newer than this are looked at and skipped, which counts toward Max comments to scan. Needs Sort set to Newest. Can't be used with Only new comments." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Only comments with at least this many likes. YouTube rounds large counts (1.3K), so above 1,000 this is approximate.", "default": 0 }, "onlyHeartedByCreator": { "title": "Only comments hearted by the creator", "type": "boolean", "description": "Only comments the video's creator gave a heart.", "default": false }, "keywords": { "title": "Keywords", "type": "array", "description": "Only comments containing any of these words or phrases, ignoring upper and lower case.", "default": [], "items": { "type": "string" } }, "maxCommentsScanned": { "title": "Max comments to scan per video", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Only used when a filter or Comments until is on. Filters can match rarely, so this limits how far the run looks on each video, up to 20,000. The run summary says when a video hit it.", "default": 5000 }, "onlyNewComments": { "title": "Only new comments since the last run", "type": "boolean", "description": "For scheduled runs that watch the same videos. Each run remembers the newest comments it looked at on each video, and the next run returns only comments posted after it, so you never pay twice for one comment. The first run returns comments as usual (up to Max comments per video and the date filter). Needs Sort set to Newest. New replies on older comments are not picked up. The memory is kept in the key-value store \"youtube-comments-memory\" in your account; delete it to start over.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Only matters with \"Only new comments\" on. Runs with the same name share one memory. Give each schedule its own name if two schedules watch the same video, or one will take the other's new comments.", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy used for requests to YouTube.", "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 } } } } } } } } } }