Live Stream Search

Introduction

Search for live streams using a creator's unique_id, nickname, or live stream title, with the following features:

• Supports fuzzy search
• Supports filtering parameters
• Supports custom result sorting

API Endpoint

    POST /live/v1/search

Request Body

Field	Type	Required	Description
keywords	string	No	Search keywords
filter	object	No	Filter parameters
orderby	object	No	Sorting parameters
page	integer	No	Page number, default: 1
pagesize	integer	No	Items per page, default: 10
search_after	array	No	Deep pagination parameter, mutually exclusive with the page parameter. When the total number of paginated query results exceeds 60,000, this parameter needs to be used. The value for the next page should be taken from data.sort of the previous page's results.
lang	string	No	Language Settings Supported Languages, English(Default)：EN_US Indonesian： ID_ID Japanese：JA_JP Thai：TH_TH Vietnamese：VI_VN Spanish：ES_ES French：FR_FR Portuguese：PT_BR Chinese：ZH_CN

keywords Details

• Maximum length: 120 characters
• Default: Empty string

filter Optional Values

Field	Type	Required	Description
region	string	No	Country/Region, e.g., ['US', 'GB', 'MX', 'ES', 'ID', 'VN', 'MY', 'TH', 'PH']
creator_category	integer	No	Creator category
product_category	integer	No	Product category (Level 1)
live_type	integer	No	Live stream type: 1 (Shop), 2 (Creator)
follower_range	object	No	Follower range, e.g., {'min': 1000, 'max': 10000}
viewer_range	object	No	Viewer range, e.g., {'min': 100, 'max': 1000}
sold_range	object	No	Sales range, e.g., {'min': 100, 'max': 1000}
start_time	timestamp[integer]	No	Start time range, e.g., {'min': 1742977367, 'max': 1742977367}

orderby Optional Values

Field	Required	Description
start_time	No	Start time (desc)
total_viewer_count	No	Total viewers (desc)
total_units_sold	No	Sales volume (desc)
total_gmv	No	Total revenue (desc)

Request Example

Using page and pageSize for pagination
curl 'https://openapi.test.fastmoss.com/live/v1/search?client_id=XXX&timestamp=XXX&access_token=XXX&sign=XXX' \
--header 'Content-Type: application/json' \
{
    "keywords": "daisycabral_",
    "filter": {
        "region": "US",
        follower_range: {
            "min": 1000,
            "max": 10000
        },
        "product_category": 1,
        "live_type": 1,
        "start_time": {
            "min": 1742977367,  
            "max": 1742987367
        },
    },
     "orderby": [
      {
        "field": "start_time",
        "order": "desc",
      }
    ],
    "page": 1,
    "pagesize": 10
}

Deep Pagination
curl 'https://openapi.test.fastmoss.com/live/v1/search?client_id=XXX&timestamp=XXX&access_token=XXX&sign=XXX' \
--header 'Content-Type: application/json' \
{
    "keywords": "daisycabral_",
    "filter": {
        "region": "US",
        follower_range: {
            "min": 1000,
            "max": 10000
        },
        "product_category": 1,
        "live_type": 1,
        "start_time": {
            "min": 1742966585,  
            "max": 1742976585
        },
    },
    "orderby": [
      {
        "field": "start_time",
        "order": "desc",
      }
    ],
    "search_after": [43500000],
    "pagesize": 10
}

Response Body

data.has_more

• Type：integer
• Description: Indicates whether there is a next page of data, 1 for yes, 0 for no

data.list

Field	Type	Description
uid	string	Creator UID
nickname	string	Creator nickname
unique_id	string	Creator unique ID
follower_count	integer	Creator follower count
creator_region	string	Creator region
room_id	string	Live stream room ID
title	string	Live stream title
cover	string	Live stream cover URL
start_time	integer	Start time (timestamp)
end_time	integer	End time (timestamp)
duration	integer	Duration (seconds)
product_count	integer	Number of products listed
total_viewer_count	integer	Total viewer count
total_units_sold	integer	Total units sold
total_gmv	float	Total revenue
currency	string	Currency
uv_value	float	UV value

data.sort Type arraySort Value

• When using search_after for deep pagination, to go to the next page, you need to pass the value returned from the previous page.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "has_more": 1,
    "list": [
      {
        "uid": "123456",
        "unique_id": "hello",
        "nickname": "hello",
        "follower_count": 123,
        "creator_region": "US",
        "room_id": "12341234",
        "title": "welcome",
        "cover": "https://aaa.com/sss.jpeg",
        "start_time": 123412341,
        "end_time": 1234123412,
        "duration": 12342,
        "product_count": 12,
        "total_viewer_count": 1234,
        "total_units_sold": 123,
        "total_gmv": 1234,
        "currency": "USD",
        "uv_value": 1234
      }
    ],
    "sort": [
      20600000
    ]
  }
}