{ "openapi": "3.0.1", "info": { "title": "Tiktok Comments Scraper", "description": "TikTok Comments Scraper: Extract comments, usernames, timestamps, likes, replies, and engagement data from TikTok videos. Analyze audience feedback, sentiment, user interactions, content performance, and trending conversations for social media research and competitor analysis.", "version": "0.1", "x-build-id": "JTcfRmBH1KG2bVNZB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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": { "postURLs": { "title": "TikTok video URLs", "type": "array", "description": "The video URLs to extract comments from. Add them one by one or paste a list in Bulk edit. Tracking parameters such as ?is_from_webapp=1 are fine and are stripped automatically.", "items": { "type": "string" } }, "commentsPerPost": { "title": "Maximum comments per post", "minimum": 1, "type": "integer", "description": "How many top-level comments to collect per video. TikTok serves roughly 47-50 comments per API page, so the final count can land slightly under a request that is not a multiple of the page size.", "default": 10 }, "maxRepliesPerComment": { "title": "Maximum replies per comment", "minimum": 0, "type": "integer", "description": "How many replies to collect from each comment that has any. The reply endpoint is paged 20 at a time until this number is met, so values above 20 are honoured. Set to 0 to skip replies entirely and run faster.", "default": 3 }, "profiles": { "title": "Usernames", "type": "array", "description": "One or more TikTok usernames, with or without the leading @. Use Bulk edit to paste a prepared list.", "items": { "type": "string" } }, "resultsPerPage": { "title": "Number of videos per profile", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many videos to take from each profile. Values above 1000 are coerced down to 1000 at runtime and the coercion is logged.", "default": 10 }, "profileScrapeSections": { "title": "Profile sections to scrape", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Videos uses a plain HTTP request. Reposts has no HTTP equivalent and starts a headless browser, so it is noticeably slower.", "items": { "type": "string", "enum": [ "videos", "reposts" ] }, "default": [ "videos" ] }, "profileSorting": { "title": "Profile video sorting", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "Latest reads the profile feed in order. Popular and Oldest collect a wider window of recent videos (up to 5x your requested count, capped at 200) and sort within that window, so they approximate rather than search a creator's whole history.", "default": "latest" }, "oldestPostDateUnified": { "title": "Scrape profile videos published after [date]", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Optional. Only videos uploaded on or after this date are used. Absolute (YYYY-MM-DD) or relative (for example: 5 days, 2 weeks). Filters videos, not comments." }, "newestPostDate": { "title": "Scrape profile videos published before [date]", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Optional. Only videos uploaded on or before this date are used. Absolute (YYYY-MM-DD) or relative (for example: 5 days, 2 weeks). Filters videos, not comments." }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "Skip a profile's pinned videos, which are usually the first ones shown on the profile page.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "The run starts with no proxy, which is normally enough. If TikTok blocks a request it escalates to a datacenter proxy and then to residential with 3 retries." } } }, "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 } } } } } } } } } }