{ "openapi": "3.0.1", "info": { "title": "TikTok Comments Scraper | CommentScout", "description": "Scrape TikTok comments and replies from public video URLs. Export comment text, authors, likes and timestamps to CSV, Excel or JSON. Includes deduplication, collection limits and optional comment-export analysis.", "version": "0.1", "x-build-id": "Vcwbpwo8A4D1Ysx3T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrapelab~tiktok-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrapelab-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/thescrapelab~tiktok-comments-scraper/runs": { "post": { "operationId": "runs-sync-thescrapelab-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/thescrapelab~tiktok-comments-scraper/run-sync": { "post": { "operationId": "run-sync-thescrapelab-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": "TikTok video URLs or IDs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public TikTok video URLs, short TikTok URLs, or raw numeric video IDs.", "items": { "type": "string" } }, "maxCommentsPerVideo": { "title": "Max top-level comments per video", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum top-level comments collected per video. For supplied exports, maximum records scanned across the run. Replies have their own limit.", "default": 1 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Collect replies under the comments retrieved in this run. The Console starter allows up to three replies per comment. JSON/API clients can set maxRepliesPerComment explicitly; its existing API default remains zero. Replies use the same per-row price as top-level comments.", "default": false }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of replies to collect below each top-level comment when Include replies is enabled.", "default": 0 }, "maxSecondsPerVideo": { "title": "Max seconds per video", "minimum": 0, "maximum": 604800, "type": "integer", "description": "Optional soft time limit for each video. Use this on large multi-video runs to prevent one high-comment video from consuming the whole run. Set to 0 for no per-video limit.", "default": 90 }, "useResidentialProxy": { "title": "Use residential proxy (advanced)", "type": "boolean", "description": "Use paid residential proxy traffic for difficult or blocked public videos. Leave off for the low-cost default; the Actor otherwise uses Apify's automatic datacenter proxy routing.", "default": false }, "cookieHeader": { "title": "Account cookies (inactive)", "type": "string", "description": "Retained for API compatibility. Ignored: collection uses anonymous public access only." }, "jobName": { "title": "Resumable collection job (optional)", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "maxLength": 64, "type": "string", "description": "Reuse this name with the same videos and collection settings to continue confirmed work. Run one writer per name. Creates retained storage; omit for ordinary single-run collection." }, "providedRecords": { "title": "Your records (JSON)", "type": "array", "description": "Optional existing comments to validate, deduplicate and analyze instead of fetching TikTok. Leave empty for live collection. Use either JSON records or a dataset ID.", "items": { "type": "object" } }, "providedDatasetId": { "title": "Your Apify dataset ID", "type": "string", "description": "Optional 17-character ID of a dataset you can access. Clear the JSON records to [] when using a dataset. Only a bounded number of records is read." }, "analysisQuery": { "title": "Find a phrase in an uploaded export", "type": "string", "description": "Optional literal phrase to find when processing supplied comment records. Does not filter live scraping results." } } }, "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 } } } } } } } } } }