# 获取星图达人商业榜数据/Get Ranking List Data

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/xingtu_v2/get_ranking_list_data:
    get:
      summary: 获取星图达人商业榜数据/Get Ranking List Data
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取星图达人商业榜数据

        - qualifier可以从`get_ranking_list_catalog`接口获取

        - 价格：0.002$ / 次

        ### 参数:

        - code: 榜单类型代码
            - 短视频-达人商业榜: 1=品牌优选榜, 2=A3种草榜, 3=看后搜榜, 4=带货榜, 5=投流榜, 6=高潜榜
            - 短视频-达人内容榜: 17=涨粉黑马榜, 18=头部必选榜
            - 直播达人榜-主播类型: 23=游戏主播, 30=其他主播, 37=带货主播 (version=base)
            - 直播达人榜-榜单类型: 23=游戏行业品牌优选榜, 24=非游戏行业品牌优选榜, 25=组件点击榜, 26=下载转化榜, 27=线索收集榜, 28=投流榜, 29=高潜榜
        - qualifier: 榜单分类ID，从`get_ranking_list_catalog`获取

        - version: 版本，`flow_split`=短视频榜单默认，`base`=直播榜单常用

        - period: 统计周期，7=周榜，30=月榜

        - date: 统计日期，格式YYYYMMDD

        ### 返回:

        - 达人商业榜数据


        # [English]

        ### Purpose:

        - Get XingTu creator business ranking list data

        - qualifier can be obtained from `get_ranking_list_catalog` API

        - Price: 0.002$ / time

        ### Parameters:

        - code: Ranking type code
            - Video business ranking: 1=Brand Premium, 2=A3 Seeding, 3=Search After Watch, 4=E-commerce, 5=Ad Flow, 6=High Potential
            - Video content ranking: 17=Follower Growth Dark Horse, 18=Top Must-Pick
            - Live streamer type: 23=Game Streamer, 30=Other Streamer, 37=E-commerce Streamer (version=base)
            - Live ranking type: 23=Game Brand Premium, 24=Non-game Brand Premium, 25=Component Click, 26=Download Conversion, 27=Lead Collection, 28=Ad Flow, 29=High Potential
        - qualifier: Category qualifier_id from `get_ranking_list_catalog`

        - version: `flow_split`=default for video rankings, `base`=commonly used
        for live rankings

        - period: 7=weekly, 30=monthly

        - date: Date, format YYYYMMDD

        ### Return:

        - Creator business ranking data


        # [示例/Example]

        code = 1

        qualifier = "1901"

        version = "flow_split"

        period = 30

        date = "20260131"
      operationId: get_ranking_list_data_api_v1_douyin_xingtu_v2_get_ranking_list_data_get
      tags:
        - Douyin-Xingtu-V2-API
        - Douyin-Xingtu-V2-API
      parameters:
        - name: code
          in: query
          description: 榜单类型代码/Ranking type code
          required: false
          example: 1
          schema:
            type: integer
            description: 榜单类型代码/Ranking type code
            default: 1
            title: Code
        - name: qualifier
          in: query
          description: 榜单分类ID，从get_ranking_list_catalog获取/Category qualifier_id
          required: false
          example: '1901'
          schema:
            type: string
            description: 榜单分类ID，从get_ranking_list_catalog获取/Category qualifier_id
            default: '1901'
            title: Qualifier
        - name: version
          in: query
          description: 版本/Version
          required: false
          example: flow_split
          schema:
            type: string
            description: 版本/Version
            default: flow_split
            title: Version
        - name: period
          in: query
          description: 统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly
          required: false
          example: 30
          schema:
            type: integer
            description: 统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly
            default: 30
            title: Period
        - name: date
          in: query
          description: 统计日期，格式YYYYMMDD/Date, format YYYYMMDD
          required: false
          example: '20260131'
          schema:
            type: string
            description: 统计日期，格式YYYYMMDD/Date, format YYYYMMDD
            default: '20260131'
            title: Date
      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: TJN8UvQrP2gfIsIhUd8cr
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: TJN8UvQrP2gfIsIhUd8cr
            scopes:
              TJN8UvQrP2gfIsIhUd8cr:
                HTTPBearer: []
      x-apifox-folder: Douyin-Xingtu-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-417585618-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-apifox-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-apifox-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-apifox-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: []

```