{ "openapi": "3.0.1", "info": { "title": "🎵 Douyin Content Scraper", "description": "Extract Douyin content data — likes, plays, author, and more. Scrape by keyword, URL or ID. Export to JSON, CSV & Excel, use the API, schedule runs and integrate. No code required.", "version": "0.1", "x-build-id": "InriclkvJ7DDSs0KB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ethereal_wool~douyin-content-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ethereal_wool-douyin-content-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/ethereal_wool~douyin-content-scraper/runs": { "post": { "operationId": "runs-sync-ethereal_wool-douyin-content-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/ethereal_wool~douyin-content-scraper/run-sync": { "post": { "operationId": "run-sync-ethereal_wool-douyin-content-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search Douyin videos for. Each keyword is searched and paginated independently. Chinese keywords return the most results.", "default": [ "美食" ], "items": { "type": "string" } }, "userIds": { "title": "User sec_user_id list", "type": "array", "description": "Douyin sec_user_id values (the long 'MS4wLjAB...' id from a profile URL or share link) whose posted videos you want to scrape.", "default": [], "items": { "type": "string" } }, "awemeIds": { "title": "Video IDs (for comments)", "type": "array", "description": "Douyin video IDs (aweme_id, the numeric id in a video URL). The Actor scrapes the comments of each of these videos and pushes one item per comment.", "default": [], "items": { "type": "string" } }, "includeHotSearch": { "title": "Include hot-search trending list", "type": "boolean", "description": "Also scrape the current Douyin hot-search (热榜) trending list and push one item per trending word.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum total number of items to scrape across all keywords, users, comment sets, and the trending list.", "default": 50 }, "sortType": { "title": "Sort order (search only)", "enum": [ "_0", "_1", "_2" ], "type": "string", "description": "How to sort keyword-search results.", "default": "_0" }, "publishTime": { "title": "Publish time filter (search only)", "enum": [ "_0", "_1", "_7", "_180" ], "type": "string", "description": "Restrict keyword-search results to videos published within a recent window.", "default": "_0" }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum top-level comments to fetch per video ID in the Video IDs (comments) mode.", "default": 50 }, "downloadVideos": { "title": "Download watermark-free MP4s", "type": "boolean", "description": "Download each video's watermark-free MP4 into the key-value store and add a `downloads.videoFile` link to the item. Billed as a separate pay-per-event add-on.", "default": false }, "downloadCovers": { "title": "Download cover images", "type": "boolean", "description": "Download each video's cover/thumbnail image into the key-value store (`downloads.coverFile`).", "default": false }, "downloadSlideshow": { "title": "Download 图文 slideshow images", "type": "boolean", "description": "For image-text (图文) posts, download every slide into the key-value store (`downloads.slideFiles`).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Route the upstream API calls through an Apify Proxy to vary the source IP. Usually not needed.", "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 } } }, "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 } } } } } } } } } }