# Douyin High Completion Rate Billboard API

> Returns Douyin billboard rankings for videos with high completion rates. Filter results by search keyword, category tags, time window, and pagination settings.

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

## Facts

- Provider: Douyin
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-high-play-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-high-play-list` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `date_window` | integer | no |  |
| `keyword` | string | no |  |
| `page` | integer | no |  |
| `page_size` | integer | no |  |
| `tags` | array | no |  |

## FAQ

### How do I use the Douyin High Completion Rate Billboard API?

Send a POST request to https://api.sandbase.ai/v1/api/douyin/billboard/hot-total-high-play-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 High Completion Rate 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 High Completion Rate Billboard API accept?

No parameters are required. Optional: date_window (integer), keyword (string), page (integer), page_size (integer) and tags (array). The Parameters table and the Playground on this page list every field.

### What does the Douyin High Completion Rate Billboard API return?

A JSON response returned in the same HTTP request (synchronous). The README on this page includes a sample response.

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

No. Douyin High Completion Rate 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 High Completion Rate Billboard API

Retrieve top-performing Douyin videos with high completion rates. Filter rankings using `keyword`, category `tags`, and `date_window`.

#### Use cases

- Discover high-retention Douyin videos across specific categories.
- Monitor top viral content trends within hourly or daily time windows.
- Track audience engagement metrics and follow rates for benchmark analysis.

#### Request

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

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `page` | integer | No | Page number |
| `tags` | array | No | Sub-level vertical category tag, empty for all, multiple tags need to be passed in |
| `keyword` | string | No | Search keyword to filter the billboard, empty for all |
| `page_size` | integer | No | Number of items per page |
| `date_window` | integer | No | Time window, 1 by hour 2 by day |

#### Example response

Real response for the request above, trimmed to the main fields. User names and long IDs are masked.

```json
{
  "data": {
    "objs": [
      {
        "fans_cnt": 1597,
        "favorite_id": 0,
        "follow_cnt": 2072,
        "follow_rate": 0.000136,
        "image_cnt": 0,
        "item_cover_url": "https://p26-sign.douyinpic.com/tos-cn-p-0015c000-ce/ooeXGE3JA1yInDW1HQnii2FYEBlf…",
        "item_duration": 9000,
        "item_id": "7692743433555444923",
        "item_title": "小孩哥你认错人了#牵错人的尴尬",
        "item_url": "https://v26-cold.douyinvod.com/dc00f5f449521a9a0c4973b396e08ae3/6ac4fa14/video/t…"
      }
    ]
  }
}
```

#### Notes

- Use `date_window` to set the time window (1 for hourly, 2 for daily).
- Filter rankings by category with `tags` or by search term using `keyword`.
- Control pagination with `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.
