Twitch公開データAPI
既知の公開Twitchユーザー名から正規化されたプロフィールや公開動画の一覧を取得したり、クリップ1件をダウンロード可能な動画とともに取得したりでき、クリエイター調査、カタログの情報補完、比較、スナップショットのモニタリングに活用できます。
利用できるTwitch API
正規化されたアカウント情報にはTwitch Profile APIを、対応する種類・並び順のフィルターで公開動画を1ページ分取得するにはTwitch User Videos APIを、クリップURLから公開クリップを1件取得するにはTwitch Clip Downloader APIを使用します。
取得できるTwitchデータ
TwitchのAPIカタログは、ユーザー名から正規化された公開アカウントのレコード1件または正規化された公開動画1ページ分を、クリップURLから公開クリップ1件を返します。取得元が値を提供しないフィールドは null になります。
プロフィール情報
取得可能なアカウントID、公開URL、ユーザー名、表示名、プロフィール文を取得します。
プロフィールの表示要素
取得可能なプロフィール画像、カバー画像、関連するWebサイトのフィールドを保持します。
アカウントのシグナル
null になりうる認証済み・非公開のフラグを、欠けている値を推測せずにそのまま読み取ります。
表示中のアカウント数値
取得可能なフォロワー数・フォロー数・投稿数を collected_at とあわせて保持し、特定時点での比較に活用できます。
公開ユーザー動画
取得元の1ページ分から、動画ID、クリエイターのコンテキスト、メディア、再生時間、公開日時、表示中のエンゲージメントを取得します。
公開クリップ
クリップのタイトル、再生数、長さ、作成日時、配信者、ダウンロードできるMP4リンクとサムネイルを取得します。
SocQ vs Twitch API
SocQは、公開プロフィール、ユーザー動画、クリップの取得を正規化されたタスクワークフローで提供します。認可されたアプリケーション連携やチャンネル操作には、TwitchネイティブのAPIと認証が適しています。
| 機能 | SocQ | Twitch API |
|---|---|---|
| 主な用途 | 公開プロフィールの取得、ユーザー動画1ページ分の取得、またはクリップ1件の取得 | Twitchリソースを中心としたネイティブなTwitch連携の構築 |
| 認証 | SocQのAPIキー | Twitchアプリケーションと、該当するユーザーまたはアプリの認可 |
| 入力の起点 | ユーザー名1件(クリップはクリップURL1件) | ネイティブのリクエストパラメータとTwitchのリソースID |
| チャンネル管理 | 非対応 | 必要な権限を持つ認可済みのTwitch APIを使用 |
| レスポンス形式 | 正規化されたSocQの AccountItem または ReelVideoItem レコード | Twitch独自のレスポンスオブジェクト |
Twitch APIの仕組み
すべてのTwitch APIが、SocQ共通の非同期タスクと保存済み結果の取得ワークフローを使用します。
1. エンドポイントを選ぶ
有効な公開ユーザー名を1件 /v1/twitch/profile または /v1/twitch/user-videos に、またはクリップURLを1件 /v1/twitch/clip にPOSTし、task_id を保存します。
2. タスクを追跡
タスクが成功または失敗するまで /v1/tasks/{task_id} をポーリングします。
3. 保存済みのレコードを読み取る
data.results.items からプロフィールまたは動画のレコードを取得し、取得時点のコンテキストを保持します。
SocQのAPIキーで認証し、対応するユーザー名を1件だけ送信します。成功したタスクは一律0.19クレジットです。
curl -X POST "https://api.socq.ai/v1/twitch/profile" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username":"ninja"}'
# Poll GET /v1/tasks/{task_id}
# Read the normalized account in data.results.itemsTwitch APIの主なユースケース
クリエイター情報の補完
既知のクリエイターのレコードに、取得可能なTwitchのアカウント情報、プロフィール文、画像、Webサイト、アカウントのフラグ、公開数値を追加します。
ハンドルの解決
公開プロフィールを社内の調査エンティティに紐づける前に、送信したユーザー名を解決します。
アカウントの比較
別々に取得したプロフィールを、null になりうる共通のアカウント情報と指標のフィールドで比較します。
スナップショットのモニタリング
公開プロフィールの値とともに collected_at を保持し、後の取得結果と区別できるスナップショットとして管理します。
動画一覧の情報補完
既知のチャンネルに、公開動画のID、メディア、クリエイターのコンテキスト、再生時間、タイムスタンプ、表示中のエンゲージメントを紐づけます。
ハイライトのアーカイブ
クリップのMP4をタイトル、配信者、作成日時と一緒に保存し、チャンネルの名場面を検索できるライブラリにまとめます。
制限事項と公開データポリシー
Twitchのエンドポイントは、公開プロフィール、ユーザー動画、クリップを照会する読み取り専用のAPIです。認証が必要なチャンネル操作や視聴者メンバーのデータは提供しません。
- ProfileとUser Videosで受け付けるのはユーザー名1件のみです。チャンネルURL、ユーザー名のリスト、results_limit は受け付けません。
- Twitch Clip Downloaderは twitch.tv/<channel>/clip/<slug> または clips.twitch.tv/<slug> 形式のクリップURLを1件受け付けます。返されるMP4リンクは署名付きで、約1日で失効します。
- ユーザー名は先頭に@を1つ付けることができ、それ以外は1〜64文字のASCII英字、数字、ドット、アンダースコア、ハイフンで構成する必要があります。
- プロフィールの照会では、取得元のプロフィールオブジェクトを最大1件返します。User Videosは取得元の1ページ分を取得し、呼び出し側で制御するカーソルや results_limit は受け付けません。
- 公開ソースデータが取得できない場合、プロフィールのアカウント情報、画像、Webサイト、フラグ、所在地、個々の指標は null になることがあります。
- このエンドポイントは、ログイン、配信・投稿、モデレーション、チャンネル管理、非公開の分析データの取得、OAuthで認可されたアカウント操作は行いません。
Twitch APIに関するよくある質問
Twitch APIとは何ですか?
Twitch APIは、非同期タスクを使って、既知の公開ユーザー名から正規化されたプロフィールや公開動画1ページ分を取得したり、クリップURLから公開クリップを1件取得したりするAPIです。
現在利用できるTwitch APIはどれですか?
現在、Twitch Profile API、Twitch User Videos API、Twitch Clip Downloader APIを利用できます。
TwitchのURLを送信できますか?
Twitch Clip Downloader APIは url でクリップURLを1件受け付けます。Twitch ProfileとUser Videosは username が必須で、url、urls、その他の宣言されていないフィールドは受け付けません。
このAPIでTwitchチャンネルを管理できますか?
いいえ。すべてのTwitchエンドポイントは読み取り専用の公開データ照会で、Twitchユーザーの認証、配信・投稿、モデレーション、チャンネル設定の管理、非公開の分析データの取得は行いません。
フィールドが null になるのはなぜですか?
正規化されたアカウントと動画のレコードでは、取得時点で取得元または提供元が値を提供しない任意の公開フィールドを null として保持するためです。
Twitchのリクエストの料金はどのように計算されますか?
成功したTwitch ProfileまたはUser Videosのタスクは、1回あたり一律0.19 SocQクレジットです。Twitch Clip Downloaderのリクエストは1回0.5クレジットで、クリップが見つからない場合は全額返金されます。
プラットフォームを横断してデータを組み合わせ、より包括的なビジネスインサイトを
さまざまなプラットフォームの公開プロフィール、コンテンツ、エンゲージメントデータを1つのワークフローに集約し、ブランド、クリエイター、トピックの追跡やクロスプラットフォームのモニタリング・分析をより効率的に行えます。
Rednote API
公開プロフィールとノートの取得、ノートやユーザーの検索、コメントとネストされた返信の取得、ホームのおすすめ1ページ分の取得ができます。
Kwai API
公開Kwaiプロフィール、アカウントの投稿1ページ分、既知の投稿1件を取得できます。アカウント情報、コンテンツ、メディア、タイムスタンプ、表示中のエンゲージメントは正規化されています。
Truth Social API
公開アカウントの詳細の取得、アカウントの投稿の取得元1ページ分の取得、既知の投稿URL 1件の解決ができ、正規化レコードとして返します。
Google Ad Library API
公開広告主の検索、企業ごとのクリエイティブの取得、URLによる既知の透明性センターのクリエイティブ1件の取得ができ、調査やレビューに活用できます。
Google Maps API
公開スポットの検索、既知のMaps URLの正規化された詳細の取得、取得元に紐づくスポット情報と投稿者のコンテキストを含む公開クチコミの取得ができます。
Amazon API
対応するマーケットプレイスで公開Amazon商品を検索し、正規化された商品詳細、売れ筋ランキング、レビュー、セラーのプロフィール、クリエイターのストアフロントのレコードを取得できます。


