コンテンツにスキップ
Twitch Drops API

Twitch Drops APIリファレンス

開催中のすべてのTwitch Dropsと報酬キャンペーン(毎分更新)、そしてTwitchのグローバルチャットバッジを一覧できる無料のJSON APIです。匿名で呼び出すことも、無料のAPIキーで上限を引き上げることもできます。

ベースURLhttps://drops.sunkwi.com/api/twitch
無料のAPIキーを取得リファレンスを読む

試してみる

匿名:ルートごとに5分に1リクエスト。キーあり:毎分1リクエスト。

GET
プレビューを読み込み中…
閲覧

ルート

すべてのルートはGETリクエストにJSONで応答し、どのサイトのブラウザーからでもAPIを呼び出せます(CORS)。/drops、/rewards、/badgesのいずれも登録は不要で、無料のAPIキーがあればそれぞれの上限が上がります。

3つのルートはどれも同じ形で応答します。リスト、Twitchを最後に読み取った時刻(refreshedAt)、あなたのレート制限(rateLimit)です。

ルート説明
GET /dropsゲーム別のDropsキャンペーン. 開催中のすべてのDropsキャンペーンをゲームごとにまとめ、gamesに入れたものです。1ゲームにつき1項目で、キャンペーンはrewardsに入ります。
GET /rewards報酬キャンペーン. 開催中のすべての報酬キャンペーン(Twitch全体のイベント、チャットバッジ、パートナー報酬)をcampaignsに入れたものです。
GET /badgesグローバルチャットバッジ. Twitchのグローバルチャットバッジ。badgesに1バージョンにつき1項目で入り、わかっている場合は入手方法も付きます。

認証

/drops、/rewards、/badgesの読み取りにアカウントやキーは不要です。匿名の呼び出しはIPアドレスごとにカウントされ、上限は各ルートで5分に1リクエストです。

キーは無料です。Discord、Twitch、GitHubのいずれかでログインし、ダッシュボードでキーを作成してX-API-Keyヘッダーで送信してください。キーを使うと上限がデフォルトで毎分1リクエストに引き上げられ(申請によりさらに引き上げ可能)、トラフィックも確認できます。

リクエストヘッダー

ヘッダー値説明
X-API-Keyjdk_…APIキー。どのルートでも任意です。不明、失効済み、または無効化済みのキーが拒否されることはありません。呼び出しは匿名としてカウントされ、x-api-key-status: invalidでそのことが示されます。
リクエストの例 · curl
# Anonymouscurl https://drops.sunkwi.com/api/twitch/drops
# With an API key, showing the rate-limit headerscurl -i -H "x-api-key: $DROPS_API_KEY" https://drops.sunkwi.com/api/twitch/drops

無料のAPIキーを取得

キーは無料です。各ルートの上限が5分に1リクエストから毎分1リクエストに引き上げられ、ダッシュボードでトラフィックを確認できます。

  1. Discord、Twitch、GitHubのいずれかでログインします。パスワードもフォーム入力も不要です。
  2. ダッシュボードでAPIキーを開き、ボットやサイトの名前を付けてキーを作成します。
  3. 表示されたキーをコピーし(表示は一度だけです)、サーバーからX-API-Keyヘッダーで送信します。

Dropsキャンペーンを取得

GEThttps://drops.sunkwi.com/api/twitch/drops

開催中のすべてのDropsキャンペーンをゲームごとにまとめ、最新のTwitchスキャン時刻とあなたのレート制限を付けて返します。1ゲームにつきgamesの1項目で、キャンペーンはrewardsに入ります。

レスポンスボディ

フィールド型説明
gamesGame[]開催中のキャンペーン。最新スキャンの順に並びます。空の配列でも正常なレスポンスです。
refreshedAtstring (ISO 8601) | null最後に成功したTwitchスキャンの時刻。最初のスキャン前はnullです。
rateLimit{ limit, remaining, resetAt }この呼び出し後の、このルートでのあなたの制限です。ratelimit-*ヘッダーと同じ内容で、limitはウィンドウあたりのリクエスト数、remainingは残りの許可数、resetAtは制限が完全に回復する時刻(ISO 8601)です。

Game

gamesの1項目。

フィールド型説明
gameIdstringゲームのTwitch ID。
gameDisplayNamestringゲーム名。
gameBoxArtURLstring (URL)ゲームのボックスアート(120×160)。
startAtstring (ISO 8601)そのゲームで最も早いキャンペーンの開始日時。
endAtstring (ISO 8601)そのゲームで最も遅いキャンペーンの終了日時。
rewardsDropCampaign[]そのゲームのDropsキャンペーン。
DropCampaign、TimeBasedDrop、Benefitのフィールド

DropCampaign

ゲームのrewardsに含まれるDropsキャンペーン。

フィールド型説明
idstringキャンペーンのTwitch ID。
name, descriptionstringパブリッシャーが付けた名前と説明。
owner{ id, name }キャンペーンを実施しているパブリッシャー。
game{ id, displayName, slug }キャンペーンのゲーム。
statusstringTwitchのステータス。開催中のキャンペーンはACTIVE。
startAt, endAtstring (ISO 8601)キャンペーンの開催期間。
imageURLstring (URL)キャンペーンのアートワーク。
detailsURL, accountLinkURLstring (URL)パブリッシャーの詳細ページとアカウント連携ページ。
allow{ isEnabled, channels? }isEnabledがtrueの場合にDropsを付与できるチャンネル。それ以外の場合は、そのゲームを配信しているすべてのチャンネルが対象です。displayNameはnullの場合や、存在しない場合があります。
timeBasedDropsTimeBasedDrop[]視聴で獲得するDrops。
eventBasedDropsunknown[]イベントで獲得するDrops(Twitchのデータをそのまま転送)。
firstSeenAtstring (ISO 8601) | nullこのAPIがキャンペーンを初めて確認した日時。リストから外れて1日以内に戻ったキャンペーンは元の日時のままです。このフィールドが追加された時点ですでに提供していたキャンペーンはnull。

TimeBasedDrop

timeBasedDropsに含まれる、視聴で獲得するDrops。

フィールド型説明
id, namestringDropsのTwitch IDと名前。
startAt, endAtstring (ISO 8601)Dropsを獲得できる期間。
requiredMinutesWatchednumber必要な視聴時間(分)。
requiredSubsnumber必要なサブスク数。
repeat{ everyHours, times } | nullこのAPIが追加:Dropsを再び獲得できる頻度。times(回数)とeveryHours(24:1日1回。Twitchが示さない場合はnull)を含みます。このときrequiredMinutesWatchedは1期間分の視聴時間です。1回だけ獲得できるDropsはnull。
preconditionDropsunknown先に獲得する必要があるDrops(Twitchのデータをそのまま転送)。
benefitEdges{ benefit: Benefit, entitlementLimit }[]Dropsで得られるものと、受け取れる回数。

Benefit

benefitEdgesに含まれるゲーム内アイテム。

フィールド型説明
id, namestringアイテムのTwitch IDと名前。
imageAssetURLstring (URL)アイテムの画像。
createdAtstring (ISO 8601)Twitchでのアイテムの作成日。
distributionTypestringアイテムの付与方法。ゲーム内アイテムはDIRECT_ENTITLEMENT、チャットバッジはBADGE。
entitlementLimitnumberアイテムを受け取れる回数。
isIosAvailablebooleaniOSでアイテムを受け取れるかどうか。
game, ownerOrganization{ id, name }アイテムのゲームとパブリッシャー。

レスポンスコード

ステータス説明
200開催中のキャンペーン。空のリストでも正常なレスポンスです。
304送信したETag以降、変更はありません。手元のコピーをそのまま使ってください。無料で、レート制限にはカウントされません。
429RATE_LIMITED: Retry-Afterが示す秒数だけ待ってください。
429INVALID_API_KEY_RATE_LIMITED: キーが認識されず、IPアドレスの匿名枠も使い切りました。キーを修正してください。
503SERVICE_UNAVAILABLE: リストがまだ読み込まれていません(APIの再起動直後)。Retry-Afterのあとに再試行してください。無料で、レート制限にはカウントされません。
リクエストの例
curl https://drops.sunkwi.com/api/twitch/drops
レスポンスの例 · 200 OK
{  "games": [    {      "gameId": "460630",      "gameDisplayName": "Rainbow Six Siege",      "gameBoxArtURL": "https://static-cdn.jtvnw.net/ttv-boxart/460630-120x160.jpg",      "startAt": "2026-10-17T05:00:00Z",      "endAt": "2026-11-02T13:59:59.999Z",      "rewards": [        {          "id": "ef80b803-…",          "name": "R6S S2 2026 19",          "startAt": "2026-10-17T05:00:00Z",          "endAt": "2026-11-02T13:59:59.999Z",          "firstSeenAt": "2026-10-17T05:00:41.208Z",          "accountLinkURL": "https://drops-register.ubi.com",          "timeBasedDrops": [            {              "name": "Esports Pack",              "requiredMinutesWatched": 120,              "repeat": null,              "benefitEdges": [{ "benefit": { "name": "Esports Pack", … } }]            }          ],          …        }      ]    },    …  ],  "refreshedAt": "2026-10-24T21:14:01.936Z",  "rateLimit": { "limit": 1, "remaining": 0, "resetAt": "2026-10-24T21:15:12.000Z" }}

報酬キャンペーンを取得

GEThttps://drops.sunkwi.com/api/twitch/rewards

開催中のすべての報酬キャンペーン(Twitch全体のイベント、チャットバッジ、パートナー報酬)をcampaignsに入れ、最新のTwitchスキャン時刻とあなたのレート制限を付けて返します。

レスポンスボディ

フィールド型説明
campaignsRewardCampaign[]開催中のキャンペーン。最新スキャンの順に並びます。空の配列でも正常なレスポンスです。
refreshedAtstring (ISO 8601) | null最後に成功したTwitchスキャンの時刻。最初のスキャン前はnullです。
rateLimit{ limit, remaining, resetAt }この呼び出し後の、このルートでのあなたの制限です。ratelimit-*ヘッダーと同じ内容で、limitはウィンドウあたりのリクエスト数、remainingは残りの許可数、resetAtは制限が完全に回復する時刻(ISO 8601)です。

RewardCampaign

campaignsの1項目。

フィールド型説明
id, name, brandstringキャンペーンのTwitch ID、名前、ブランド。
statusstringリクエスト時点のステータスで、日付から決まります。startsAtより前はUPCOMING、endsAtまではACTIVE、その後はEXPIREDです。
summary, instructionsstringTwitchが表示するテキスト。
startsAt, endsAtstring (ISO 8601)キャンペーンの開催期間。
image{ image1xURL }キャンペーンのアートワーク。
aboutURL, externalURLstring (URL)キャンペーンのヘルプページと外部ページ。
isSitewideboolean特定のゲームのチャンネルだけでなく、すべてのチャンネルが対象かどうか。
game{ id, displayName, slug }?キャンペーンのゲーム(ある場合)。
rewardValueURLParamstringTwitchが引き換えリンクに付加する値。
unlockRequirements{ minuteWatchedGoal, subsGoal }必要な視聴時間(分)とサブスク数。
rewardGroupsRewardGroup[]?グループ単位で1つずつ獲得する報酬で、グループごとに独自の目標があります。1日1つの報酬なら、1日1グループです。Twitchが送信した場合のみ含まれます。
rewardsReward[]キャンペーンの報酬(グループの報酬を含む)。各報酬は1回ずつ記載されます。
firstSeenAtstring (ISO 8601) | nullこのAPIがキャンペーンを初めて確認した日時。リストから外れて1日以内に戻ったキャンペーンは元の日時のままです。このフィールドが追加された時点ですでに提供していたキャンペーンはnull。
報酬のフィールド

RewardGroup

報酬キャンペーン内で、まとめて獲得する報酬のグループ。

フィールド型説明
idstringグループのTwitch ID。
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }グループの条件。TwitchはTurboやイベントの目標もここに追加します。
repeat{ everyHours, times } | nullグループを再び獲得できる頻度。Dropsのrepeatと同じです。このときminuteWatchedGoalは1期間分の視聴時間です。1回だけ獲得できるグループはnull。
categories{ id, displayName, slug }[]配信中のチャンネルが対象となるカテゴリー(いずれでも可)。Twitchが指定しない場合は空です。
rewardsReward[]グループの報酬。キャンペーンのrewardsにも記載されます。

