{ "openapi": "3.0.1", "info": { "title": "Douyin Comment Tracker", "description": "Track Douyin (抖音) video comments on a schedule and export flat CSV / JSON rows — text, author, likes, IP region, timestamps. Delta mode returns only comments new since the last run. Standby HTTP endpoint for one-off lookups. No headless browser. Replies & video metadata with your cookies.", "version": "0.1", "x-build-id": "wWcJmpxh3jcp0zUi2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moonweil~douyin-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moonweil-douyin-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/moonweil~douyin-comments-scraper/runs": { "post": { "operationId": "runs-sync-moonweil-douyin-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/moonweil~douyin-comments-scraper/run-sync": { "post": { "operationId": "run-sync-moonweil-douyin-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", "required": [ "videoUrls" ], "properties": { "videoUrls": { "title": "Douyin video URLs or IDs", "type": "array", "description": "List of Douyin video URLs, share links (v.douyin.com/...), or bare numeric aweme_id values. Share links are resolved to a canonical aweme_id before scraping.", "items": { "type": "string" } }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper bound on top-level comments fetched per video. Replies do not count against this. Capped at 5000.", "default": 100 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also fetch nested reply threads under each top-level comment. REQUIRES the 'cookies' input — Douyin serves the reply endpoint only to logged-in sessions. Without cookies this is skipped (top-level comments are still scraped).", "default": false }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 0, "maximum": 200, "type": "integer", "description": "Upper bound on replies fetched per top-level comment when 'Include replies' is on.", "default": 10 }, "includeVideoMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Emit one row_type=\"video\" row per video with description, author, statistics and music info. Works best with the 'cookies' input — Douyin now gates the video-detail endpoint behind a logged-in session (`uifid`). Without cookies the Actor still tries, and falls back to the page HTML, but may skip metadata; comments are unaffected.", "default": true }, "deltaMode": { "title": "Delta mode (only new comments)", "type": "boolean", "description": "For scheduled monitoring. Reads the highest comment_id seen on the previous run (per video) from the key-value store, stops paginating once it reaches it, and emits only comments newer than that. Writes the new high-water mark at the end.", "default": false }, "deltaStateKey": { "title": "Delta state key", "type": "string", "description": "Key-value store record key that holds delta-mode state. Use the same key across scheduled runs of the same monitoring job. Ignored unless 'Delta mode' is on.", "default": "DOUYIN_DELTA_STATE" }, "cookies": { "title": "Cookie string (optional)", "type": "string", "description": "Optional 'name=value; name=value' cookie string from a logged-in douyin.com session. Raises per-session rate limits and comment visibility. Never required. Do not share this value." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended — datacenter IPs are blocked quickly by Douyin.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum videos scraped in parallel, and the per-host request cap. Higher is faster but more block-prone. Capped at 10.", "default": 3 } } }, "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 } } } } } } } } } }