Gå til innholdet
Twitch Drops API

Referanse for Twitch Drops API

Et gratis JSON-API med alle aktive Twitch Drops- og belønningskampanjer, oppdatert hvert minutt, og Twitchs globale chattemerker. Kall det anonymt, eller med en gratis API-nøkkel for en høyere grense.

Basis-URLhttps://drops.sunkwi.com/api/twitch
Få en gratis API-nøkkelLes referansen

Prøv det

Anonymt: 1 forespørsel hvert 5. minutt per rute. Med nøkkel: 1 per minutt.

GET
Laster inn forhåndsvisningen…
Bla gjennom

Ruter

Alle ruter svarer med JSON på en GET-forespørsel, og nettlesere på alle nettsteder kan kalle API-et (CORS). Verken /drops, /rewards eller /badges krever registrering; en gratis API-nøkkel hever grensen på hver av dem.

De tre rutene svarer på samme måte: listen, tidspunktet for den siste hentingen fra Twitch (refreshedAt) og forespørselsgrensen din (rateLimit).

RuteBeskrivelse
GET /dropsDrops-kampanjer etter spill. Alle aktive Drops-kampanjer, gruppert etter spill, i games: ett element per spill, med kampanjene i rewards.
GET /rewardsBelønningskampanjer. Alle aktive belønningskampanjer (arrangementer på hele Twitch, chattemerker, partnerbelønninger), i campaigns.
GET /badgesGlobale chattemerker. Twitchs globale chattemerker, ett element per versjon i badges, med hvordan man får dem når det er kjent.

Autentisering

Lesing av /drops, /rewards og /badges krever verken konto eller nøkkel. Anonyme kall telles per IP-adresse: 1 forespørsel hvert 5. minutt på hver rute.

Nøkler er gratis: logg inn med Discord, Twitch eller GitHub, opprett en i kontrollpanelet og send den i headeren X-API-Key. En nøkkel øker grensen din til 1 forespørsel per minutt som standard, mer på forespørsel, og viser trafikken din.

Forespørselsheader

HeaderVerdiBeskrivelse
X-API-Keyjdk_…API-nøkkelen din: valgfri på hver rute. En ukjent, tilbakekalt eller deaktivert nøkkel avvises aldri: kallet telles som anonymt, og x-api-key-status: invalid sier fra om det.
Eksempel på forespørsel · 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

Få en gratis API-nøkkel

En nøkkel er gratis. Den øker grensen din fra 1 forespørsel hvert 5. minutt til 1 forespørsel per minutt på hver rute, og kontrollpanelet viser trafikken.

  1. Logg inn med Discord, Twitch eller GitHub: ikke noe passord, ikke noe skjema.
  2. Åpne API-nøkler i kontrollpanelet og opprett en nøkkel oppkalt etter boten eller nettstedet ditt.
  3. Kopier nøkkelen når den vises (bare én gang), og send den i headeren X-API-Key fra serveren din.

Hent Drops-kampanjer

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

Alle aktive Drops-kampanjer, gruppert etter spill: ett element i games per spill, med kampanjene i rewards, sammen med tidspunktet for den siste Twitch-skanningen og forespørselsgrensen din.

Svarets body

FeltTypeBeskrivelse
gamesGame[]De aktive kampanjene, i rekkefølgen fra den siste skanningen. En tom array er et gyldig svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den siste vellykkede Twitch-skanningen, null før den første.
rateLimit{ limit, remaining, resetAt }Grensen din på denne ruten etter dette kallet, slik ratelimit-*-headerne oppgir den: limit forespørsler per vindu, remaining som fortsatt er tillatt, og resetAt, når hele grensen er tilbake (ISO 8601).

Game

Ett element i games.

FeltTypeBeskrivelse
gameIdstringTwitch-ID for spillet.
gameDisplayNamestringNavnet på spillet.
gameBoxArtURLstring (URL)Coverbilde for spillet, 120×160.
startAtstring (ISO 8601)Start for spillets tidligste kampanje.
endAtstring (ISO 8601)Slutt for spillets seneste kampanje.
rewardsDropCampaign[]Drops-kampanjene for spillet.
Felt i DropCampaign, TimeBasedDrop og Benefit

DropCampaign

En Drops-kampanje, i rewards for et spill.

FeltTypeBeskrivelse
idstringTwitch-ID for kampanjen.
name, descriptionstringNavn og beskrivelse fra utgiveren.
owner{ id, name }Utgiveren som kjører kampanjen.
game{ id, displayName, slug }Spillet kampanjen gjelder.
statusstringTwitch-status, ACTIVE for en pågående kampanje.
startAt, endAtstring (ISO 8601)Perioden kampanjen pågår.
imageURLstring (URL)Kampanjebilde.
detailsURL, accountLinkURLstring (URL)Utgiverens informasjonsside og side for kontokobling.
allow{ isEnabled, channels? }Kanaler som kan gi Drops når isEnabled er true; ellers alle kanaler som strømmer spillet. displayName kan være null eller mangle.
timeBasedDropsTimeBasedDrop[]Drops som opptjenes ved å se på.
eventBasedDropsunknown[]Drops som opptjenes via hendelser, videreformidlet uendret fra Twitch.
firstSeenAtstring (ISO 8601) | nullNår API-et først så kampanjen. En kampanje som kommer tilbake mindre enn et døgn etter at den forsvant fra listen, beholder datoen sin. null for kampanjene API-et allerede leverte da dette feltet kom til.

TimeBasedDrop

En Drop som opptjenes ved å se på, i timeBasedDrops.

FeltTypeBeskrivelse
id, namestringTwitch-ID og navn for Droppet.
startAt, endAtstring (ISO 8601)Perioden Droppet kan opptjenes.
requiredMinutesWatchednumberMinutter seertid som kreves.
requiredSubsnumberAbonnementer som kreves.
repeat{ everyHours, times } | nullLagt til av dette API-et: hvor ofte Drop-en kan fås igjen, med times (hvor mange ganger) og everyHours (24: én gang om dagen; null når Twitch ikke sier det). requiredMinutesWatched er da seertiden for én periode. null for en Drop som fås én gang.
preconditionDropsunknownDrops som må opptjenes først, videreformidlet uendret fra Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Hva Droppet gir, og hvor mange ganger det kan hentes.

Benefit

En gjenstand i spillet, i benefitEdges.

FeltTypeBeskrivelse
id, namestringTwitch-ID og navn for gjenstanden.
imageAssetURLstring (URL)Bilde av gjenstanden.
createdAtstring (ISO 8601)Datoen gjenstanden ble opprettet på Twitch.
distributionTypestringHvordan gjenstanden leveres: DIRECT_ENTITLEMENT for en gjenstand i spillet, BADGE for et chattemerke.
entitlementLimitnumberHvor mange ganger gjenstanden kan hentes.
isIosAvailablebooleanOm gjenstanden kan hentes på iOS.
game, ownerOrganization{ id, name }Spillet og utgiveren til gjenstanden.

Svarkoder

StatusBeskrivelse
200De aktive kampanjene. En tom liste er et gyldig svar.
304Ingenting er endret siden ETag du sendte: behold kopien din. Gratis, teller ikke mot grensen din.
429RATE_LIMITED: Vent så mange sekunder som Retry-After oppgir.
429INVALID_API_KEY_RATE_LIMITED: Nøkkelen gjenkjennes ikke, og den anonyme grensen for IP-adressen din er brukt opp: rett nøkkelen.
503SERVICE_UNAVAILABLE: Ingen liste lastet inn ennå (rett etter en omstart av API-et): prøv igjen etter Retry-After. Gratis, teller ikke mot grensen din.
Eksempel på forespørsel
curl https://drops.sunkwi.com/api/twitch/drops
Eksempel på svar · 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" }}

Hent belønningskampanjer

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

Alle aktive belønningskampanjer (arrangementer på hele Twitch, chattemerker, partnerbelønninger) i campaigns, sammen med tidspunktet for den siste Twitch-skanningen og forespørselsgrensen din.

Svarets body