Reward

報酬キャンペーンの報酬。

フィールド型説明
id, namestring報酬のTwitch IDと名前。
bannerImage, thumbnailImage{ image1xURL }報酬の画像。
earnableUntilstring (ISO 8601)報酬を獲得できる最終日時。
redemptionInstructions, redemptionURLstring報酬の引き換え方法と引き換え先。

レスポンスコード

ステータス説明
200開催中のキャンペーン。空のリストでも正常なレスポンスです。
304送信したETag以降、変更はありません。手元のコピーをそのまま使ってください。無料で、レート制限にはカウントされません。
429RATE_LIMITED: Retry-Afterが示す秒数だけ待ってください。
429INVALID_API_KEY_RATE_LIMITED: キーが認識されず、IPアドレスの匿名枠も使い切りました。キーを修正してください。
503SERVICE_UNAVAILABLE: リストがまだ読み込まれていません(APIの再起動直後)。Retry-Afterのあとに再試行してください。無料で、レート制限にはカウントされません。
リクエストの例
curl https://drops.sunkwi.com/api/twitch/rewards
レスポンスの例 · 200 OK
{  "campaigns": [    {      "id": "19f00aac-…",      "name": "First Partners Collection",      "brand": "Pokemon",      "status": "ACTIVE",      "startsAt": "2026-08-24T17:00:00Z",      "endsAt": "2026-11-01T07:00:00Z",      "firstSeenAt": null,      "isSitewide": true,      "unlockRequirements": { "minuteWatchedGoal": 20, "subsGoal": 0 },      "rewards": [{ "name": "Great Ball", "earnableUntil": "2026-11-01T07:00:00Z", … }]    },    {      "id": "b7669f9e-…",      "name": "GTAVI Launch Celebration",      "brand": "Rockstar Games",      "status": "UPCOMING",      "startsAt": "2026-11-18T11:00:00Z",      "endsAt": "2026-12-01T07:59:59.999Z",      "unlockRequirements": { "minuteWatchedGoal": 60, "subsGoal": 0 },      "rewardGroups": [        {          "id": "6a0e…",          "unlockRequirements": { "minuteWatchedGoal": 60, "subsGoal": 0 },          "repeat": { "everyHours": 24, "times": 6 },          "categories": [{ "id": "1867279146", "displayName": "Grand Theft Auto VI", "slug": "grand-theft-auto-vi" }],          "rewards": [{ "name": "GTA DVD Chest", … }]        },        …      ],      …    },    …  ],  "refreshedAt": "2026-10-24T21:14:01.936Z",  "rateLimit": { "limit": 1, "remaining": 0, "resetAt": "2026-10-24T21:15:12.000Z" }}

チャットバッジを取得

GEThttps://drops.sunkwi.com/api/twitch/badges

Twitchのグローバルチャットバッジをbadgesに入れて返します。1バージョンにつき1項目で、このAPIが把握している場合は入手方法(requirement)も付きます。Twitchのバッジを最後に読み取った時刻と、あなたのレート制限も含まれます。

レスポンスボディ

フィールド型説明
badgesBadge[]グローバルバッジ。1バージョンにつき1項目です。空の配列でも正常なレスポンスです。
refreshedAtstring (ISO 8601) | null最後にTwitchのバッジの読み取りに成功した時刻(5分ごと)。最初の読み取り前はnullです。
rateLimit{ limit, remaining, resetAt }この呼び出し後の、このルートでのあなたの制限です。ratelimit-*ヘッダーと同じ内容で、limitはウィンドウあたりのリクエスト数、remainingは残りの許可数、resetAtは制限が完全に回復する時刻(ISO 8601)です。

Badge

badgesの1項目。グローバルチャットバッジの1バージョンで、現在Twitchが掲載しているとおりの内容です。

