{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Scraper", "description": "Scrape the comments of one or MANY TikTok videos in a single run. Returns text, author, likes, thread structure (parent/reply) and the source video itself. No login, no cookies — uses a real browser so TikTok signs its own API requests.", "version": "0.0", "x-build-id": "CjHUB5UyW0ZDEroj0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/outspoken_strategy~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-outspoken_strategy-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/outspoken_strategy~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-outspoken_strategy-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/outspoken_strategy~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-outspoken_strategy-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": "Video URLs", "type": "array", "description": "URLs of the TikTok videos whose comments you want to scrape — one or MANY videos per run. Use full video URLs like https://www.tiktok.com/@user/video/7401234567890123456 (photo posts and a bare numeric video id also work). Short links (vm.tiktok.com/...) are not supported. De-duplicated by video.", "items": { "type": "string" } }, "startUrls": { "title": "Video URLs (request list)", "type": "array", "description": "Alternative way to provide the video URLs as a request list of { \"url\": ... } objects. Merged with \"urls\" and de-duplicated by video.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxComments": { "title": "Max comments per video", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of comments to fetch PER video (replies count towards this limit). The source video itself is also emitted (flagged is_source_post) and does not count.", "default": 100 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also fetch replies to comments (with parentCommentId/replyLevel set) by expanding the \"View more replies\" links. Top-level comments are collected first; replies fill the remaining maxComments budget. Uncheck to keep only top-level comments.", "default": true }, "includeSourcePost": { "title": "Include the source video", "type": "boolean", "description": "Also emit one dataset item for the video itself (flagged is_source_post: true) with its caption, author and engagement counts. Uncheck to get comments only.", "default": true }, "region": { "title": "Region", "type": "string", "description": "Two-letter country code for the proxy exit region (e.g. US, GB, ZW). Keep it stable.", "default": "US" }, "cookies": { "title": "TikTok session cookies", "type": "array", "description": "A logged-in TikTok session (export with a Get cookies.txt / EditThisCookie style extension while signed in to tiktok.com). REQUIRED for reliable results: TikTok gates its comment API for logged-out guests and returns empty responses regardless of the proxy IP, so without a session most runs collect 0 comments. Provide the exported cookie array (objects with name/value/domain)." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy to route traffic through. Residential proxies with a country set are strongly required — TikTok blocks datacenter IPs and serves empty API responses / captcha to flagged exits, so the actor preflights IPs and retries on fresh ones.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "headless": { "title": "Run browser headless", "type": "boolean", "description": "Uncheck to run a headed browser (useful only for local debugging).", "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 } } }, "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 } } } } } } } } } }