# 获取直播间商品列表数据/Get live room product list data

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/tiktok/app/v3/fetch_live_room_product_list:
    get:
      summary: 获取直播间商品列表数据/Get live room product list data
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取直播间商品列表数据

        ### 参数:

        - room_id: 直播间id，必填参数。

        - author_id: 主播id，必填参数。

        - page_size: 每页数量，可选参数，默认为15。

        - offset: 翻页游标，可选参数，默认为0，每次翻页增加15。

        - region: 地区，可选参数，默认为`US`，如果使用其他地区，如：`VN`，请自行携带Cookie，否则无法获取数据。

        - cookie: 用户自己的cookie，可选参数，用于爬取除`US`以外的地区数据。

        ### 参数获取:

        -
        第一步：使用接口`f"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id"`接口获取直播间id（room_id）。

        -
        第二步：使用接口`f"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info"`接口获取直播间信息。

        -
        第三步：使用第二步返回的JSON数据中使用JSONPATH获取`$.data.data.owner.id_str`字段的值作为主播id（author_id）。

        ### 返回:

        - 直播间商品列表数据


        # [English]

        ### Purpose:

        - Get live room product list data

        ### Parameters:

        - room_id: Live room id, required parameter.

        - author_id: Anchor id, required parameter.

        - page_size: Number per page, optional parameter, default is 15.

        - offset: Page turning cursor, optional parameter, default is 0,
        increasing by 15 each time.

        - region: Region, optional parameter, default is `US`, if you use other
        regions, such as: `VN`, please bring your own Cookie, otherwise you will
        not be able to get data.

        - cookie: User's own cookie, optional parameter, used to crawl data from
        regions other than `US`.

        ### Get Parameters:

        - Step 1: Use the interface
        `f"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id"` to get the live
        room id (room_id).

        - Step 2: Use the interface
        `f"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info"` to get
        the live room information.

        - Step 3: Use the JSONPATH in the JSON data returned in the second step
        to get the value of the field `$.data.data.owner.id_str` as the anchor
        id (author_id).

        ### Return:

        - Live room product list data


        # [示例/Example]

        room_id = "7420741353250507562"

        author_id = "7408859677050274859"

        page_size = 15

        offset = 0
      operationId: >-
        fetch_live_room_product_list_api_v1_tiktok_app_v3_fetch_live_room_product_list_get
      tags:
        - TikTok-App-V3-API
        - TikTok-App-V3-API
      parameters:
        - name: room_id
          in: query
          description: 直播间id/Live room id
          required: true
          example: '7420741353250507562'
          schema:
            type: string
            description: 直播间id/Live room id
            title: Room Id
        - name: author_id
          in: query
          description: 主播id/Anchor id
          required: true
          example: '7408859677050274859'
          schema:
            type: string
            description: 主播id/Anchor id
            title: Author Id
        - name: page_size
          in: query
          description: 数量/Number
          required: false
          schema:
            type: integer
            description: 数量/Number
            default: 15
            title: Page Size
        - name: offset
          in: query
          description: 数量/Number
          required: false
          schema:
            type: integer
            description: 数量/Number
            default: 0
            title: Offset
        - name: region
          in: query
          description: 地区/Region
          required: false
          schema:
            type: string
            description: 地区/Region
            default: US
            title: Region
        - name: cookie
          in: query
          description: 用户自己的cookie/User's own cookie
          required: false
          schema:
            type: string
            description: 用户自己的cookie/User's own cookie
            default: ''
            title: Cookie
      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: QNd1Fs8iMRQIODkYperWb
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: QNd1Fs8iMRQIODkYperWb
            scopes:
              QNd1Fs8iMRQIODkYperWb:
                HTTPBearer: []
      x-apifox-folder: TikTok-App-V3-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-220126023-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: []

```