Twitchチャンネルを検索

Twitchチャンネルに対してキーワード検索を実行し、一致するチャンネルを配信状態とメタデータ付きでページ単位で返します。

POST/api/v1/twitch/search/channels

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

リクエストパラメータ

必須パラメータ

名前	位置	型	説明
`query`	body	string	Search query example: string

任意パラメータ

名前	位置	型	説明
`live_only`	body	boolean	Only search live channels example: true
`first`	body	integer	Maximum number of items per page. Minimum 1, maximum 100, default 20 example: 0
`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/channels

Authorization

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

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

JSONボディ

cURL の例

bash

curl -X POST "https://openapi.scdata.cc/api/v1/twitch/search/channels" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"string","live_only":true,"first":0,"after":"string"}'

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

json

{
  "success": true,
  "code": 200,
  "message": "Request successful",
  "data": {
    "more": true,
    "offset": "string",
    "data": [
      {
        "id": "string",
        "broadcaster_language": "string",
        "broadcaster_login": "string",
        "display_name": "string",
        "game_id": "string",
        "game_name": "string",
        "is_live": true,
        "tags": [
          "string"
        ],
        "thumbnail_url": "string",
        "title": "string",
        "started_at": "2019-08-24T14:15:22.123Z"
      }
    ]
  }
}

ユースケース

配信者の発掘 — 名前やタイトルに特定の製品カテゴリやコミュニティを含むチャンネルを探します。
言語別の人選 — 地域キャンペーン向けに配信言語で結果を絞り込みます。