{ "openapi": "3.0.1", "info": { "title": "Douyin Scraper - Hot Topics, Videos, Comments & Creator Leads", "description": "Scrape Douyin (抖音) without a login: the live hot board, videos with EXACT engagement counts (not rounded), comments with the commenter's province, Douyin's own content categories, and ranked creator/KOL leads with exact followers. No browser. Export CSV/JSON.", "version": "0.1", "x-build-id": "5GlLz4RhX2LyonHYM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~douyin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-douyin-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/scrapesage~douyin-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-douyin-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/scrapesage~douyin-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-douyin-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": { "mode": { "title": "What to scrape", "enum": [ "hot", "topic", "video", "creators", "discover" ], "type": "string", "description": "hot = the live Douyin hot-topic board (fastest, no seeds needed). topic = every video under the hot topics. video = full detail for the video URLs you supply. creators = creator / KOL lead list. discover = crawl outwards from seed videos through Douyin's related-video rails.", "default": "hot" }, "videoUrls": { "title": "Douyin video URLs or IDs", "type": "array", "description": "Video links such as https://www.douyin.com/video/7665177181298937122, or bare video IDs. Used by the video and discover modes. Leave empty to seed from the live hot board instead.", "items": { "type": "string" } }, "topicUrls": { "title": "Douyin hot-topic URLs", "type": "array", "description": "Hot topic links such as https://www.douyin.com/hot/2580433/... . Leave empty to use whatever is trending right now.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 0, "type": "integer", "description": "Stop after this many records. Set to 0 for no limit (the run-time budget still applies).", "default": 50 }, "hotTopicLimit": { "title": "Hot topics to use", "minimum": 1, "maximum": 60, "type": "integer", "description": "How many trending topics to read from the hot board (max 60).", "default": 25 }, "videosPerTopic": { "title": "Videos per topic", "minimum": 1, "maximum": 40, "type": "integer", "description": "How many videos to take from each hot topic in topic / creators mode.", "default": 6 }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Nest the top comments inside each video record, with the commenter's province, exact like count and reply threading. Charged per comment.", "default": true }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 0, "maximum": 60, "type": "integer", "description": "Douyin's public page exposes roughly 10-12 comments per video (top comments plus visible replies). Values above that simply return what exists.", "default": 20 }, "discoverDepth": { "title": "Discover depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "How many hops to follow through the related-video rails in discover mode.", "default": 1 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. The default is deliberately polite; raising it does not usually make a run faster.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used for ONE request per video only. Douyin serves the page carrying the exact engagement counts and its own content category to residential IPs only - everything else (hot board, video pages, comments, creators) is fetched directly and needs no proxy. Turn this off and the run still succeeds, just with rounded engagement numbers and no category.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }