{ "openapi": "3.0.1", "info": { "title": "Tiktok Comments Scraper", "version": "0.1", "x-build-id": "fCoHscwnet7VaMmst" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraply~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraply-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/scraply~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-scraply-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/scraply~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-scraply-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": "Add the video URLs you want to extract comments from. Enter URLs one by one or edit it in bulk.", "items": { "type": "string" } }, "commentsPerPost": { "title": "Maximum comments per post", "minimum": 1, "type": "integer", "description": "The number of comments extracted from every result. Due to TikTok API limitations, the actual number of scraped comments may differ, especially for posts with thousands of comments.", "default": 100 }, "maxRepliesPerComment": { "title": "Maximum replies per comment", "minimum": 0, "type": "integer", "description": "The maximum number of replies you want from a single comment. Note: Successful extraction of all desired replies is currently not guaranteed.", "default": 3 }, "profiles": { "title": "Usernames", "type": "array", "description": "Add one or multiple TikTok usernames you want to scrape. You can enter the usernames one by one, or use the Bulk edit section to add a prepared list.", "items": { "type": "string" } }, "resultsPerPage": { "title": "💯 Number of videos per profile", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Add the number of videos you want to scrape per profile.", "default": 10 }, "profileScrapeSections": { "title": "Profile sections to scrape", "minItems": 1, "uniqueItems": true, "type": "array", "description": "If a profile has reposted videos, you can scrape them by selecting Reposts", "items": { "type": "string", "enum": [ "videos", "reposts" ] }, "default": [ "videos" ] }, "profileSorting": { "title": "Profile video sorting", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "Select: Latest / Oldest / Popular. Date filters only work with Latest and Oldest.", "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 filter. Only videos uploaded after or on this date will be scraped. Supports absolute date (YYYY-MM-DD) or relative date (e.g. 5 days, 2 weeks)." }, "newestPostDate": { "title": "Scrape 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 filter. Only videos uploaded before or on this date will be scraped. Supports absolute date (YYYY-MM-DD) or relative date (e.g. 5 days, 2 weeks)." }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "Tick to exclude pinned posts from profiles. Pinned posts are usually the first videos on a profile's page.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Choose which proxies to use. If TikTok rejects the request, it will automatically fallback to datacenter proxy, then residential proxy 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 } } } } } } } } } }