ライブ配信検索
概要
クリエイターの unique_id、nickname、または ライブ配信タイトル でライブ配信を検索します。以下の機能をサポートします。
- あいまい検索に対応
- フィルターパラメータの設定が可能
- カスタムソート順に対応
API エンドポイント
bash
POST /live/v1/searchリクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
keywords | string | いいえ | 検索キーワード |
filter | object | いいえ | フィルターパラメータ |
orderby | object | いいえ | ソートパラメータ |
page | integer | いいえ | ページ番号, デフォルト: 1 |
pagesize | integer | いいえ | 1ページあたりの件数, デフォルト: 10 |
lang | string | いいえ | 言語設定, 英語(デフォルト): EN_US, 中国語: ZH_CN |
page*pagesize<= 5000
pagesize範囲 [1,100]
keywords 詳細
- 最大長:
120文字 - デフォルト: 空文字列
filter オプション値
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
region | string | いいえ | 国/地域 |
creator_category | integer | いいえ | クリエイターカテゴリ |
product_category | integer | いいえ | 商品カテゴリ(レベル1) |
live_type | integer | いいえ | ライブ配信タイプ: 1 (ショップ), 2 (クリエイター) |
follower_range | object | いいえ | フォロワー数範囲, 例: {'min': 1000, 'max': 10000} |
viewer_range | object | いいえ | 視聴者数範囲, 例: {'min': 100, 'max': 1000} |
sold_range | object | いいえ | 販売数範囲, 例: {'min': 100, 'max': 1000} |
start_time | timestamp[integer] | いいえ | 開始時間範囲, 例: {'min': 1742977367, 'max': 1742977367} |
region 範囲:
['US','GB','MX','ES','DE','IT','FR','PT','NL','BE','AT','PL','ID','VN','MY','TH','PH','BR','JP','SG']
orderby オプション値
| フィールド | 必須 | 説明 |
|---|---|---|
start_time | いいえ | 開始時間(降順) |
total_viewer_count | いいえ | 総視聴者数(降順) |
total_units_sold | いいえ | 販売数(降順) |
total_gmv | いいえ | 総売上(降順) |
リクエスト例
bash
curl 'https://openapi.fastmoss.com/live/v1/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxxx' \
--data '{
"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
}'レスポンスボディ
data.list
| フィールド | 型 | 説明 |
|---|---|---|
uid | string | クリエイターUID |
nickname | string | クリエイターのニックネーム |
unique_id | string | クリエイターのユニークID |
follower_count | integer | クリエイターのフォロワー数 |
creator_region | string | クリエイターの地域 |
room_id | string | ライブルームID |
title | string | ライブ配信タイトル |
cover | string | ライブ配信カバーURL |
start_time | integer | 開始時間(タイムスタンプ) |
end_time | integer | 終了時間(タイムスタンプ) |
duration | integer | 再生時間(秒) |
product_count | integer | 掲載商品数 |
total_viewer_count | integer | 総視聴者数 |
total_units_sold | integer | 総販売数 |
total_gmv | float | 総売上 |
currency | string | 通貨 |
uv_value | float | UV価値 |
レスポンス例
json
{
"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
}
]
}
}