{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Scraper", "description": "Scrape TikTok comments and replies from any video, profile, hashtag or search. Get comment text, likes, replies, date, language, mentions and commenter, with the video on every row. Sort by most liked or newest, filter by date, likes or keywords.", "version": "0.0", "x-build-id": "IGtjUbFfM7dz4DnzN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/calm_builder~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-calm_builder-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/calm_builder~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-calm_builder-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/calm_builder~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-calm_builder-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 links", "type": "array", "description": "TikTok video or photo post links, one per row.\n\nSupported formats:\n- `https://www.tiktok.com/@khaby.lame/video/7354016355398012192`\n- `https://vm.tiktok.com/ZMxxxxxx/` (short links)", "items": { "type": "string" } }, "profiles": { "title": "Profiles", "type": "array", "description": "TikTok usernames or profile links, one per row (`khaby.lame`, `@khaby.lame` or a profile link). The comments of each profile's latest videos are collected.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags, one per row, with or without the `#`. The comments of the hashtag's videos are collected.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search TikTok videos for, one per row, e.g. `iphone 17 review`. The comments of the videos found are collected.", "items": { "type": "string" } }, "resultsPerPage": { "title": "Videos per profile, hashtag or keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many videos to take from **each** profile, hashtag or search keyword. Video links always count as one video each.", "default": 5 }, "newerThan": { "title": "Only videos newer than", "type": "string", "description": "For profiles, hashtags and keywords: skip videos posted before this date. Pick a date, or enter a relative period such as `7 days`. Does not apply to video links." }, "maxCommentsPerVideo": { "title": "Maximum comments per video", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many top-level comments to collect from **each** video. Replies are counted separately below.", "default": 100 }, "maxRepliesPerComment": { "title": "Maximum replies per comment", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many replies to collect under **each** comment. Set to **0** for no replies. Every reply is a result and is charged like a comment.", "default": 0 }, "commentSort": { "title": "Comment order", "enum": [ "default", "mostLiked", "newest" ], "type": "string", "description": "Which comments to collect first.\n\n- **TikTok's order** — the order the TikTok app shows (fastest)\n- **Most liked** — the most-liked comments of each video\n- **Newest** — the most recent comments of each video\n\n**Most liked** and **Newest** read up to 1,000 comments per video to pick from, so they take a few seconds longer per video. You are charged only for the comments returned.", "default": "default" }, "commentsAsThreads": { "title": "Nest replies inside their comment", "type": "boolean", "description": "Off (default): every comment and every reply is its own row, with `type` (`comment` or `reply`) and `parentCommentId` - best for spreadsheets.\n\nOn: one row per comment, with its replies inside the `replies` field - best for JSON and code. Pricing is the same either way.", "default": false }, "includeVideoDetails": { "title": "Include video details", "type": "boolean", "description": "Also save each video in a separate **Videos** table: views, likes, comment count, shares, saves, post date, caption, hashtags, music, cover and the creator's profile. Comments link to it through `videoId`.\n\nEach video row is charged as a video result. Every comment row already shows its video's link, ID, creator and caption at no extra cost.", "default": false }, "commentsNewerThan": { "title": "Only comments newer than", "type": "string", "description": "Skip comments posted before this date. Pick a date, or enter a relative period such as `24 hours` or `7 days`. Ideal for monitoring." }, "minCommentLikes": { "title": "Minimum comment likes", "minimum": 0, "type": "integer", "description": "Only return comments with at least this many likes. Leave empty to keep all." }, "commentKeywords": { "title": "Comment must contain", "type": "array", "description": "Only return comments containing at least one of these words or phrases (not case-sensitive), e.g. `price`, `where to buy`. Leave empty to keep all.", "items": { "type": "string" } }, "country": { "title": "Scrape as if from", "enum": [ "US", "AR", "AU", "BD", "BR", "CA", "CO", "EG", "FR", "DE", "ID", "IT", "JP", "MY", "MX", "NL", "NG", "PK", "PH", "PL", "SA", "ZA", "KR", "ES", "SE", "TH", "TR", "AE", "GB", "VN" ], "type": "string", "description": "Collect results as TikTok shows them in this country. Included at no extra cost.\n\nThe default, **United States**, gives the most complete results.", "default": "US" } } }, "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 } } } } } } } } } }