{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Extractor", "description": "Extract comments, replies, and user data from any TikTok video or profile. Fast, reliable, and low-bandwidth — scrapes ~400 comments in under 40 seconds. Export to JSON, CSV, or Excel.", "version": "2.0", "x-build-id": "ybnVTeehHeO9aafhD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeforge~tiktok-comments-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeforge-tiktok-comments-extractor", "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/scrapeforge~tiktok-comments-extractor/runs": { "post": { "operationId": "runs-sync-scrapeforge-tiktok-comments-extractor", "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/scrapeforge~tiktok-comments-extractor/run-sync": { "post": { "operationId": "run-sync-scrapeforge-tiktok-comments-extractor", "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": { "postURLs": { "title": "TikTok Video URLs", "type": "array", "description": "List of TikTok video URLs to scrape comments from (e.g., https://www.tiktok.com/@user/video/1234567890)", "default": [], "items": { "type": "string" } }, "profileURLs": { "title": "TikTok Profile URLs", "type": "array", "description": "List of TikTok profile URLs or usernames. All videos from these profiles will have their comments scraped.", "default": [], "items": { "type": "string" } }, "commentsPerPost": { "title": "Comments per post", "minimum": 0, "type": "integer", "description": "Maximum number of comments to scrape per video. Set to 0 for all comments.", "default": 0 }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 0, "type": "integer", "description": "Maximum number of replies to fetch per comment. Set to 0 to skip replies.", "default": 0 }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "If true, pinned posts from profile scraping will be excluded.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for the scraper. In harvest mode (default) TikTok's organic responses work reliably from Apify's automatic datacenter proxy, which is far cheaper. Only select RESIDENTIAL if you disable harvest mode (legacy signed-request method needs it) or hit blocks.", "default": { "useApifyProxy": true } }, "harvestMode": { "title": "Harvest mode (recommended)", "type": "boolean", "description": "Collect comments from TikTok's organic responses via scrolling (reliable, low bandwidth). Disable to use the legacy signed-request method.", "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 } } } } } } } } } }