{ "openapi": "3.0.1", "info": { "title": "TikTok Comments API: Export Comments & Replies", "description": "TikTok comments scraper: get the comments and replies of TikTok videos from video URLs, IDs, short links or creators' profiles. Text, likes, replies, time, the commenter's name, photo, username and badge, language and mentions when shown, buyers flagged, optional bio and followers. No login.", "version": "0.7", "x-build-id": "sQo72adqBIp54OgFH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-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/deepmine~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-deepmine-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/deepmine~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-deepmine-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": { "videos": { "title": "đŸŽŦ Videos (URLs or IDs)", "type": "array", "description": "TikTok video links, vm.tiktok.com short links or video IDs, one per line. Or leave empty and add profiles below.", "items": { "type": "string" } }, "maxCommentsPerVideo": { "title": "đŸ’Ŧ Max comments per video", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Top-level comments per video, top comments first (TikTok's order). Replies come on top. You pay per comment and per reply.", "default": 25 }, "includeReplies": { "title": "↩ī¸ Include replies", "type": "boolean", "description": "Each reply is its own row, right under its comment, and costs the same as a comment.", "default": false }, "maxRepliesPerComment": { "title": "↩ī¸ Max replies per comment", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Used with Include replies. In TikTok's order.", "default": 5 }, "commenterProfiles": { "title": "👤 Add commenter profiles", "type": "boolean", "description": "Adds each commenter's large photo, bio, bio link, followers, following, likes, video count, join date and whether the bio shows an email or phone. Free, but slower (one lookup per commenter). Name, photo and verified badge come with every comment anyway.", "default": false }, "profiles": { "title": "👤 Profiles", "type": "array", "description": "TikTok usernames or profile links, one per line: the comments on each creator's newest videos. You pay per comment only.", "items": { "type": "string" } }, "videosPerProfile": { "title": "Videos per profile", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Newest first; pinned videos come first, as on TikTok.", "default": 10 }, "profileSorting": { "title": "Profile video order", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "As the profile's tabs on TikTok. With a date range, Popular reads the whole list (slower).", "default": "latest" }, "profileSections": { "title": "Profile sections", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Reposts are other creators' videos the profile reposted. Videos per profile counts both together.", "items": { "type": "string", "enum": [ "videos", "reposts" ], "enumTitles": [ "Own videos", "Reposts" ] }, "default": [ "videos" ] }, "postedAfter": { "title": "📅 Only videos posted after", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?Z?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "A date, or a relative time such as 7 days. Empty = all." }, "postedBefore": { "title": "📅 Only videos posted before", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?Z?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$", "type": "string", "description": "A date (the whole day counts), or a relative time such as 1 day. Empty = all." }, "excludePinnedPosts": { "title": "Skip pinned videos", "type": "boolean", "description": "Leave out the videos the creator pinned to the top of the profile.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: datacenter proxies work for comments. Switch to residential only if a run reports blocks.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }