Hoppa till innehållet
Twitch Drops API

Referens för Twitch Drops API

Ett gratis JSON-API som listar alla aktiva Twitch Drops- och belöningskampanjer, uppdaterat varje minut, och Twitchs globala chattbadges. Anropa det anonymt, eller med en gratis API-nyckel för en högre gräns.

Bas-URLhttps://drops.sunkwi.com/api/twitch
Skaffa en gratis API-nyckelLäs referensen

Testa

Anonymt: 1 anrop per 5 min och route. Med nyckel: 1 per minut.

GET
Läser in förhandsvisningen…
Bläddra

Routes

Alla routes svarar med JSON på ett GET-anrop, och webbläsare på alla webbplatser kan anropa API:et (CORS). Varken /drops, /rewards eller /badges kräver registrering; en gratis API-nyckel höjer gränsen på var och en.

Alla tre routes svarar på samma sätt: listan, tiden för den senaste hämtningen från Twitch (refreshedAt) och din anropsgräns (rateLimit).

RouteBeskrivning
GET /dropsDrops-kampanjer per spel. Alla aktiva Drops-kampanjer, grupperade per spel, i games: ett objekt per spel, med dess kampanjer i rewards.
GET /rewardsBelöningskampanjer. Alla aktiva belöningskampanjer (evenemang på hela Twitch, chattbadges, partnerbelöningar), i campaigns.
GET /badgesGlobala chattbadges. Twitchs globala chattbadges, ett objekt per version i badges, med hur man får dem när det är känt.

Autentisering

Att läsa /drops, /rewards och /badges kräver varken konto eller nyckel. Anonyma anrop räknas per IP-adress: 1 anrop per 5 min på varje route.

Nycklar är gratis: logga in med Discord, Twitch eller GitHub, skapa en i kontrollpanelen och skicka den i headern X-API-Key. En nyckel höjer din gräns till 1 anrop per minut som standard, mer på begäran, och visar din trafik.

Anropsheader

HeaderVärdeBeskrivning
X-API-Keyjdk_…Din API-nyckel: valfri på varje route. En okänd, återkallad eller inaktiverad nyckel nekas aldrig: anropet räknas som anonymt, och x-api-key-status: invalid talar om det.
Exempelanrop · 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

Skaffa en gratis API-nyckel

En nyckel är gratis. Den höjer din gräns från 1 anrop per 5 min till 1 anrop per minut på varje route, och kontrollpanelen visar dess trafik.

  1. Logga in med Discord, Twitch eller GitHub: inget lösenord, inget formulär.
  2. Öppna API-nycklar i kontrollpanelen och skapa en nyckel som du döper efter din bot eller webbplats.
  3. Kopiera nyckeln när den visas (bara en gång) och skicka den i headern X-API-Key från din server.

Hämta Drops-kampanjer

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

Alla aktiva Drops-kampanjer, grupperade per spel: ett objekt i games per spel, med dess kampanjer i rewards, tillsammans med tiden för den senaste Twitch-skanningen och din anropsgräns.

Svarets body

FältTypBeskrivning
gamesGame[]De aktiva kampanjerna, i ordningen från den senaste skanningen. En tom array är ett giltigt svar.
refreshedAtstring (ISO 8601) | nullTiden för den senaste lyckade Twitch-skanningen, null före den första.
rateLimit{ limit, remaining, resetAt }Din gräns på den här routen efter det här anropet, så som ratelimit-*-headrarna anger den: limit anrop per fönster, remaining som fortfarande tillåts och resetAt, när hela gränsen är tillbaka (ISO 8601).

Game

Ett objekt i games.

FältTypBeskrivning
gameIdstringSpelets Twitch-id.
gameDisplayNamestringSpelets namn.
gameBoxArtURLstring (URL)Spelets omslagsbild, 120×160.
startAtstring (ISO 8601)Start för spelets tidigaste kampanj.
endAtstring (ISO 8601)Slut för spelets senaste kampanj.
rewardsDropCampaign[]Spelets Drops-kampanjer.
Fält i DropCampaign, TimeBasedDrop och Benefit

DropCampaign

En Drops-kampanj, i rewards för ett spel.

FältTypBeskrivning
idstringKampanjens Twitch-id.
name, descriptionstringNamn och beskrivning från utgivaren.
owner{ id, name }Utgivaren som driver kampanjen.
game{ id, displayName, slug }Kampanjens spel.
statusstringTwitch-status, ACTIVE för en pågående kampanj.
startAt, endAtstring (ISO 8601)Kampanjens period.
imageURLstring (URL)Kampanjens bild.
detailsURL, accountLinkURLstring (URL)Utgivarens informationssida och sida för kontokoppling.
allow{ isEnabled, channels? }Kanaler som får dela ut Drops när isEnabled är true; annars valfri kanal som streamar spelet. displayName kan vara null eller saknas.
timeBasedDropsTimeBasedDrop[]Drops som tjänas in genom att titta.
eventBasedDropsunknown[]Drops som tjänas in via händelser, vidarebefordrade från Twitch.
firstSeenAtstring (ISO 8601) | nullNär API:et först såg kampanjen. En kampanj som kommer tillbaka mindre än ett dygn efter att ha lämnat listan behåller sitt datum. null för kampanjer som API:et redan levererade när det här fältet tillkom.

TimeBasedDrop

En Drop som tjänas in genom att titta, i timeBasedDrops.

FältTypBeskrivning
id, namestringTwitch-id och namn för denna Drop.
startAt, endAtstring (ISO 8601)Perioden då den kan tjänas in.
requiredMinutesWatchednumberMinuter av tittande som krävs.
requiredSubsnumberPrenumerationer som krävs.
repeat{ everyHours, times } | nullTillagt av detta API: hur ofta Drop-en kan fås igen, med times (hur många gånger) och everyHours (24: en gång om dagen; null när Twitch inte säger det). requiredMinutesWatched är då tittartiden för en period. null för en Drop som fås en gång.
preconditionDropsunknownDrops som måste tjänas in först, vidarebefordrade från Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Vad den ger, och hur många gånger det kan hämtas.

Benefit

Ett föremål i spelet, i benefitEdges.

FältTypBeskrivning
id, namestringFöremålets Twitch-id och namn.
imageAssetURLstring (URL)Bild på föremålet.
createdAtstring (ISO 8601)Datum då föremålet skapades på Twitch.
distributionTypestringHur föremålet levereras: DIRECT_ENTITLEMENT för ett föremål i spelet, BADGE för en chattbadge.
entitlementLimitnumberHur många gånger föremålet kan hämtas.
isIosAvailablebooleanOm föremålet kan hämtas på iOS.
game, ownerOrganization{ id, name }Föremålets spel och utgivare.

Svarskoder

StatusBeskrivning
200De aktiva kampanjerna. En tom lista är ett giltigt svar.
304Inget har ändrats sedan den ETag du skickade: behåll din kopia. Gratis, räknas inte mot din gräns.
429RATE_LIMITED: Vänta så många sekunder som Retry-After anger.
429INVALID_API_KEY_RATE_LIMITED: Nyckeln känns inte igen och den anonyma gränsen för din IP-adress är förbrukad: rätta nyckeln.
503SERVICE_UNAVAILABLE: Ingen lista inläst än (direkt efter en omstart av API:et): försök igen efter Retry-After. Gratis, räknas inte mot din gräns.
Exempelanrop
curl https://drops.sunkwi.com/api/twitch/drops
Exempelsvar · 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" }}

Hämta belöningskampanjer

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

Alla aktiva belöningskampanjer (evenemang på hela Twitch, chattbadges, partnerbelöningar) i campaigns, tillsammans med tiden för den senaste Twitch-skanningen och din anropsgräns.

Svarets body

FältTypBeskrivning
campaignsRewardCampaign[]De aktiva kampanjerna, i ordningen från den senaste skanningen. En tom array är ett giltigt svar.
refreshedAtstring (ISO 8601) | nullTiden för den senaste lyckade Twitch-skanningen, null före den första.
rateLimit{ limit, remaining, resetAt }Din gräns på den här routen efter det här anropet, så som ratelimit-*-headrarna anger den: limit anrop per fönster, remaining som fortfarande tillåts och resetAt, när hela gränsen är tillbaka (ISO 8601).

RewardCampaign

Ett objekt i campaigns.

FältTypBeskrivning
id, name, brandstringKampanjens Twitch-id, namn och varumärke.
statusstringStatus vid tidpunkten för anropet, utifrån datumen: UPCOMING före startsAt, ACTIVE till endsAt, därefter EXPIRED.
summary, instructionsstringTexter som Twitch visar.
startsAt, endsAtstring (ISO 8601)Kampanjens period.
image{ image1xURL }Kampanjens bild.
aboutURL, externalURLstring (URL)Kampanjens hjälpsida och externa sida.
isSitewidebooleanOm alla kanaler räknas, inte bara de för ett visst spel.
game{ id, displayName, slug }?Kampanjens spel, om den har ett.
rewardValueURLParamstringVärde som Twitch lägger till i inlösningslänkarna.
unlockRequirements{ minuteWatchedGoal, subsGoal }Minuter av tittande och prenumerationer som krävs.
rewardGroupsRewardGroup[]?Belöningar som tjänas in en grupp i taget, där varje grupp har sitt eget mål: en belöning om dagen är en grupp om dagen. Bara när Twitch skickar dem.
rewardsReward[]Kampanjens belöningar, inklusive gruppernas, var och en en gång.
firstSeenAtstring (ISO 8601) | nullNär API:et först såg kampanjen. En kampanj som kommer tillbaka mindre än ett dygn efter att ha lämnat listan behåller sitt datum. null för kampanjer som API:et redan levererade när det här fältet tillkom.
Fält för belöningar

RewardGroup

En grupp belöningar i en belöningskampanj, som tjänas in tillsammans.

FältTypBeskrivning
idstringGruppens Twitch-id.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Vad gruppen kräver. Twitch lägger till Turbo- och evenemangsmål där.
repeat{ everyHours, times } | nullHur ofta gruppen kan fås igen, som repeat för en Drop: minuteWatchedGoal är då tittartiden för en period. null för en grupp som fås en gång.
categories{ id, displayName, slug }[]Kategorierna vars livekanaler räknas, vilken som helst av dem; tom när Twitch inte nämner någon.
rewardsReward[]Gruppens belöningar, som också listas i kampanjens rewards.

Reward

En belöning i en belöningskampanj.

FältTypBeskrivning
id, namestringBelöningens Twitch-id och namn.
bannerImage, thumbnailImage{ image1xURL }Bilder på belöningen.
earnableUntilstring (ISO 8601)Sista tidpunkten då belöningen kan tjänas in.
redemptionInstructions, redemptionURLstringHur och var belöningen löses in.

Svarskoder

StatusBeskrivning
200De aktiva kampanjerna. En tom lista är ett giltigt svar.
304Inget har ändrats sedan den ETag du skickade: behåll din kopia. Gratis, räknas inte mot din gräns.
429RATE_LIMITED: Vänta så många sekunder som Retry-After anger.
429INVALID_API_KEY_RATE_LIMITED: Nyckeln känns inte igen och den anonyma gränsen för din IP-adress är förbrukad: rätta nyckeln.
503SERVICE_UNAVAILABLE: Ingen lista inläst än (direkt efter en omstart av API:et): försök igen efter Retry-After. Gratis, räknas inte mot din gräns.
Exempelanrop
curl https://drops.sunkwi.com/api/twitch/rewards
Exempelsvar · 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" }}

Hämta chattbadges

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

Twitchs globala chattbadges i badges, ett objekt per version, vart och ett med hur man får badgen när API:et vet det (requirement), samt tiden för den senaste hämtningen av Twitchs badges och din anropsgräns.

Svarets body

