{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Scraper - Comments & Replies from Any Video", "description": "Paste TikTok video links, get every comment and reply as clean rows: text, likes, reply threads, author, language, pinned and creator-liked flags, mentions, hashtags, tagged shop products and image comments. No login, no proxy, no cookies.", "version": "1.0", "x-build-id": "d9k5zdyuitZhNdqq2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearfetch~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearfetch-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/clearfetch~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-clearfetch-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/clearfetch~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-clearfetch-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": { "urls": { "title": "TikTok video links", "type": "array", "description": "One video per line. Full links, share links (vm.tiktok.com/..., tiktok.com/t/...), photo posts and bare video ids all work. Also accepts \"postURLs\", \"videoUrls\", \"url\" and \"startUrls\".", "items": { "type": "string" } }, "maxCommentsPerVideo": { "title": "Maximum comments per video", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Top-level comments to collect from each video. 0 means all of them. Replies are counted separately, below.", "default": 100 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also collect the replies under each comment. Each reply is its own row with parentCommentId pointing at the comment it answers, so threads can be rebuilt from a flat export.", "default": false }, "maxRepliesPerComment": { "title": "Maximum replies per comment", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Used only when replies are included. 0 means all of them.", "default": 20 }, "onlyNew": { "title": "Only comments posted since the last run", "type": "boolean", "description": "For scheduled runs: write and charge only comments posted after the newest comment an earlier run delivered for the same video, so each run returns just the new ones. The first run returns everything. TikTok orders comments by popularity, not date, so a monitoring run should read generously: set the maximum above to 0 (all) or a high number. The marks are kept in a named key-value store in your account.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "The key-value store that remembers, per video, the newest comment delivered, for onlyNew. Use a different name per schedule if two schedules watch the same videos.", "default": "tiktok-comments-scraper-state" }, "includeRaw": { "title": "Include TikTok's raw comment object", "type": "boolean", "description": "Adds the untouched comment object TikTok returned as \"raw\", for fields this Actor does not map. Makes each row several times larger.", "default": false }, "maxConcurrency": { "title": "Videos in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many videos to work on at once. Comments within one video are always read in order.", "default": 3 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per request. Slow pages are retried before a video is reported as failed.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: TikTok serves comments to Apify's own servers. Turn it on only if you run very large volumes and start seeing rate-limit errors.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }