# 获取热点总榜/Fetch total hot list

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/billboard/fetch_hot_total_list:
    get:
      summary: 获取热点总榜/Fetch total hot list
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取热点总榜

        ### 参数:

        - page: 页码

        - page_size: 每页数量

        - type: 快照类型 snapshot 按时刻查看 range 按时间范围。
            - 备注：snapshot_time 在 snapshot时有效，start_date 和 end_date 在 range 时有效
        - snapshot_time: 快照时间 格式yyyyMMddHHmmss

        - start_date: 快照开始时间 格式yyyyMMdd

        - end_date: 快照结束时间 格式yyyyMMdd

        - sentence_tag: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部

        - keyword: 热点搜索词

        ### 返回:

        - 热点总榜


        # [English]

        ### Purpose:

        - Get the total hot list

        ### Parameters:

        - page: Page number

        - page_size: Number of items per page

        - type: Snapshot type snapshot view by time range view by time range.
            - Note: snapshot_time is valid when snapshot, start_date and end_date are valid when range
        - snapshot_time: Snapshot time format yyyyMMddHHmmss

        - start_date: Snapshot start time format yyyyMMdd

        - end_date: Snapshot end time format yyyyMMdd

        - sentence_tag: Hot category tag, get from hot list category, multiple
        categories separated by commas, empty for all

        - keyword: Hot search term

        ### Return:

        - Total hot list
      operationId: fetch_hot_total_list_api_v1_douyin_billboard_fetch_hot_total_list_get
      tags:
        - Douyin-Billboard-API
        - Douyin-Billboard-API
      parameters:
        - name: page
          in: query
          description: 页码
          required: true
          example: 1
          schema:
            type: integer
            description: 页码
            title: Page
        - name: page_size
          in: query
          description: 每页数量
          required: true
          example: 10
          schema:
            type: integer
            description: 每页数量
            title: Page Size
        - name: type
          in: query
          description: 快照类型 snapshot 按时刻查看 range 按时间范围
          required: true
          schema:
            type: string
            description: 快照类型 snapshot 按时刻查看 range 按时间范围
            examples:
              - snapshot
              - range
            title: Type
        - name: snapshot_time
          in: query
          description: 快照时间 格式yyyyMMddHHmmss
          required: false
          schema:
            type: string
            description: 快照时间 格式yyyyMMddHHmmss
            default: '20250106151500'
            title: Snapshot Time
        - name: start_date
          in: query
          description: 快照开始时间 格式yyyyMMdd
          required: false
          schema:
            type: string
            description: 快照开始时间 格式yyyyMMdd
            default: ''
            title: Start Date
        - name: end_date
          in: query
          description: 快照结束时间 格式yyyyMMdd
          required: false
          schema:
            type: string
            description: 快照结束时间 格式yyyyMMdd
            default: ''
            title: End Date
        - name: sentence_tag
          in: query
          description: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部
          required: false
          schema:
            type: string
            description: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部
            default: ''
            title: Sentence Tag
        - name: keyword
          in: query
          description: 热点搜索词
          required: false
          schema:
            type: string
            description: 热点搜索词
            default: ''
            title: Keyword
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: ZMNnn3Br4820F0T0olhah
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: ZMNnn3Br4820F0T0olhah
            scopes:
              ZMNnn3Br4820F0T0olhah:
                HTTPBearer: []
      x-apifox-folder: Douyin-Billboard-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-252393839-run
components:
  schemas:
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            This response is cached and accessible via the URL below for 24
            hours at no extra cost. The cache is for request tracing only — it
            doesn't affect the API's data freshness and won't be returned
            through the API again.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x--orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x--ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x--orders:
        - detail
      x--ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x--orders:
        - loc
        - msg
        - type
      x--ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```