{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Scraper", "description": "Scrape TikTok comments and replies from any video or from a creator's latest videos at about 13,000 comments per minute. Built-in only-new-comments monitoring, date filters and a real-time API. Likes, pinned and creator-liked flags, language and author. No login.", "version": "0.1", "x-build-id": "9iWQusNTHHv0DwD8o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-tiktok-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/automly~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-automly-tiktok-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/automly~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-automly-tiktok-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", "properties": { "videoUrls": { "title": "Video URLs", "type": "array", "description": "TikTok video URLs to scrape comments from. Supports https://www.tiktok.com/@user/video/123..., short links (vm.tiktok.com/..., vt.tiktok.com/...), and bare numeric video IDs. Optional if you add creators below.", "items": { "type": "string" } }, "profiles": { "title": "Creators", "type": "array", "description": "TikTok usernames or profile URLs (scout2015, @scout2015 or https://www.tiktok.com/@scout2015). The actor scrapes comments from each creator's latest videos, pinned videos included.", "items": { "type": "string" } }, "resultsPerProfile": { "title": "Videos per creator", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many of each creator's latest videos to scrape comments from (after the date filters below).", "default": 10 }, "videosPublishedAfter": { "title": "Videos published after", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2})?(Z|[+-]\\d{2}:?\\d{2})?)?$", "type": "string", "description": "Only creators' videos published on or after this date, e.g. 2026-08-01 (UTC if no offset). Does not apply to Video URLs." }, "videosPublishedBefore": { "title": "Videos published before", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2})?(Z|[+-]\\d{2}:?\\d{2})?)?$", "type": "string", "description": "Only creators' videos published before this date, e.g. 2026-09-01 (UTC if no offset). Does not apply to Video URLs." }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of top-level comments checked per video. Replies are counted separately (see Max replies per comment).", "default": 300 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also scrape the replies under each comment. Each reply is its own row with parentCommentId set.", "default": false }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum replies scraped under each comment when Include replies is on.", "default": 20 }, "includePinned": { "title": "Include pinned comments", "type": "boolean", "description": "Include comments that the video author has pinned to the top of the thread.", "default": true }, "onlyNewComments": { "title": "Only new comments", "type": "boolean", "description": "Output only comments that are new since your last run with this option on. The first run on a video outputs everything. Schedule the actor with this on to track new comments.", "default": false }, "commentsSince": { "title": "Comments published since", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2})?(Z|[+-]\\d{2}:?\\d{2})?)?$", "type": "string", "description": "Only output comments published on or after this date, e.g. 2026-09-01 or 2026-09-01T12:00:00Z (UTC if no offset). Older comments are skipped but still count towards Max comments per video." }, "language": { "title": "Language", "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$", "type": "string", "description": "Two-letter ISO language code used to negotiate TikTok's Accept-Language header (e.g. en, es, fr, de, ja).", "default": "en" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The default works for most runs.", "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 } } } } } } } } } }