Shop Related Live Stream List

Introduction

Retrieve the live stream list data related to a specified shop.

Endpoint

    POST /shop/v1/liveList

Request Body

Field	Type	Required	Description
filter	object	No	Filter parameters
orderby	array	No	Sorting parameters
page	integer	No	Default: 1
pagesize	integer	No	Default: 10

filter Optional Values

Field	Type	Required	Description
seller_id	string	No	Shop ID
creator_uid	string	No	Creator UID associated with the shop
creator_unique_id	string	No	Unique Creator ID associated with the shop: @xxxxxxx
seller_name	string	No	Shop Name
region	string	No	Country/Region of the shop

seller_name and region must be passed at the same time

orderby Optional Values

Field	Required	Description
start_time	No	Start Time
product_count	No	Number of products in the live room
total_user_count	No	Total number of viewers
units_sold	No	Sales Volume
gmv	No	Sales Amount (GMV)

Request Example

curl 'https://openapi.fastmoss.com/shop/v1/liveList' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
    "filter": {
        "seller_id": "7495500842223700917",
        # "creator_uid": "6913013214088004614",
        # "creator_unique_id": "caffeinecandleschaos",

        # "seller_name": "Caffeine, Candles & Chaos",
        # "region": "US",
    },
    "orderby": [{
        "field": "start_time",
        "order": "desc"
    }],
    # "orderby": [{
    #     "field": "product_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "total_user_count",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "units_sold",
    #     "order": "desc"
    # }],
    # "orderby": [{
    #     "field": "gmv",
    #     "order": "desc"
    # }],
    "page": 1,
    "pagesize": 10
}'

Response Body

data.list

Field	Type	Description
title	string	Live room title
room_id	string	Live room ID
seller_id	string	Shop ID
uid	string	Creator UID associated with the shop
cover	string	Cover Image URL
main_category_name	string	Main promoted category name
main_category_id	int	Main promoted category ID
start_time	int	Start Time
units_sold	int	Sales Volume
gmv	float	Sales Amount (GMV)
product_count	int	Number of products in the live room
total_user	int	Total number of viewers
duration	int	Live duration (seconds)
max_user_count	int	Maximum concurrent viewers
inc_follower_count	int	Follower growth
share_count	int	Number of shares
is_live	int	Is currently live
live_type	int	Live type 1: Shop live 2: Individual live
creator	object	Associated creator information

data.list.creator

Field	Type	Description
uid	string	User ID
nickname	string	User Nickname
unique_id	string	User Unique ID
avatar	string	User Avatar URL
region	string	User Country/Region
follower_count	int	User Follower Count
category_id	int	User Category ID
category_name	string	User Category Name

data.total

Field	Type	Description
total	string	Total number of records

Response Example

{
  "code": 0,
  "data": {
    "total": 11943,
    "list": [
      {
        "title": "Food and snacks",
        "room_id": "7539139975317703438",
        "cover": "https://s.500fd.com/tt_live/7411364270883588910~tplv-obj.image",
        "main_category_id": 24,
        "main_category_name": "Food & Beverages",
        "creator": {
          "uid": "73083231876554752",
          "avatar": "https://s.500fd.com/tt_author/5aa17bc74b4fd2b91ae364d2a2c6e4d6~tplv-tiktokx-cropcenter:1080:1080.jpeg",
          "region": "US",
          "nickname": "Courtney Luper 🗝️✨",
          "unique_id": "courtneyluper",
          "follower_count": 17183,
          "category_id": 5,
          "category_name": "Food & Beverage"
        },
        "start_time": 1755343248,
        "units_sold": 1939,
        "gmv": 4253.69,
        "product_count": 99,
        "total_user": 84333,
        "duration": 37159,
        "max_user_count": 430,
        "inc_follower_count": 243,
        "share_count": 188,
        "is_live": 0,
        "live_type": 2
      }
    ]
  },
  "message": "success",
  "timestamp": 1773751121,
  "request_id": "76d984e2-e0f8-d04c-dc2d-c1fc9a18ffda"
}