フィールド型説明
setId, versionIdstringバッジセットとそのバージョン。2つ合わせて1つのバッジを指します(sub-gifterと5)。
title, descriptionstringバッジの名前とTwitchによる説明(英語)。
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)18、36、72ピクセルの画像。
clickAction, clickUrlstring | nullバッジをクリックしたときのTwitchの動作とそのリンク。Twitchが指定していない場合はnull。
firstSeenAtstring (ISO 8601) | nullこのAPIがバッジを初めて確認した日時。Twitchが削除してから7日を超えて戻ったバッジは新しい日時になり、それより早く戻った場合は元の日時のままです。初回の読み取り時にすでに存在していたバッジはnull。
requirementBadgeRequirement | null入手方法。このAPIが把握していない場合はnull。
BadgeRequirementのフィールド

BadgeRequirement

バッジの入手方法。バッジを配布するDropsキャンペーン(DROPS)、またはサブスクバッジや視聴バッジについてのTwitch自身の説明(TWITCH_DESCRIPTION)に基づきます。

フィールド型説明
source'DROPS' | 'TWITCH_DESCRIPTION'DROPSまたはTWITCH_DESCRIPTION。
watchTimeOnlyboolean視聴だけで獲得できる場合に限りtrue。つまり、視聴時間を求め(requiredMinutesが0より大きい)、サブスクを求めない(requiredSubsが0)DROPSキャンペーンです。
requiredMinutes, requiredSubsnumber必要な視聴時間(分)と、サブスクまたはギフトの数。
gameId, gameNamestringゲーム。Twitch ID(不明な場合はnull)と名前。
channels, channelCountstring[] (≤ 5), numberバッジを配布する最初の5チャンネル(ログイン名)とその総数。0の場合は、そのゲームを配信中のどのチャンネルでも対象です。
startAt, endAtstring (ISO 8601) | nullキャンペーンの開催期間。TWITCH_DESCRIPTIONではnull。終了したキャンペーンも残ります。
campaignId, campaignNamestring | nullDropsキャンペーン。TWITCH_DESCRIPTIONではnull。
repeat{ everyHours, times } | nullDROPSのみ:期間ごとに再び視聴時間が必要で、requiredMinutesは1期間分です。timesとeveryHoursを含みます(1日20分を3日:timesが3、everyHoursが24)。それ以外はnull。
categories{ id, name }[] (≤ 50)DROPSのみ:配信中のチャンネルが対象となるカテゴリー(いずれでも可。idとname、最大50件)。gameIdとgameNameは最初のカテゴリーです。それ以外は空です。
collection{ chestSize, completeAll } | nullDROPSのみ:バッジはイベントコレクション(キャンペーン)の報酬の1つです。chestSize:この数の報酬が入った宝箱から出て、宝箱1つにつき1つ、選ぶことはできません(null:そのまま付与)。completeAll:サブスクを含め、コレクションをすべて達成すると付与。それ以外はnull。
evolvesFrom{ setId, versionId } | nullDROPSのみ:視聴前にチャットで装備しておく必要があるバッジ。このリストのsetIdとversionIdで示します。ポケモンの進化には1つ前の段階が必要です(Pikachu:Pichu)。それ以外、または不明な場合はnull。

レスポンスコード

ステータス説明
200グローバルバッジ。空のリストでも正常なレスポンスです。
304送信したETag以降、変更はありません。手元のコピーをそのまま使ってください。無料で、レート制限にはカウントされません。
429RATE_LIMITED: Retry-Afterが示す秒数だけ待ってください。
429INVALID_API_KEY_RATE_LIMITED: キーが認識されず、IPアドレスの匿名枠も使い切りました。キーを修正してください。
503SERVICE_UNAVAILABLE: リストがまだ読み込まれていません(APIの再起動直後)。Retry-Afterのあとに再試行してください。無料で、レート制限にはカウントされません。
リクエストの例
curl https://drops.sunkwi.com/api/twitch/badges
プレビューを読み込み中…

レート制限

ルートごとに独自のカウンターがあります。/dropsを呼び出しても/rewardsや/badgesの枠は消費されません。キャンペーンは1分に1回、バッジは5分ごとに更新されるため、それより頻繁にポーリングしても新しい情報は得られません。

