# Douyin Hot Search Scraper (`blackfalcondata/douyin-scraper`) Actor

Scrape douyin.com real-time trending boards — hot search, seeding, entertainment, social and challenge. Get each trending topic's rank, heat and view count in real time. Incremental mode tags new and changed topics across runs.

- **URL**: https://apify.com/blackfalcondata/douyin-scraper.md
- **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community)
- **Categories:** Social media, Lead generation, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.99 / 1,000 results

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/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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

### What does Douyin Hot Search Scraper do?

Douyin Hot Search Scraper pulls real-time trending boards from [douyin.com](https://douyin.com) (抖音) — Hot Search, Seeding, Entertainment, Social and Challenge. It returns one clean row per trending topic. Each row carries the topic's live rank, peak rank, heat value and view count. It also includes video and discussion counts, category tags, cover images and the moment it started trending. Pick any subset of boards, cap how many topics per board, and optionally track what's new or rising between runs. No login, no tokens, no proxies.

### How to use this actor

- 👉 **Register for a free Apify account** — no credit card required.
- 🎉 Just click **[Sign up free on Apify →](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctarich)** and complete a quick signup.
- 💰 A free Apify account includes $5 in monthly credits — enough to test this actor.
- ⏳ Scrape during the free trial, with no commitment or upfront payment required.

### Key features

<!-- KEY_FEATURES:START -->
- **🔥 All five trending boards** — Hot Search (热点榜), Seeding (种草榜), Entertainment (娱乐榜), Social (社会榜) and Challenge (挑战榜) in one run, or pick any subset.
- **📊 Full trend metrics** — rank, peak rank, heat value, views, video and discussion counts, category tags and event time for every topic.
- **🖼️ Cover images + direct links** — all cover-art mirror URLs plus a ready-to-open Douyin search URL for each topic.
- **♻️ Change tracking** — incremental mode tags each topic NEW / CHANGED / UNCHANGED / EXPIRED, so you see what's rising and what dropped off between runs.
- **🧹 Cross-board dedup** — a topic trending on several boards is returned (and billed) once.
- **📦 Compact mode** — core-fields-only payloads for AI-agent and MCP pipelines.
- **🔔 Notifications** — Telegram, Slack, Discord, WhatsApp and generic webhook out of the box.
- **⚡ Fast & tokenless** — the full ~200-topic trending universe in under 10 seconds; no login, account or proxy.
<!-- KEY_FEATURES:END -->

### What data can you extract from douyin.com?

For every trending topic on each selected board you get: the topic text, its current rank and peak rank, Douyin's heat value, total views, video and discussion counts, category and topic tags, badge, all cover-image mirror URLs, the unix and ISO event time it started trending, the board's snapshot time, Douyin identifiers (sentenceId / groupId), a pinned flag, and a ready-to-open Douyin search URL for the topic.


### Input

Configure the actor through the input schema in Apify Console.

Key parameters:

- **`boards`** — Which trending boards to scrape. Leave empty to scrape all five. (default: `["hot","seeding","entertainment","social","challenge"]`)
- **`maxResultsPerBoard`** — Maximum trending topics to return per board (1–60). Douyin serves roughly 50 topics per board. (default: `50`)
- **`incrementalMode`** — Compare against the previous run and tag each topic NEW / CHANGED / UNCHANGED / EXPIRED. stateKey is optional — is auto-derived from the selected boards and per-board cap. (default: `false`)
- **`compact`** — Core fields only (for AI-agent/MCP workflows). (default: `false`)
- ...and 19 more parameters

### Input examples

**Basic search** — Pick one or more boards from the supported taxonomy.

→ Full payload per result — all standard fields populated where the source provides them.

```json
{
  "boards": [
    "hot"
  ]
}
````

**Incremental tracking** — Only emit listings that changed since the previous run with this `stateKey`.

→ First run builds the baseline state. Subsequent runs emit only records that are new or whose tracked content changed. Set `emitUnchanged: true` to include unchanged records as well.

```json
{
  "boards": [
    "hot"
  ],
  "incrementalMode": true,
  "stateKey": "hot-tracker"
}
```

**Compact output for AI agents** — Return only core fields for AI-agent and MCP workflows.

→ Small payload with the most important fields — ideal for piping into LLMs without token overhead.

```json
{
  "boards": [
    "hot"
  ],
  "compact": true
}
```

### Output

Each run produces a dataset of structured listing records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console.

### Example listing record

```json
{
  "listingId": "ff458d1f0a4e05f06fa3311ad3cd24965310b58243a2afe3702beb4f81b3d638",
  "rank": 0,
  "word": "读懂习近平主席的人工智能千里马之喻",
  "title": "读懂习近平主席的人工智能千里马之喻",
  "board": "Hot Search",
  "boardType": "hot",
  "hotValue": 0,
  "viewCount": 0,
  "discussVideoCount": 1,
  "boardActiveTime": "2026-07-18 17:21:26",
  "sentenceId": "2576120",
  "wordType": 14,
  "label": 0,
  "isPinned": true,
  "url": "https://www.douyin.com/search/%E8%AF%BB%E6%87%82%E4%B9%A0%E8%BF%91%E5%B9%B3%E4%B8%BB%E5%B8%AD%E7%9A%84%E4%BA%BA%E5%B7%A5%E6%99%BA%E8%83%BD%E5%8D%83%E9%87%8C%E9%A9%AC%E4%B9%8B%E5%96%BB",
  "scrapedAt": "2026-07-18T09:22:08.111Z",
  "source": "douyin.com"
}
```

### Incremental fields

When incremental mode is on, each record also carries:

- `changeType` — one of `NEW`, `UPDATED`, `UNCHANGED`, `REAPPEARED`, `EXPIRED`. Default output covers `NEW` / `UPDATED` / `REAPPEARED`; set `emitUnchanged: true` or `emitExpired: true` to opt into the others.
- `isRepost`, `repostOfId`, `repostDetectedAt` — populated when a new listing matches the tracked content of a previously expired one. Set `skipReposts: true` to drop detected reposts from the output.

### How to scrape douyin.com

1. Go to [Douyin Hot Search Scraper](https://apify.com/blackfalcondata/douyin-scraper?fpr=1h3gvi) in Apify Console.
2. Configure the input.
3. Set `maxResults` to control how many results you need.
4. Click **Start** and wait for the run to finish.
5. Export the dataset as JSON, CSV, or Excel.

### Use cases

- Track what's trending in China in real time for social listening, PR and brand monitoring.
- Feed trending topics into content-planning and short-video ideation workflows.
- Monitor a topic's rise and fall across boards over time with incremental runs.
- Power dashboards and alerts on Douyin heat and view metrics.

### How much does it cost to scrape douyin.com?

Douyin Hot Search Scraper uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced.

- **Run start:** $0.0005 per run
- **Per result:** $0.00599 per listing record

Example costs:

- 10 results: **$0.06**
- 25 results: **$0.15**
- 100 results: **$0.6**
- 200 results: **$1.2**
- 500 results: **$3**

#### Example: recurring monitoring savings

These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of listings that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency — the scenarios below are examples, not predictions.

Example setup: 250 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count.

| Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline |
|---|---:|---:|---:|---:|
| 5% — stable niche query | $1.50 | $0.08 | $1.42 (95%) | $2.26 |
| 15% — moderate broad query | $1.50 | $0.23 | $1.27 (85%) | $6.75 |
| 30% — high-volume aggregator | $1.50 | $0.45 | $1.05 (70%) | $13.49 |

Full re-scrape monthly cost at daily polling: $44.94. First month with incremental costs $3.68 / $8.03 / $14.54 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply.

Platform usage is included in the per-result fee shown above.

### FAQ

#### How many results can I get from douyin.com?

The number of results depends on the search query and available listings on douyin.com. Use the `maxResults` parameter to control how many results are returned per run.

#### Does Douyin Hot Search Scraper support recurring monitoring?

Yes. Enable incremental mode to only receive new or changed listings on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset.

#### Can I integrate Douyin Hot Search Scraper with other apps?

Yes. Douyin Hot Search Scraper works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes.

#### Can I use Douyin Hot Search Scraper with the Apify API?

Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages.

#### Can I use Douyin Hot Search Scraper through an MCP Server?

Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode, a single `descriptionFormat`, and `excludeEmptyFields` to keep payloads manageable for LLM context windows.

#### Is it legal to scrape douyin.com?

This actor extracts publicly available data from douyin.com. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant.

#### Your feedback

If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/douyin-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve.

### You might also like

- [Facebook Group Post Scraper](https://apify.com/blackfalcondata/facebook-group-post-scraper?fpr=1h3gvi) — Scrape facebook.com group posts from group URLs with post text, timestamps, engagement counters,.
- [Maigret Username OSINT — Verified Account Finder](https://apify.com/blackfalcondata/maigret-username-osint-scraper?fpr=1h3gvi) — Find where a username or handle exists across hundreds of social media networks and websites. Every.
- [Pexels Scraper — Photos, Videos & Engagement Data](https://apify.com/blackfalcondata/pexels-scraper?fpr=1h3gvi) — This Pexels scraper extracts photos and videos by search, curated feed, photo ID, user, collection,.
- [Quora Scraper — Q\&A, Profiles & Spaces](https://apify.com/blackfalcondata/quora-scraper?fpr=1h3gvi) — \[💰$0.8/1K] Scrape Quora questions, answers, profiles, posts, and spaces by search or URL —.
- [Reddit Email Scraper — Extract Emails from Posts & Comments](https://apify.com/blackfalcondata/reddit-email-scraper?fpr=1h3gvi) — Extract email addresses and contact details from Reddit posts, comments and user profiles. Search.
- [Reddit Lead Scraper — Emails, Socials & Contact Info](https://apify.com/blackfalcondata/reddit-lead-scraper?fpr=1h3gvi) — Turn Reddit into a B2B lead list. Keep only records that expose a contact signal — email, social.
- [Reddit RAG Dataset — LLM Training Data from Posts & Comments](https://apify.com/blackfalcondata/reddit-rag-dataset?fpr=1h3gvi) — Build clean LLM and RAG datasets from Reddit. Export posts with full comment threads as.
- [Reddit Scraper — Posts & Full Comment Threads](https://apify.com/blackfalcondata/reddit-scraper?fpr=1h3gvi) — Scrape Reddit posts with full nested comment threads — or search any subreddit or keyword across.

### Getting started with Apify

New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctarich) — no credit card required.

1. Sign up — $5 platform credit included
2. Open this actor and configure your input
3. Click **Start** — export results as JSON, CSV, or Excel

Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi).

# Actor input Schema

## `boards` (type: `array`):

Which trending boards to scrape. Leave empty to scrape all five.

## `maxResultsPerBoard` (type: `integer`):

Maximum trending topics to return per board (1–60). Douyin serves roughly 50 topics per board.

## `compact` (type: `boolean`):

Core fields only (for AI-agent/MCP workflows).

## `incrementalMode` (type: `boolean`):

Compare against the previous run and tag each topic NEW / CHANGED / UNCHANGED / EXPIRED. stateKey is optional — is auto-derived from the selected boards and per-board cap.

## `stateKey` (type: `string`):

Optional. Stable identifier for the tracked board universe. Leave empty to auto-generate from the selected boards.

## `emitUnchanged` (type: `boolean`):

When incremental, also emit topics whose ranking/heat did not change since the last run.

## `emitExpired` (type: `boolean`):

When incremental, emit a marker row for topics that dropped off a board since the last run.

## `skipReposts` (type: `boolean`):

When incremental, skip topics whose content matches an expired topic from a prior run.

## `telegramToken` (type: `string`):

Telegram bot token (from @BotFather). Required for Telegram notifications.

## `telegramChatId` (type: `string`):

Telegram chat or channel ID (e.g. "-100123456789"). Required when telegramToken is set.

## `discordWebhookUrl` (type: `string`):

Discord incoming webhook URL. Server Settings → Integrations → Webhooks → New Webhook.

## `slackWebhookUrl` (type: `string`):

Slack incoming webhook URL. api.slack.com/messaging/webhooks.

## `notificationLimit` (type: `integer`):

Maximum number of topics included in each notification message (1–20).

## `notifyOnlyChanges` (type: `boolean`):

When Incremental Mode is on, only send notifications for NEW and CHANGED topics. Has no effect outside incremental mode.

## `whatsappAccessToken` (type: `string`):

WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h.

## `whatsappPhoneNumberId` (type: `string`):

Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set.

## `whatsappTo` (type: `string`):

Recipient phone in E.164 format without + (e.g. "436641234567"). Recipient must have messaged your business number within last 24h.

## `webhookUrl` (type: `string`):

Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends.

## `webhookHeaders` (type: `object`):

Optional JSON object of custom headers (e.g. {"Authorization":"Bearer ..."}).

## `descriptionFormat` (type: `string`):

Reserved output-shaping option kept for cross-actor consistency. Douyin topics carry no description body, so this has no effect.

## `excludeEmptyFields` (type: `boolean`):

Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.

## `appConnector` (type: `string`):

Optional. Pick a connected app under Settings → API & Integrations to receive your results. Best-effort across MCP connectors as Apify expands its catalog.

## `mcpIssueTeam` (type: `string`):

Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one.

## Actor input object example

```json
{
  "boards": [
    "hot",
    "seeding",
    "entertainment",
    "social",
    "challenge"
  ],
  "maxResultsPerBoard": 50,
  "compact": false,
  "incrementalMode": false,
  "emitUnchanged": false,
  "emitExpired": false,
  "skipReposts": false,
  "notificationLimit": 5,
  "notifyOnlyChanges": false,
  "descriptionFormat": "all",
  "excludeEmptyFields": false
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "boards": [
        "hot",
        "seeding",
        "entertainment",
        "social",
        "challenge"
    ],
    "maxResultsPerBoard": 50,
    "descriptionFormat": "all",
    "excludeEmptyFields": false
};

// Run the Actor and wait for it to finish
const run = await client.actor("blackfalcondata/douyin-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "boards": [
        "hot",
        "seeding",
        "entertainment",
        "social",
        "challenge",
    ],
    "maxResultsPerBoard": 50,
    "descriptionFormat": "all",
    "excludeEmptyFields": False,
}

# Run the Actor and wait for it to finish
run = client.actor("blackfalcondata/douyin-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 '{
  "boards": [
    "hot",
    "seeding",
    "entertainment",
    "social",
    "challenge"
  ],
  "maxResultsPerBoard": 50,
  "descriptionFormat": "all",
  "excludeEmptyFields": false
}' |
apify call blackfalcondata/douyin-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=blackfalcondata/douyin-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Douyin Hot Search Scraper",
        "description": "Scrape douyin.com real-time trending boards — hot search, seeding, entertainment, social and challenge. Get each trending topic's rank, heat and view count in real time. Incremental mode tags new and changed topics across runs.",
        "version": "0.1",
        "x-build-id": "o5EqzjkzF1nYcmbl7"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/blackfalcondata~douyin-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-blackfalcondata-douyin-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/blackfalcondata~douyin-scraper/runs": {
            "post": {
                "operationId": "runs-sync-blackfalcondata-douyin-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/blackfalcondata~douyin-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-blackfalcondata-douyin-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": {
                    "boards": {
                        "title": "📋 Boards",
                        "type": "array",
                        "description": "Which trending boards to scrape. Leave empty to scrape all five.",
                        "items": {
                            "type": "string",
                            "enum": [
                                "hot",
                                "seeding",
                                "entertainment",
                                "social",
                                "challenge"
                            ],
                            "enumTitles": [
                                "Hot Search (热点榜)",
                                "Seeding (种草榜)",
                                "Entertainment (娱乐榜)",
                                "Social (社会榜)",
                                "Challenge (挑战榜)"
                            ]
                        },
                        "default": [
                            "hot",
                            "seeding",
                            "entertainment",
                            "social",
                            "challenge"
                        ]
                    },
                    "maxResultsPerBoard": {
                        "title": "💯 Max Topics Per Board",
                        "minimum": 1,
                        "maximum": 60,
                        "type": "integer",
                        "description": "Maximum trending topics to return per board (1–60). Douyin serves roughly 50 topics per board.",
                        "default": 50
                    },
                    "compact": {
                        "title": "📦 Compact Output",
                        "type": "boolean",
                        "description": "Core fields only (for AI-agent/MCP workflows).",
                        "default": false
                    },
                    "incrementalMode": {
                        "title": "♻️ Incremental Mode",
                        "type": "boolean",
                        "description": "Compare against the previous run and tag each topic NEW / CHANGED / UNCHANGED / EXPIRED. stateKey is optional — is auto-derived from the selected boards and per-board cap.",
                        "default": false
                    },
                    "stateKey": {
                        "title": "🔑 State Key",
                        "type": "string",
                        "description": "Optional. Stable identifier for the tracked board universe. Leave empty to auto-generate from the selected boards."
                    },
                    "emitUnchanged": {
                        "title": "➡️ Emit Unchanged",
                        "type": "boolean",
                        "description": "When incremental, also emit topics whose ranking/heat did not change since the last run.",
                        "default": false
                    },
                    "emitExpired": {
                        "title": "🗑️ Emit Expired",
                        "type": "boolean",
                        "description": "When incremental, emit a marker row for topics that dropped off a board since the last run.",
                        "default": false
                    },
                    "skipReposts": {
                        "title": "🚫 Skip Reposts",
                        "type": "boolean",
                        "description": "When incremental, skip topics whose content matches an expired topic from a prior run.",
                        "default": false
                    },
                    "telegramToken": {
                        "title": "🔑 Telegram Bot Token",
                        "type": "string",
                        "description": "Telegram bot token (from @BotFather). Required for Telegram notifications."
                    },
                    "telegramChatId": {
                        "title": "💬 Telegram Chat ID",
                        "type": "string",
                        "description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set."
                    },
                    "discordWebhookUrl": {
                        "title": "🎮 Discord Webhook URL",
                        "type": "string",
                        "description": "Discord incoming webhook URL. Server Settings → Integrations → Webhooks → New Webhook."
                    },
                    "slackWebhookUrl": {
                        "title": "💼 Slack Webhook URL",
                        "type": "string",
                        "description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks."
                    },
                    "notificationLimit": {
                        "title": "📊 Max Topics Per Notification",
                        "minimum": 1,
                        "maximum": 20,
                        "type": "integer",
                        "description": "Maximum number of topics included in each notification message (1–20).",
                        "default": 5
                    },
                    "notifyOnlyChanges": {
                        "title": "🔄 Notify Only New/Updated",
                        "type": "boolean",
                        "description": "When Incremental Mode is on, only send notifications for NEW and CHANGED topics. Has no effect outside incremental mode.",
                        "default": false
                    },
                    "whatsappAccessToken": {
                        "title": "📱 WhatsApp Access Token",
                        "type": "string",
                        "description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h."
                    },
                    "whatsappPhoneNumberId": {
                        "title": "📞 WhatsApp Phone Number ID",
                        "type": "string",
                        "description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set."
                    },
                    "whatsappTo": {
                        "title": "📲 WhatsApp Recipient",
                        "type": "string",
                        "description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within last 24h."
                    },
                    "webhookUrl": {
                        "title": "🪝 Generic Webhook URL",
                        "type": "string",
                        "description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends."
                    },
                    "webhookHeaders": {
                        "title": "📋 Webhook Headers",
                        "type": "object",
                        "description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})."
                    },
                    "descriptionFormat": {
                        "title": "Description format",
                        "enum": [
                            "all",
                            "text",
                            "html",
                            "markdown"
                        ],
                        "type": "string",
                        "description": "Reserved output-shaping option kept for cross-actor consistency. Douyin topics carry no description body, so this has no effect.",
                        "default": "all"
                    },
                    "excludeEmptyFields": {
                        "title": "Exclude empty fields from output",
                        "type": "boolean",
                        "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.",
                        "default": false
                    },
                    "appConnector": {
                        "title": "Send results to a connected app",
                        "type": "string",
                        "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results. Best-effort across MCP connectors as Apify expands its catalog."
                    },
                    "mcpIssueTeam": {
                        "title": "Issue tracker team",
                        "type": "string",
                        "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one."
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