FältTypBeskrivning
badgesBadge[]Alla globala badges, ett objekt per version. En tom array är ett giltigt svar.
refreshedAtstring (ISO 8601) | nullTiden för den senaste lyckade hämtningen av Twitchs badges (var 5:e minut), null före den första.
rateLimit{ limit, remaining, resetAt }Din gräns på den här routen efter det här anropet, så som ratelimit-*-headrarna anger den: limit anrop per fönster, remaining som fortfarande tillåts och resetAt, när hela gränsen är tillbaka (ISO 8601).

Badge

Ett objekt i badges: en version av en global chattbadge, så som Twitch listar den nu.

FältTypBeskrivning
setId, versionIdstringBadgens set och version: tillsammans anger de en badge (sub-gifter och 5).
title, descriptionstringDess namn och Twitchs beskrivning, på engelska.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Dess bild i 18, 36 och 72 pixlar.
clickAction, clickUrlstring | nullVad Twitch gör när man klickar på badgen, och dess länk; null när Twitch inte anger någon.
firstSeenAtstring (ISO 8601) | nullNär API:et först såg badgen. En badge som kommer tillbaka mer än 7 dagar efter att Twitch tagit bort den får ett nytt datum; kommer den tillbaka tidigare behåller den sitt gamla. null för badges som redan fanns vid dess första hämtning.
requirementBadgeRequirement | nullHur man får det; null när API:et inte vet.
Fält i BadgeRequirement

BadgeRequirement

Hur man får en badge: från Drops-kampanjen som ger den (DROPS), eller från Twitchs egen beskrivning av en prenumerations- eller tittarbadge (TWITCH_DESCRIPTION).

FältTypBeskrivning
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS eller TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue exakt när det räcker att titta: en DROPS-kampanj som kräver tittartid (requiredMinutes över 0) och ingen prenumeration (requiredSubs 0).
requiredMinutes, requiredSubsnumberMinuter av tittande, och prenumerationer eller gåvoprenumerationer, som krävs.
gameId, gameNamestringSpelet: dess Twitch-id (null när det är okänt) och dess namn.
channels, channelCountstring[] (≤ 5), numberDe första 5 kanalerna som ger det (användarnamn) och hur många de är; 0: alla kanaler som streamar spelet.
startAt, endAtstring (ISO 8601) | nullNär kampanjen pågår; null för TWITCH_DESCRIPTION. En avslutad kampanj ligger kvar.
campaignId, campaignNamestring | nullDrops-kampanjen; null för TWITCH_DESCRIPTION.
repeat{ everyHours, times } | nullBara DROPS: tittartiden krävs igen varje period, och requiredMinutes gäller en period, med times och everyHours (20 min om dagen i 3 dagar: times 3, everyHours 24); annars null.
categories{ id, name }[] (≤ 50)Bara DROPS: kategorierna vars livekanaler räknas, vilken som helst av dem (id och name, högst 50); gameId och gameName är den första. Annars tom.
collection{ chestSize, completeAll } | nullBara DROPS: badgen är en av belöningarna i en evenemangssamling, kampanjen. chestSize: den kommer ur en kista med så många belöningar, en per kista, aldrig valfritt (null: ges direkt). completeAll: ges för att slutföra hela samlingen, prenumerationer inräknade. Annars null.
evolvesFrom{ setId, versionId } | nullBara DROPS: badgen som måste vara vald i chatten innan du tittar, angiven med sitt setId och versionId i den här listan: en Pokémon-utveckling kräver sitt förra stadium (Pikachu: Pichu). Annars null, eller när den är okänd.

Svarskoder

StatusBeskrivning
200Alla globala badges. En tom lista är ett giltigt svar.
304Inget har ändrats sedan den ETag du skickade: behåll din kopia. Gratis, räknas inte mot din gräns.
429RATE_LIMITED: Vänta så många sekunder som Retry-After anger.
429INVALID_API_KEY_RATE_LIMITED: Nyckeln känns inte igen och den anonyma gränsen för din IP-adress är förbrukad: rätta nyckeln.
503SERVICE_UNAVAILABLE: Ingen lista inläst än (direkt efter en omstart av API:et): försök igen efter Retry-After. Gratis, räknas inte mot din gräns.
Exempelanrop
curl https://drops.sunkwi.com/api/twitch/badges
Läser in förhandsvisningen…

Anropsgränser

Varje route har en egen räknare: att anropa /drops drar aldrig från budgeten för /rewards eller /badges. Kampanjerna ändras en gång per minut och listan över badges var 5:e minut, så tätare anrop ger inget nytt.

AnropareGräns per routeRäknas per
Anonym1 anrop per 5 minIP-adress
Med API-nyckel1 anrop per minut som standard, mer på begäranAPI-nyckel

Svarsheaders

Headers som API:et läser och skickar.

HeaderRiktningBeskrivning
x-last-updated-atresponseTiden för den senaste lyckade hämtningen från Twitch: skanningen för /drops och /rewards, listan över badges för /badges.
x-refresh-interval-secondsresponseSekunder mellan två hämtningar från Twitch: tätare anrop ger samma data (60 för /drops och /rewards, 300 för /badges).
ratelimit-limitresponseTillåtna anrop i fönstret, för den här routen.
ratelimit-remainingresponseAnrop kvar i det aktuella fönstret.
ratelimit-resetresponseSekunder tills ett anrop tillåts igen.
ratelimit-policyresponsePolicyn, som <gräns>;w=<fönster i sekunder>.
retry-afterresponseSekunder att vänta innan nytt försök, vid ett 429- eller 503-svar.
x-api-keyrequestDin API-nyckel: valfri på varje route.
x-api-key-statusresponseinvalid när den skickade nyckeln är okänd, återkallad eller inaktiverad: anropet räknades som anonymt, mot gränsen för din IP-adress.
etagresponseEtiketten för det här svaret. Skicka tillbaka den i If-None-Match: så länge datan inte har ändrats är svaret en 304 som inte räknas mot din gräns.
if-none-matchrequestETag från ditt senaste svar, valfri: en oförändrad lista svarar 304 Not Modified, gratis.
Ett andra anonymt anrop inom 5 min
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" }

Fel

Fel svarar med en JSON-body med en stabil kod: { "code": "RATE_LIMITED" }. Koderna ändras aldrig: bygg på code, inte på ett meddelande.

StatusKodBeskrivning
429RATE_LIMITEDFör många anrop på den här routen: vänta så många sekunder som Retry-After anger.
429INVALID_API_KEY_RATE_LIMITEDFör många anrop, och headern X-API-Key innehåller en okänd, återkallad eller inaktiverad nyckel: anropet räknades som anonymt. Rätta nyckeln eller vänta så många sekunder som Retry-After anger.
503SERVICE_UNAVAILABLEIngen lista är inläst än (direkt efter en omstart av API:et). Inget förbrukas: försök igen efter så många sekunder som Retry-After anger.
404NOT_FOUNDRouten finns inte.
500INTERNAL_SERVER_ERROREtt fel uppstod på servern: försök igen senare.
Exempel på fel
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

Från webbplatsen till API:et

Alla sidor på den här webbplatsen läser samma routes. Här ser du var det som en sida visar finns i svaren.

SidaRouteVar i svaret
Drops/drops/dropsgames: ett objekt per spel, med dess kampanjer i rewards. Rutnätsvyn ritar startAt och endAt för varje kampanj.
En spelsida/drops/<game>/dropsEtt objekt i games, matchat på gameId. Varje kampanj är games[i].rewards[j]; dess belöningar är benefitEdges i timeBasedDrops, med requiredMinutesWatched.
Belöningar/rewards/rewardscampaigns: ett objekt per belöningskampanj, med dess belöningar i rewards och vad den kräver i unlockRequirements.
En belöningskampanjsida/rewards/<campaign>/rewardsEtt objekt i campaigns, matchat på id; dess belöningar finns i rewards.
Badges/badges/badgesbadges: alla objekt, de med ett requirement först, med hur man får dem. Rutnätsvyn ritar requirement.startAt och requirement.endAt för varje badge.
En badgesida/badges/<badge>/badgesEtt objekt i badges, matchat på setId och versionId; ”Så får du den” är dess requirement.