{ "openapi": "3.0.1", "info": { "title": "Douyin Scraper - Search 抖音 Videos, Creators & Downloads", "description": "Scrape Douyin (抖音) videos by keyword. Export likes, comments, shares, creator profiles, music, hashtags and video tags to JSON/CSV/Excel. Optionally download MP4 videos, covers and slideshow images. No login or proxy needed.", "version": "1.0", "x-build-id": "nrH4bQObVWBcvac3c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vulnv~douyin-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vulnv-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/vulnv~douyin-search-scraper/runs": { "post": { "operationId": "runs-sync-vulnv-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/vulnv~douyin-search-scraper/run-sync": { "post": { "operationId": "run-sync-vulnv-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "🔎 Search keywords", "type": "array", "description": "Add one or more keywords. Chinese, English, hashtags, brand names and emoji all work. Each keyword is searched independently and cross-keyword duplicates are removed automatically.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "📺 Maximum results per keyword", "minimum": 0, "maximum": 2000, "type": "integer", "description": "How many results to fetch for each keyword. Cost scales linearly. Set 0 to fetch all available results.", "default": 100 }, "sort": { "title": "📊 Sort order", "enum": [ "general", "most_liked", "latest" ], "type": "string", "description": "How Douyin orders results. Leave on Relevance for the standard search ranking.", "default": "general" }, "publishTime": { "title": "📅 Published in", "enum": [ "unlimited", "one_day", "one_week", "half_year" ], "type": "string", "description": "Limit results to videos published within this window.", "default": "unlimited" }, "duration": { "title": "⏱️ Video duration", "enum": [ "unlimited", "under_1m", "one_to_five", "over_5m" ], "type": "string", "description": "Limit results to videos in this duration range.", "default": "unlimited" }, "shouldDownloadVideos": { "title": "📥 Download MP4 videos", "type": "boolean", "description": "Save each result's MP4 file to your key-value store. Image-text posts have no MP4 - use Download slideshow images instead. A small share of downloads can fail when a video's CDN URL ages out; those rows still ship with videoFile left null.", "default": false }, "shouldDownloadCovers": { "title": "🖼️ Download cover images", "type": "boolean", "description": "Save each result's cover image (JPEG) to your key-value store.", "default": false }, "shouldDownloadSlideshowImages": { "title": "🎴 Download slideshow images", "type": "boolean", "description": "For image-text posts, save every slide image to your key-value store. Has no effect on plain video posts.", "default": false }, "videoKvStoreName": { "title": "Custom key-value store name", "type": "string", "description": "Save downloaded MP4s, covers and slideshow images to a named, persistent key-value store instead of the run's default one. Useful for archiving and for combining downloads from many runs. Naming rules: lowercase letters, digits and dashes only.", "default": "" } } }, "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 } } } } } } } } } }