Twitchライブ配信を検索

フィルタに一致するライブ配信を視聴者数順で返し、タイトル、ゲーム、配信者情報を含みます。

POST/api/v1/twitch/search/live

クォータ消費: このエンドポイントへの成功したリクエスト 1 件あたり、プランのクォータが 1 単位消費されます。

リクエストパラメータ

必須パラメータ

このエンドポイントに必須パラメータはありません。

任意パラメータ

名前	位置	型	説明
`user_id`	body	object	User ID example: string
`user_login`	body	object	User login name example: string
`game_id`	body	object	Game (category) ID example: string
`type`	body	object	Stream type filter for the live list. Possible values: all, live; default all example: string
`language`	body	object	Language example: string
`first`	body	integer	Page size, maximum 100, default 20 example: 0
`before`	body	object	Previous page cursor example: string
`after`	body	object	Next page cursor example: string

レスポンスフィールド

名前	型	説明
`success`	boolean	Success
`code`	integer	Code
`message`	string	Message
`data`	object	-
`data.more`	boolean	Has more
`data.offset`	string	offset
`data.data`	array<object>	data

お試し実行

リクエストURL

https://openapi.scdata.cc/api/v1/twitch/search/live

Authorization

ダッシュボードのAPIキーを選択

リクエストを送信する前にAPIキーを入力してください。ダッシュボードを開く

JSONボディ

cURL の例

bash

curl -X POST "https://openapi.scdata.cc/api/v1/twitch/search/live" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"string","user_login":"string","game_id":"string","type":"string","language":"string","first":0,"before":"string","after":"string"}'

レスポンス例 (200 application/json)

json

{
  "success": true,
  "code": 200,
  "message": "Request successful",
  "data": {
    "more": true,
    "offset": "string",
    "data": [
      {
        "id": "string",
        "user_id": "string",
        "user_login": "string",
        "user_name": "string",
        "game_id": "string",
        "game_name": "string",
        "type": "string",
        "title": "string",
        "viewer_count": 0,
        "started_at": "2019-08-24T14:15:22.123Z",
        "language": "string",
        "thumbnail_url": "string",
        "tags": [
          "string"
        ],
        "is_mature": true
      }
    ]
  }
}

ユースケース

リアルタイムの機会発見 — 新作ゲームを今配信している人を確認し、関心が高いうちに連絡します。
ライブダッシュボード — 社内モニター画面にカテゴリ内の上位ライブチャンネルを表示します。