呼び出し元ルートごとの上限カウント単位
匿名5分に1リクエストIPアドレス
APIキーありデフォルトで毎分1リクエスト、申請により引き上げ可能APIキー

レスポンスヘッダー

APIが読み取るヘッダーと送信するヘッダーです。

ヘッダー方向説明
x-last-updated-atresponse最後にTwitchの読み取りに成功した時刻。/dropsと/rewardsではスキャン、/badgesではバッジの読み取りの時刻です。
x-refresh-interval-secondsresponseTwitchを読み取る間隔の秒数。これより頻繁に問い合わせても同じデータが返ります(/dropsと/rewardsは60、/badgesは300)。
ratelimit-limitresponseこのルートで、ウィンドウ内に許可されるリクエスト数。
ratelimit-remainingresponse現在のウィンドウで残っているリクエスト数。
ratelimit-resetresponse再びリクエストできるようになるまでの秒数。
ratelimit-policyresponseポリシー。<上限>;w=<期間(秒)>の形式です。
retry-afterresponse429または503レスポンスの場合に、再試行までに待つ秒数。
x-api-keyrequestAPIキー。どのルートでも任意です。
x-api-key-statusresponse送信したキーが不明、失効済み、または無効化済みの場合はinvalid。呼び出しは匿名としてカウントされ、IPアドレスの上限が適用されます。
etagresponseこのレスポンスのタグです。If-None-Matchで送り返すと、データが変わっていない間は304が返り、レート制限にはカウントされません。
if-none-matchrequest前回のレスポンスのETag(任意)。リストが変わっていなければ304 Not Modifiedが無料で返ります。
5分以内の2回目の匿名呼び出し
HTTP/1.1 429 Too Many Requestscontent-type: application/json; charset=utf-8retry-after: 214ratelimit-limit: 1ratelimit-remaining: 0ratelimit-reset: 214ratelimit-policy: 1;w=300
{ "code": "RATE_LIMITED" }

エラー

エラーは安定したコードを含むJSONボディを返します:{ "code": "RATE_LIMITED" }。コードは変わりません。メッセージではなくcodeを基準に実装してください。

ステータスコード説明
429RATE_LIMITEDこのルートへのリクエストが多すぎます。Retry-Afterが示す秒数だけ待ってください。
429INVALID_API_KEY_RATE_LIMITEDリクエストが多すぎます。また、X-API-Keyヘッダーのキーが不明、失効済み、または無効化済みのため、呼び出しは匿名としてカウントされました。キーを修正するか、Retry-Afterが示す秒数だけ待ってください。
503SERVICE_UNAVAILABLEリストがまだ読み込まれていない(APIの再起動直後)。何も消費されません。Retry-Afterが示す秒数のあとに再試行してください。
404NOT_FOUNDルートが存在しません。
500INTERNAL_SERVER_ERRORサーバーでエラーが発生しました。時間をおいて再試行してください。
エラーの例
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

サイトからAPIへ

このサイトのすべてのページは、これと同じルートを読み込んでいます。各ページの表示内容がレスポンスのどこにあるかを示します。

ページルートレスポンス内の場所
Drops/drops/dropsgames:1ゲームにつき1項目で、キャンペーンはrewardsに入ります。グリッド表示では各キャンペーンのstartAtとendAtを描画します。
ゲームページ/drops/<game>/dropsgameIdで照合したgamesの1項目。各キャンペーンはgames[i].rewards[j]で、その報酬はtimeBasedDropsのbenefitEdgesです(requiredMinutesWatched付き)。
報酬/rewards/rewardscampaigns:報酬キャンペーンごとに1項目。報酬はrewardsに、条件はunlockRequirementsに入ります。
報酬キャンペーンページ/rewards/<campaign>/rewardsidで照合したcampaignsの1項目。報酬はrewardsに入ります。
バッジ/badges/badgesbadges:すべての項目。requirementのある項目が先に、入手方法とともに表示されます。グリッド表示では各バッジのrequirement.startAtとrequirement.endAtを描画します。
バッジページ/badges/<badge>/badgessetIdとversionIdで照合したbadgesの1項目。「入手方法」はそのrequirementです。