{ "openapi": "3.0.1", "info": { "title": "Douyin Pro Scraper", "description": "Five-mode Douyin (China TikTok) scraper: keyword search, video detail, user profile + uploads, hashtag feed, hot search board. Returns caption, author, plays, likes, comments, shares, collects, cover, video URL, publish time, music. No login. For China trend research, KOL discovery, AI training.", "version": "0.1", "x-build-id": "jfsdO3BifiFIDy2HO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/habit.zhou~douyin-pro-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-habit.zhou-douyin-pro-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/habit.zhou~douyin-pro-scraper/runs": { "post": { "operationId": "runs-sync-habit.zhou-douyin-pro-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/habit.zhou~douyin-pro-scraper/run-sync": { "post": { "operationId": "run-sync-habit.zhou-douyin-pro-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": [ "mode" ], "properties": { "mode": { "title": "Scrape mode", "enum": [ "search", "videos", "user", "hashtag", "hot" ], "type": "string", "description": "What to pull from Douyin.", "default": "search" }, "keywords": { "title": "Search keywords (search mode)", "uniqueItems": true, "type": "array", "description": "Search queries. Chinese or English both work.", "items": { "type": "string" } }, "sortType": { "title": "Sort type (search mode)", "enum": [ "_0", "_1", "_2" ], "type": "string", "description": "Sort criterion for search results.", "default": "_0" }, "publishTime": { "title": "Publish time filter (search mode)", "enum": [ "_0", "_1", "_7", "_180" ], "type": "string", "description": "Filter by recency.", "default": "_0" }, "videoIds": { "title": "Video IDs or URLs (videos mode)", "type": "array", "description": "Aweme IDs (numeric) or full https://www.douyin.com/video/ URLs. Short v.douyin.com links also accepted.", "default": [], "items": { "type": "string" } }, "secUserIds": { "title": "User sec_uids (user mode)", "type": "array", "description": "Opaque sec_uid strings from Douyin profile URLs (https://www.douyin.com/user/). Looks like 'MS4wLjABAAAA...'.", "default": [], "items": { "type": "string" } }, "hashtagIds": { "title": "Hashtag challenge IDs (hashtag mode)", "type": "array", "description": "Numeric Douyin challenge IDs (ch_id). Pull from hashtag URLs: douyin.com/hashtag/.", "default": [], "items": { "type": "string" } }, "maxItemsPerInput": { "title": "Max items per input", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap per keyword / user / hashtag. Each item is one billed result.", "default": 50 }, "fetchComments": { "title": "Also fetch top comments per video", "type": "boolean", "description": "When on, fetches up to 20 top comments per video (videos mode only). Extra cost per video.", "default": false } } }, "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 } } } } } } } } } }