FeltTypeBeskrivelse
campaignsRewardCampaign[]De aktive kampanjene, i rekkefølgen fra den siste skanningen. En tom array er et gyldig svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den siste vellykkede Twitch-skanningen, null før den første.
rateLimit{ limit, remaining, resetAt }Grensen din på denne ruten etter dette kallet, slik ratelimit-*-headerne oppgir den: limit forespørsler per vindu, remaining som fortsatt er tillatt, og resetAt, når hele grensen er tilbake (ISO 8601).

RewardCampaign

Ett element i campaigns.

FeltTypeBeskrivelse
id, name, brandstringTwitch-ID, navn og merkevare for kampanjen.
statusstringStatus på tidspunktet for forespørselen, ut fra datoene: UPCOMING før startsAt, ACTIVE til endsAt, deretter EXPIRED.
summary, instructionsstringTekster som Twitch viser.
startsAt, endsAtstring (ISO 8601)Perioden kampanjen pågår.
image{ image1xURL }Kampanjebilde.
aboutURL, externalURLstring (URL)Hjelpeside og ekstern side for kampanjen.
isSitewidebooleanOm alle kanaler teller, ikke bare de for et bestemt spill.
game{ id, displayName, slug }?Spillet kampanjen gjelder, hvis den har et.
rewardValueURLParamstringVerdi som Twitch legger til i innløsningslenkene.
unlockRequirements{ minuteWatchedGoal, subsGoal }Minutter seertid og abonnementer som kreves.
rewardGroupsRewardGroup[]?Belønninger som opptjenes én gruppe om gangen, hver gruppe med sitt eget mål: én belønning om dagen er én gruppe om dagen. Bare når Twitch sender dem.
rewardsReward[]Kampanjens belønninger, inkludert gruppenes, hver én gang.
firstSeenAtstring (ISO 8601) | nullNår API-et først så kampanjen. En kampanje som kommer tilbake mindre enn et døgn etter at den forsvant fra listen, beholder datoen sin. null for kampanjene API-et allerede leverte da dette feltet kom til.
Felt for belønninger

RewardGroup

En gruppe belønninger i en belønningskampanje, som opptjenes sammen.

FeltTypeBeskrivelse
idstringTwitch-ID for gruppen.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Hva gruppen krever. Twitch legger også til Turbo- og arrangementsmål her.
repeat{ everyHours, times } | nullHvor ofte gruppen kan fås igjen, som repeat for en Drop: minuteWatchedGoal er da seertiden for én periode. null for en gruppe som fås én gang.
categories{ id, displayName, slug }[]Kategoriene der direktesendte kanaler teller, hvilken som helst av dem; tom når Twitch ikke nevner noen.
rewardsReward[]Gruppens belønninger, som også står i kampanjens rewards.

Reward

En belønning i en belønningskampanje.

FeltTypeBeskrivelse
id, namestringTwitch-ID og navn for belønningen.
bannerImage, thumbnailImage{ image1xURL }Bilder av belønningen.
earnableUntilstring (ISO 8601)Siste tidspunkt belønningen kan opptjenes.
redemptionInstructions, redemptionURLstringHvordan og hvor belønningen løses inn.

Svarkoder

StatusBeskrivelse
200De aktive kampanjene. En tom liste er et gyldig svar.
304Ingenting er endret siden ETag du sendte: behold kopien din. Gratis, teller ikke mot grensen din.
429RATE_LIMITED: Vent så mange sekunder som Retry-After oppgir.
429INVALID_API_KEY_RATE_LIMITED: Nøkkelen gjenkjennes ikke, og den anonyme grensen for IP-adressen din er brukt opp: rett nøkkelen.
503SERVICE_UNAVAILABLE: Ingen liste lastet inn ennå (rett etter en omstart av API-et): prøv igjen etter Retry-After. Gratis, teller ikke mot grensen din.
Eksempel på forespørsel
curl https://drops.sunkwi.com/api/twitch/rewards
Eksempel på svar · 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" }}

Hent chattemerker

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

Twitchs globale chattemerker i badges, ett element per versjon, hvert med hvordan man får det når API-et vet det (requirement), sammen med tidspunktet for den siste hentingen av Twitchs merker og forespørselsgrensen din.

Svarets body

FeltTypeBeskrivelse
badgesBadge[]De globale merkene, ett element per versjon. En tom array er et gyldig svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den siste vellykkede hentingen av Twitchs merker (hvert 5. minutt), null før den første.
rateLimit{ limit, remaining, resetAt }Grensen din på denne ruten etter dette kallet, slik ratelimit-*-headerne oppgir den: limit forespørsler per vindu, remaining som fortsatt er tillatt, og resetAt, når hele grensen er tilbake (ISO 8601).

Badge

Ett element i badges: én versjon av et globalt chattemerke, slik Twitch lister det nå.

FeltTypeBeskrivelse
setId, versionIdstringMerkesettet og versjonen: sammen angir de ett merke (sub-gifter og 5).
title, descriptionstringNavnet og Twitchs beskrivelse, på engelsk.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Bildet i 18, 36 og 72 piksler.
clickAction, clickUrlstring | nullHva Twitch gjør når noen klikker på merket, og lenken; null når Twitch ikke oppgir noe.
firstSeenAtstring (ISO 8601) | nullNår API-et først så merket. Kommer et merke tilbake mer enn 7 dager etter at Twitch fjernet det, får det en ny dato; kommer det tilbake før, beholder det den gamle. null for merker som allerede fantes ved den første hentingen.
requirementBadgeRequirement | nullHvordan man får det; null når API-et ikke vet det.
Felt i BadgeRequirement

BadgeRequirement

Hvordan man får et merke: fra Drops-kampanjen som gir det (DROPS), eller fra Twitchs egen beskrivelse av et abonnent- eller seermerke (TWITCH_DESCRIPTION).

FeltTypeBeskrivelse
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS eller TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue nøyaktig når det holder å se på: en DROPS-kampanje som krever seertid (requiredMinutes over 0) og ikke noe abonnement (requiredSubs 0).
requiredMinutes, requiredSubsnumberMinutter seertid, og abonnementer eller gaveabonnementer, som kreves.
gameId, gameNamestringSpillet: Twitch-ID-en (null når den er ukjent) og navnet.
channels, channelCountstring[] (≤ 5), numberDe 5 første kanalene som gir det (brukernavn), og hvor mange det er; 0: alle kanaler som strømmer spillet.
startAt, endAtstring (ISO 8601) | nullNår kampanjen pågår; null for TWITCH_DESCRIPTION. En avsluttet kampanje blir værende.
campaignId, campaignNamestring | nullDrops-kampanjen; null for TWITCH_DESCRIPTION.
repeat{ everyHours, times } | nullBare DROPS: seertiden kreves igjen hver periode, og requiredMinutes gjelder én periode, med times og everyHours (20 min om dagen i 3 dager: times 3, everyHours 24); ellers null.
categories{ id, name }[] (≤ 50)Bare DROPS: kategoriene der direktesendte kanaler teller, hvilken som helst av dem (id og name, høyst 50); gameId og gameName er den første. Ellers tom.
collection{ chestSize, completeAll } | nullBare DROPS: merket er én av belønningene i en arrangementssamling, kampanjen. chestSize: det kommer ut av en kiste med så mange belønninger, én per kiste, aldri etter eget valg (null: gis direkte). completeAll: gis for å fullføre hele samlingen, abonnementer inkludert. Ellers null.
evolvesFrom{ setId, versionId } | nullBare DROPS: merket som må være valgt i chatten før du ser, angitt med setId og versionId i denne listen: en Pokémon-utvikling krever det forrige stadiet (Pikachu: Pichu). Ellers null, eller når det er ukjent.

Svarkoder

StatusBeskrivelse
200De globale merkene. En tom liste er et gyldig svar.
304Ingenting er endret siden ETag du sendte: behold kopien din. Gratis, teller ikke mot grensen din.
429RATE_LIMITED: Vent så mange sekunder som Retry-After oppgir.
429INVALID_API_KEY_RATE_LIMITED: Nøkkelen gjenkjennes ikke, og den anonyme grensen for IP-adressen din er brukt opp: rett nøkkelen.
503SERVICE_UNAVAILABLE: Ingen liste lastet inn ennå (rett etter en omstart av API-et): prøv igjen etter Retry-After. Gratis, teller ikke mot grensen din.
Eksempel på forespørsel
curl https://drops.sunkwi.com/api/twitch/badges
Laster inn forhåndsvisningen…

