# Get the hot board

Returns hot.douyin.com's main board, either as a point-in-time snapshot or aggregated over a date range.

- Platform: Douyin V2
- Request: `GET https://api.toolzerhub.com/v2/douyin/billboard/hot`
- Auth: `x-api-key` header
- Cost: 2 credits per successful request. Failed requests are not billed.
- Page: https://docs.toolzerhub.com/reference/douyin-v2/billboard/get-douyin-billboard-hot

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `page` | query | no | integer | Page number starting at 1. Default: 1. |
| `page_size` | query | no | integer | Items per page. Default: 10. |
| `range_type` | query | no | enum: snapshot, range | snapshot reads the board as it stood at one moment, range aggregates across a date range. Default: snapshot. |
| `snapshot_time` | query | no | string | Moment to read the board at, as yyyyMMddHHmmss. Used when range_type is snapshot. |
| `start_date` | query | no | string | Range start as yyyyMMdd. Used when range_type is range. |
| `end_date` | query | no | string | Range end as yyyyMMdd. Used when range_type is range. |
| `tag` | query | no | string | Comma-separated hot-topic category tags, from the billboard categories endpoint. |
| `keyword` | query | no | string | Optional term to filter the list by. |

## Example request

```bash
curl "https://api.toolzerhub.com/v2/douyin/billboard/hot" \
  -H "x-api-key: $TOOLZERHUB_API_KEY"
```

Success responses are wrapped as `{ "data": ... }`. Errors return `{ "error": { "code", "status", "message", "retryable", "details" } }`. See https://docs.toolzerhub.com/docs/responses-and-errors.