一致するTwitchカテゴリをID、名前、ボックスアートとともに返します。IDはライブ検索・チャンネル検索エンドポイントで使用します。
POST
/api/v1/twitch/search/categoriesクォータ消費: このエンドポイントへの成功したリクエスト 1 件あたり、プランのクォータが 1 単位消費されます。
リクエストパラメータ
必須パラメータ
| 名前 | 位置 | 型 | 説明 |
|---|---|---|---|
query | body | string | Search query example: string |
任意パラメータ
| 名前 | 位置 | 型 | 説明 |
|---|---|---|---|
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 |
お試し実行
https://openapi.scdata.cc/api/v1/twitch/search/categories
ダッシュボードのAPIキーを選択
リクエストを送信する前にAPIキーを入力してください。ダッシュボードを開く
JSONボディ
cURL の例
bash
curl -X POST "https://openapi.scdata.cc/api/v1/twitch/search/categories" \-H "Authorization: YOUR_API_KEY" \-H "Content-Type: application/json" \-d '{"query":"string","first":0,"after":"string"}'
レスポンス例 (200 application/json)
json
{"success": true,"code": 200,"message": "Request successful","data": {"more": true,"offset": "string","data": [{"box_art_url": "string","id": 0,"name": "string"}]}}
ユースケース
- ゲーム別ターゲティング — そのゲームを配信する配信者を探す前に、ゲーム名をカテゴリIDに解決します。
- カテゴリ補完 — 社内ツールのカテゴリ選択UIに補完候補を提供します。