# Douyin Total Hot Billboard API

> Returns Douyin total hot list billboard entries across specified time ranges. Supports filtering by snapshot type, keyword, category tags, and date range with pagination controls.

Source: https://www.sandbase.ai/model/douyin/billboard/hot-total-list
API reference: https://www.sandbase.ai/model/douyin/billboard/hot-total-list/docs

## Facts

- Provider: Douyin
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-list`
- Price: $0.0015 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, douyin
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-list` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `page` | integer | yes |  |
| `page_size` | integer | yes |  |
| `type` | string | yes |  |
| `end_date` | string | no |  |
| `keyword` | string | no |  |
| `sentence_tag` | string | no |  |
| `snapshot_time` | string | no |  |
| `start_date` | string | no |  |

## FAQ

### How do I use the Douyin Total Hot Billboard API?

Send a POST request to https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-list with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the Douyin Total Hot Billboard API cost?

$0.0015 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the Douyin Total Hot Billboard API accept?

Required: page (integer), page_size (integer) and type (string). Optional: end_date (string), keyword (string), sentence_tag (string), snapshot_time (string) and start_date (string). The Parameters table and the Playground on this page list every field.

### What does the Douyin Total Hot Billboard API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a Douyin developer account or API key?

No. Douyin Total Hot Billboard runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Douyin API access separately.

## README

### Douyin Total Hot Billboard API

Look up overall trending search rankings on Douyin using `type`, `page`, and `page_size`. Filter results by `keyword`, `sentence_tag`, or snapshot date ranges.

#### Use cases

- Track overall trending search rankings on Douyin across specific dates.
- Filter trending billboard topics by category tag or keyword.
- Monitor historical hot search snapshots over designated time ranges.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-list" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page": "<page>", "page_size": "<page_size>", "type": "<type>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `page` | integer | Yes | Page number |
| `type` | string | Yes | Snapshot type snapshot view by time range view by time range. |
| `page_size` | integer | Yes | Number of items per page |
| `keyword` | string | No | Hot search term |
| `end_date` | string | No | Snapshot end time format yyyyMMdd |
| `start_date` | string | No | Snapshot start time format yyyyMMdd |
| `sentence_tag` | string | No | Hot category tag, get from hot list category, multiple categories separated by commas, empty for all |
| `snapshot_time` | string | No | Snapshot time format yyyyMMddHHmmss |

#### Notes

- Format `start_date` and `end_date` as `yyyyMMdd`, and `snapshot_time` as `yyyyMMddHHmmss`.
- Supply comma-separated category tags in `sentence_tag`, or leave it empty to return all categories.
- Paging requires both `page` and `page_size`.

#### Related APIs

- [Douyin Billboard City List](/model/douyin/billboard/city-list): Returns the list of Chinese cities supported by Douyin billboard rankings.
- [Douyin Billboard Vertical Content Tags](/model/douyin/billboard/content-tag): Returns a list of vertical content tags available on the Douyin billboard platform.
- [Douyin Fan Interest Account List](/model/douyin/billboard/hot-account-fans-interest-account-list): Returns a list of 20 accounts that followers of a target creator are interested in on Douyin.