{ "openapi": "3.0.1", "info": { "title": "Douyin 抖éŸŗ Search Scraper", "description": "Scrape Douyin (抖éŸŗ) search results by keyword, hashtag or link, no login or cookies. Get video text, author, music, likes, comments, shares, hashtags and download links. Filter by sort, date and length. Bulk keywords, no duplicates. JSON for trend and market research.", "version": "1.0", "x-build-id": "y080IK5JghHdnkyg2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_wiki~douyin-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_wiki-douyin-search-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/data_wiki~douyin-search-scraper/runs": { "post": { "operationId": "runs-sync-data_wiki-douyin-search-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/data_wiki~douyin-search-scraper/run-sync": { "post": { "operationId": "run-sync-data_wiki-douyin-search-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": { "keywords": { "title": "🔍 Search keywords", "type": "array", "description": "One keyword per line. Chinese or English words, hashtags (for example #įžŽéŖŸ), brand names and emoji all work. Each keyword is searched separately and the same video is only saved once across keywords. Bulk input is supported.", "items": { "type": "string" } }, "urls": { "title": "🌍 Douyin search links", "type": "array", "description": "Optional. Paste Douyin search links (so.douyin.com/s?keyword=â€Ļ or www.douyin.com/search/â€Ļ); the keyword inside each link is searched. Plain words on a line are treated as keywords. Combined with the keywords above, duplicates are skipped.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "📊 Max videos per keyword", "minimum": 0, "maximum": 2000, "type": "integer", "description": "How many videos to collect for each keyword (0 to 2000). 0 collects everything Douyin returns.", "default": 10 }, "sort": { "title": "🏆 Sort by", "enum": [ "general", "most_liked", "latest" ], "type": "string", "description": "Order of the results: Douyin's default relevance, most liked first, or newest first.", "default": "general" }, "publishTime": { "title": "📆 Posted within", "enum": [ "unlimited", "one_day", "one_week", "half_year" ], "type": "string", "description": "Only videos posted inside this period. Videos outside it are left out.", "default": "unlimited" }, "duration": { "title": "âŗ Video length", "enum": [ "unlimited", "under_1m", "one_to_five", "over_5m" ], "type": "string", "description": "Only videos of this length. Videos outside it are left out.", "default": "unlimited" }, "maxConcurrency": { "title": "🚀 Keywords at the same time", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many keywords are searched in parallel (1 to 10). Lower it if you see many slow-downs.", "default": 2 }, "maxRetries": { "title": "🔁 Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a failed or blocked request is retried (0 to 10).", "default": 3 }, "maxScanned": { "title": "🧮 Max videos checked per keyword", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Safety cap on how many videos are looked at per keyword while matching your filters (0 = no cap). The search stops for that keyword when it is reached.", "default": 20000 }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Choose how requests are routed. If a request is blocked, the Actor switches to another connection automatically.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }