{
  "openapi": "3.0.1",
  "info": {
    "title": "China Hot Search API – Douyin Hot Search, Weibo, Baidu, Zhihu",
    "description": "Chinese hot search API, China trending topics, no login: Douyin hot search, Weibo hot search, Baidu hot search, Zhihu hot list (抖音热搜/微博热搜/百度热搜/知乎热榜), Kuaishou, Toutiao, Bilibili popular/hot search, Tencent News, Douban hot movies, Maoyan box office, Tieba, 36Kr, ThePaper, ITHome, Hupu. $0.003/trend.",
    "version": "2.1",
    "x-build-id": "MWQvttV8CHaJiIaW0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/deadc0dex~china-hot-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-deadc0dex-china-hot-search",
        "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/deadc0dex~china-hot-search/runs": {
      "post": {
        "operationId": "runs-sync-deadc0dex-china-hot-search",
        "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/deadc0dex~china-hot-search/run-sync": {
      "post": {
        "operationId": "run-sync-deadc0dex-china-hot-search",
        "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": {
          "operation": {
            "title": "Operation (hot lists, news articles, box office, cross-platform clusters)",
            "enum": [
              "auto",
              "hot_lists",
              "news_articles",
              "box_office",
              "trend_clusters",
              "capabilities"
            ],
            "type": "string",
            "description": "auto (default) = urls -> news_articles, dates -> box_office, otherwise hot_lists (empty boards = 10 default boards). hot_lists = trend rows from boards in rank order. news_articles = full text of 36Kr / ThePaper / IT之家 hot articles or given urls. box_office = Maoyan China box office per film (dates for past days). trend_clusters = topics trending on 2+ platforms (free cluster rows + billed member rows). capabilities = free list of boards, fields, prices.",
            "default": "auto"
          },
          "boards": {
            "title": "Boards (hot lists / platforms)",
            "type": "array",
            "description": "Board ids or platform names. Empty = douyin_hot, weibo_hot, baidu_realtime, zhihu_hot, toutiao_hot, bilibili_popular, kuaishou_hot, douban_movie_hot, maoyan_boxoffice, kr36_hot. Also: douyin_trending, baidu_novel/movie/teleplay/car/livelihood/finance/game, bilibili_ranking, bilibili_hot_search (B站热搜), douban_showing/tv_hot/top250, tieba_hot, thepaper_hot, ithome_rank (ITHome), hupu_hot, tencent_news_hot, sina_hot. Names douyin, weibo, baidu, zhihu, tencent, sina… = main board; all = every board.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keyword watchlist (filter)",
            "type": "array",
            "description": "Keep only rows whose title/excerpt contains any keyword (case-insensitive). English names are also matched in Chinese when expandQuery is on (Huawei -> 华为, BYD -> 比亚迪). Matched keywords are in matchedKeywords. Example: [\"AI\", \"华为\", \"Tesla\"].",
            "items": {
              "type": "string"
            }
          },
          "urls": {
            "title": "Article URLs (36Kr, ThePaper, IT之家)",
            "type": "array",
            "description": "Article links for news_articles (full text as Markdown): https://www.36kr.com/p/<id>, https://www.thepaper.cn/newsDetail_forward_<id>, https://www.ithome.com/0/<nnn>/<nnn>.htm (m. links too). Board page links (https://s.weibo.com/top/summary, https://top.baidu.com/board?tab=realtime, https://www.zhihu.com/hot, https://www.douyin.com/hot …) are fetched as that board. Other links return an INVALID_URL row (free).",
            "items": {
              "type": "string"
            }
          },
          "dates": {
            "title": "Box office dates (YYYY-MM-DD)",
            "type": "array",
            "description": "Past days for box_office (Maoyan keeps the last 365 days, China time), e.g. [\"2026-10-01\"]. Empty = real-time today. Each date = one board fetch.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max billable rows in total",
            "type": "integer",
            "description": "Total cap on trend + news rows (1-5000, default 200). Free rows (cluster, error, summary) do not count.",
            "default": 200
          },
          "maxItemsPerInput": {
            "title": "Max rows per board",
            "type": "integer",
            "description": "Rows per board, counted after filters (1-100, default 20; news_articles default 5 articles per board). Boards hold 5-100 rows (most 30-50)."
          },
          "fields": {
            "title": "Return only these fields",
            "type": "array",
            "description": "Projection: keep only these fields (type, operation, input, queryUsed, id, url, fetchedAt are always kept outside lean). Names: platform, board, rank, title, heat, heatText, label, labelEn, excerpt, author, publishedAt, viewCount, commentCount, rankChange, isNew, boxOfficeToday, bodyMarkdown… (all: operation capabilities). Empty = outputMode default.",
            "items": {
              "type": "string"
            }
          },
          "include": {
            "title": "Include extras",
            "type": "array",
            "description": "Optional extras: \"clusters\" = free cluster rows grouping the same topic across platforms (after the trend rows); \"body\" = Markdown article body on news rows (always on for news_articles). Example: [\"clusters\"].",
            "items": {
              "type": "string"
            }
          },
          "outputMode": {
            "title": "Output mode",
            "enum": [
              "compact",
              "full",
              "lean",
              "table"
            ],
            "type": "string",
            "description": "compact (default) = core fields, excerpt cut to 200 chars. full = every field (image urls, search url, source primary/fallback, all box-office and delta fields). lean = fewest tokens: platform, rank, title, heat, url, rankChange; empty values dropped. table = flat CSV-safe rows, same columns on every row, arrays joined with |.",
            "default": "compact"
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "rank",
              "heat",
              "rankChange"
            ],
            "type": "string",
            "description": "rank (default) = board order, then rank (rows stream as boards arrive). heat = highest platform heat first across boards. rankChange = biggest climbers first (needs deltaKey).",
            "default": "rank"
          },
          "minHeat": {
            "title": "Minimum heat",
            "type": "integer",
            "description": "Drop rows whose heat is below this number (rows without a heat value are dropped too). Heat = the platform's own popularity number (hot value, 热度, views, reads, box office CNY)."
          },
          "excludePinned": {
            "title": "Exclude pinned and ad rows",
            "type": "boolean",
            "description": "Drop pinned (置顶, rank 0) and sponsored rows (Weibo 商 ads, Douyin 商). Default false: they are kept and flagged with isPinned / isAd.",
            "default": false
          },
          "deltaKey": {
            "title": "Delta memory key (rank change, only-new)",
            "type": "string",
            "description": "Any short name, e.g. \"brand-watch\". Remembers ranks in a named key-value store in your account: rows get isNew, previousRank, rankChange (+ = moved up), heatChange, peakRank, firstSeenAt, minutesOnBoard. Topics unseen for 72 h are forgotten. The summary row adds leftBoard: topics that dropped off a board since the previous run (free)."
          },
          "onlyNew": {
            "title": "Only new topics",
            "type": "boolean",
            "description": "With deltaKey: return (and bill) only topics not seen in earlier runs with the same key. Ideal for scheduled monitoring. Without deltaKey the key \"default\" is used.",
            "default": false
          },
          "maxCostUsd": {
            "title": "Max cost (USD)",
            "type": "number",
            "description": "Stop before this run's row charges exceed the amount (rows so far stay valid; a free BUDGET_REACHED row explains it). The platform's max total charge per run is respected too."
          },
          "dryRun": {
            "title": "Dry run (free cost estimate)",
            "type": "boolean",
            "description": "Return free plan rows (boards, estimated rows and cost) and a summary; nothing is fetched or billed.",
            "default": false
          },
          "expandQuery": {
            "title": "Expand English keywords to Chinese",
            "type": "boolean",
            "description": "Match English names in Chinese too (offline dictionary: Huawei -> 华为, Xiaomi -> 小米, box office -> 票房). The Chinese term used is in queryUsed.",
            "default": true
          },
          "dedupe": {
            "title": "Drop the same title across boards",
            "type": "boolean",
            "description": "Keep only the first row of an identical title (after removing # and punctuation). Use include [\"clusters\"] instead to keep all rows and link them.",
            "default": false
          },
          "leanFormat": {
            "title": "Lean table (TSV) record",
            "enum": [
              "json",
              "table"
            ],
            "type": "string",
            "description": "json (default) = rows only. table = also save all rows as one tab-separated table (key-value record LEAN_TABLE; copied into the summary row when < 20 KB). Fewest tokens for LLMs.",
            "default": "json"
          },
          "maxTextChars": {
            "title": "Max text characters",
            "type": "integer",
            "description": "Cut excerpt / summary / bodyMarkdown to this many characters (0 = no cut). Default: 300 in lean mode, none otherwise (compact cuts excerpt at 200)."
          },
          "dateFrom": {
            "title": "Box office from date",
            "type": "string",
            "description": "box_office: first day of a range (YYYY-MM-DD, max 31 days with dateTo)."
          },
          "dateTo": {
            "title": "Box office to date",
            "type": "string",
            "description": "box_office: last day of a range (YYYY-MM-DD)."
          },
          "proxyConfiguration": {
            "title": "Proxy (fallback only)",
            "type": "object",
            "description": "Not needed: every board works directly. If set (e.g. {\"useApifyProxy\": true}), the proxy is used only after direct attempts to a board fail."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}