Forespørselsgrenser

Hver rute har sin egen teller: kall til /drops bruker aldri av budsjettet til /rewards eller /badges. Kampanjene endres én gang i minuttet og merkene hvert 5. minutt, så hyppigere spørringer gir ikke noe nytt.

KallerGrense per ruteTelles per
Anonym1 forespørsel hvert 5. minuttIP-adresse
Med en API-nøkkel1 forespørsel per minutt som standard, mer på forespørselAPI-nøkkel

Svarheadere

Headere som API-et leser og sender.

HeaderRetningBeskrivelse
x-last-updated-atresponseTidspunktet for den siste vellykkede hentingen fra Twitch: skanningen for /drops og /rewards, merkene for /badges.
x-refresh-interval-secondsresponseSekunder mellom to hentinger fra Twitch: hyppigere spørringer gir de samme dataene (60 for /drops og /rewards, 300 for /badges).
ratelimit-limitresponseTillatte forespørsler i vinduet, for denne ruten.
ratelimit-remainingresponseGjenstående forespørsler i det gjeldende vinduet.
ratelimit-resetresponseSekunder til en forespørsel tillates igjen.
ratelimit-policyresponsePolicyen, som <grense>;w=<vindu i sekunder>.
retry-afterresponseSekunder å vente før et nytt forsøk, ved et 429- eller 503-svar.
x-api-keyrequestAPI-nøkkelen din: valgfri på hver rute.
x-api-key-statusresponseinvalid når den sendte nøkkelen er ukjent, tilbakekalt eller deaktivert: kallet ble telt som anonymt, mot grensen for IP-adressen din.
etagresponseMerket for dette svaret. Send det tilbake i If-None-Match: så lenge dataene ikke er endret, er svaret en 304 som ikke teller mot grensen din.
if-none-matchrequestETag fra det siste svaret ditt, valgfri: en uendret liste svarer 304 Not Modified, gratis.
Et andre anonymt kall innen 5 minutter
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" }

Feil

Feil svarer med en JSON-body med en fast kode: { "code": "RATE_LIMITED" }. Kodene endres aldri: bygg på code, ikke på en melding.

StatusKodeBeskrivelse
429RATE_LIMITEDFor mange forespørsler på denne ruten: vent så mange sekunder som Retry-After oppgir.
429INVALID_API_KEY_RATE_LIMITEDFor mange forespørsler, og headeren X-API-Key inneholder en ukjent, tilbakekalt eller deaktivert nøkkel: kallet ble telt som anonymt. Rett nøkkelen, eller vent så mange sekunder som Retry-After oppgir.
503SERVICE_UNAVAILABLEIngen liste er lastet inn ennå (rett etter en omstart av API-et). Ingenting brukes: prøv igjen etter så mange sekunder som Retry-After oppgir.
404NOT_FOUNDRuten finnes ikke.
500INTERNAL_SERVER_ERRORServeren feilet: prøv igjen senere.
Eksempel på feil
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

Fra nettstedet til API-et

Alle sidene på dette nettstedet leser de samme rutene. Her ser du hvor det en side viser, ligger i svarene.

SideRuteHvor i svaret
Drops/drops/dropsgames: ett element per spill, med kampanjene i rewards. Rutenettvisningen tegner startAt og endAt for hver kampanje.
En spillside/drops/<game>/dropsEtt element i games, matchet på gameId. Hver kampanje er games[i].rewards[j]; belønningene er benefitEdges i timeBasedDrops, med requiredMinutesWatched.
Belønninger/rewards/rewardscampaigns: ett element per belønningskampanje, med belønningene i rewards og det den krever i unlockRequirements.
En belønningskampanjeside/rewards/<campaign>/rewardsEtt element i campaigns, matchet på id; belønningene står i rewards.
Merker/badges/badgesbadges: alle elementer, de med requirement først, med hvordan man får dem. Rutenettvisningen tegner requirement.startAt og requirement.endAt for hvert merke.
En merkeside/badges/<badge>/badgesEtt element i badges, matchet på setId og versionId; «Slik får du det» er dets requirement.