# Douyin Profile & Keyword Scraper (`agentflow/douyin-profile-search-scraper`) Actor Scrape Douyin video data from profile URLs and search keywords using a browser interception approach. - **URL**: https://apify.com/agentflow/douyin-profile-search-scraper.md - **Developed by:** [AgentFlow](https://apify.com/agentflow) (community) - **Categories:** Social media - **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $3.00 / 1,000 item-scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Douyin Profile & Keyword Scraper Scrape Douyin video data from: - Creator profile pages (`/user/...`) - Search keywords (`/search/...`) This Actor uses a browser interception strategy: 1. Parse first-screen data from `RENDER_DATA` 2. Intercept Douyin XHR responses while scrolling to capture more videos Implementation stack: - `Crawlee PlaywrightCrawler` (official Apify/Crawlee browser component) - `SessionPool` + retries - Optional `proxyConfiguration` (Apify Proxy or your own proxy) - Session warmup + cookie pool binding ### Input ```json { "profileUrls": [ "https://www.douyin.com/user/MS4wLjABAAAAa5_5w7d9T5XUaB_qY9yW1A8y2a-R1hC_4xK8W8X2qGg" ], "searchKeywords": [ "AI工具" ], "maxItemsPerSource": 30, "maxScrollRounds": 8, "scrollDelayMs": 1800, "navigationTimeoutMs": 60000, "maxConcurrency": 1, "maxRequestRetries": 3, "sessionMaxUsageCount": 10, "enableWarmup": true, "warmupUrls": [ "https://www.douyin.com/", "https://www.douyin.com/hot" ], "warmupDelayMs": 1200, "warmupNavigationTimeoutMs": 45000, "headless": true, "includeRawAweme": false, "forceChinaProxy": true, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" }, "cookie": "msToken=...; ttwid=...; passport_csrf_token=...", "cookiePool": [ "msToken=...; ttwid=...;", "msToken=...; ttwid=...;" ] } ```` ### Output fields Each dataset item contains normalized fields, including: - `awemeId`, `desc`, `createTimestamp`, `createTimeIso` - `durationMs`, `playUrl`, `playUrlNoWatermark` - `diggCount`, `commentCount`, `collectCount`, `shareCount` - `author` object - `music` object - `hashtags` - `sources` (one or multiple source hits for the same video) ### Pricing recommendation (PPE) Code already emits the billing event: - Event name: `item-scraped` - Event count: number of unique `awemeId` in one run You can set final PPE unit price in Apify Console. ### Notes - Profile mode usually works with valid public profile links. - Keyword mode may trigger Douyin `verify_check` / captcha depending on IP reputation. - On Apify cloud, use residential CN proxy (`proxyConfiguration`) whenever possible. - If captcha still appears, use `cookie` or `cookiePool`. - `cookiePool` is session-bound (one cookie per crawler session), better than a single cookie for long runs. - When verification is hit, the run summary will show keyword source failure explicitly. # Actor input Schema ## `profileUrls` (type: `array`): List of Douyin profile URLs. Example: https://www.douyin.com/user/MS4wLjABAAAA... ## `searchKeywords` (type: `array`): List of Douyin search keywords. Example: AI工具, 跨境电商, 爆款选品. ## `maxItemsPerSource` (type: `integer`): Maximum number of videos to keep for each profile URL or keyword. ## `maxScrollRounds` (type: `integer`): How many scroll rounds to perform to trigger more API responses. ## `scrollDelayMs` (type: `integer`): Delay in milliseconds between scroll rounds. ## `navigationTimeoutMs` (type: `integer`): Maximum page navigation timeout per source. ## `maxConcurrency` (type: `integer`): Parallel browser pages. Keep low for Douyin anti-bot stability. ## `maxRequestRetries` (type: `integer`): How many retries to run on blocked/failed requests. ## `sessionMaxUsageCount` (type: `integer`): How many requests a crawler session can be reused before rotation. ## `enableWarmup` (type: `boolean`): Open warmup pages once per session before scraping each source. ## `warmupUrls` (type: `array`): Pages used for session warmup before scraping source pages. ## `warmupDelayMs` (type: `integer`): Delay after each warmup page load. ## `warmupNavigationTimeoutMs` (type: `integer`): Navigation timeout used for warmup pages. ## `headless` (type: `boolean`): Run browser in headless mode. Disable only for debugging. ## `includeRawAweme` (type: `boolean`): Include original raw aweme payload in each output item. ## `proxyConfiguration` (type: `object`): Recommended for cloud runs. Douyin often blocks datacenter IPs and requires residential proxy. ## `forceChinaProxy` (type: `boolean`): If true and using Apify proxy without country set, auto-set country to CN. ## `cookie` (type: `string`): Optional raw Cookie header from a real logged-in Douyin web session. Helps reduce captcha risk. ## `cookiePool` (type: `array`): Optional list of raw cookie strings. Actor binds one cookie to each session. ## Actor input object example ```json { "profileUrls": [ "https://www.douyin.com/user/MS4wLjABAAAAXTHbW60Q4K0cQ2WVWgYvE33ixusssYFX4n55a7lBjuQ" ], "searchKeywords": [ "AI工具" ], "maxItemsPerSource": 30, "maxScrollRounds": 8, "scrollDelayMs": 1800, "navigationTimeoutMs": 60000, "maxConcurrency": 1, "maxRequestRetries": 3, "sessionMaxUsageCount": 10, "enableWarmup": true, "warmupUrls": [ "https://www.douyin.com/", "https://www.douyin.com/hot" ], "warmupDelayMs": 1200, "warmupNavigationTimeoutMs": 45000, "headless": true, "includeRawAweme": false, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" }, "forceChinaProxy": true } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "profileUrls": [ "https://www.douyin.com/user/MS4wLjABAAAAXTHbW60Q4K0cQ2WVWgYvE33ixusssYFX4n55a7lBjuQ" ], "searchKeywords": [ "AI工具" ], "warmupUrls": [ "https://www.douyin.com/", "https://www.douyin.com/hot" ], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" } }; // Run the Actor and wait for it to finish const run = await client.actor("agentflow/douyin-profile-search-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "profileUrls": ["https://www.douyin.com/user/MS4wLjABAAAAXTHbW60Q4K0cQ2WVWgYvE33ixusssYFX4n55a7lBjuQ"], "searchKeywords": ["AI工具"], "warmupUrls": [ "https://www.douyin.com/", "https://www.douyin.com/hot", ], "proxyConfiguration": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "CN", }, } # Run the Actor and wait for it to finish run = client.actor("agentflow/douyin-profile-search-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "profileUrls": [ "https://www.douyin.com/user/MS4wLjABAAAAXTHbW60Q4K0cQ2WVWgYvE33ixusssYFX4n55a7lBjuQ" ], "searchKeywords": [ "AI工具" ], "warmupUrls": [ "https://www.douyin.com/", "https://www.douyin.com/hot" ], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" } }' | apify call agentflow/douyin-profile-search-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=agentflow/douyin-profile-search-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Douyin Profile & Keyword Scraper", "description": "Scrape Douyin video data from profile URLs and search keywords using a browser interception approach.", "version": "1.0", "x-build-id": "KGZ7OI3ru1rn7heSw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agentflow~douyin-profile-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agentflow-douyin-profile-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/agentflow~douyin-profile-search-scraper/runs": { "post": { "operationId": "runs-sync-agentflow-douyin-profile-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/agentflow~douyin-profile-search-scraper/run-sync": { "post": { "operationId": "run-sync-agentflow-douyin-profile-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": { "profileUrls": { "title": "Douyin Profile URLs", "type": "array", "description": "List of Douyin profile URLs. Example: https://www.douyin.com/user/MS4wLjABAAAA...", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "List of Douyin search keywords. Example: AI工具, 跨境电商, 爆款选品.", "items": { "type": "string" } }, "maxItemsPerSource": { "title": "Max videos per source", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of videos to keep for each profile URL or keyword.", "default": 30 }, "maxScrollRounds": { "title": "Max scroll rounds per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many scroll rounds to perform to trigger more API responses.", "default": 8 }, "scrollDelayMs": { "title": "Scroll delay (ms)", "minimum": 200, "maximum": 10000, "type": "integer", "description": "Delay in milliseconds between scroll rounds.", "default": 1800 }, "navigationTimeoutMs": { "title": "Navigation timeout (ms)", "minimum": 5000, "maximum": 180000, "type": "integer", "description": "Maximum page navigation timeout per source.", "default": 60000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel browser pages. Keep low for Douyin anti-bot stability.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "How many retries to run on blocked/failed requests.", "default": 3 }, "sessionMaxUsageCount": { "title": "Session max usage count", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many requests a crawler session can be reused before rotation.", "default": 10 }, "enableWarmup": { "title": "Enable session warmup", "type": "boolean", "description": "Open warmup pages once per session before scraping each source.", "default": true }, "warmupUrls": { "title": "Warmup URLs", "type": "array", "description": "Pages used for session warmup before scraping source pages.", "items": { "type": "string" } }, "warmupDelayMs": { "title": "Warmup delay (ms)", "minimum": 200, "maximum": 10000, "type": "integer", "description": "Delay after each warmup page load.", "default": 1200 }, "warmupNavigationTimeoutMs": { "title": "Warmup navigation timeout (ms)", "minimum": 3000, "maximum": 120000, "type": "integer", "description": "Navigation timeout used for warmup pages.", "default": 45000 }, "headless": { "title": "Headless browser", "type": "boolean", "description": "Run browser in headless mode. Disable only for debugging.", "default": true }, "includeRawAweme": { "title": "Include raw aweme object", "type": "boolean", "description": "Include original raw aweme payload in each output item.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Recommended for cloud runs. Douyin often blocks datacenter IPs and requires residential proxy." }, "forceChinaProxy": { "title": "Force CN country on Apify proxy", "type": "boolean", "description": "If true and using Apify proxy without country set, auto-set country to CN.", "default": true }, "cookie": { "title": "Douyin cookie (optional)", "type": "string", "description": "Optional raw Cookie header from a real logged-in Douyin web session. Helps reduce captcha risk." }, "cookiePool": { "title": "Cookie pool (optional)", "type": "array", "description": "Optional list of raw cookie strings. Actor binds one cookie to each session.", "items": { "type": "string" } } } }, "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 } } } } } } } } } } ```