Gå til indholdet
Twitch Drops API

Reference for Twitch Drops API

Et gratis JSON-API med alle aktive Twitch Drops- og belønningskampagner, opdateret hvert minut, og de globale chatbadges fra Twitch. Kald det anonymt eller med en gratis API-nøgle for en højere grænse.

Basis-URLhttps://drops.sunkwi.com/api/twitch
Få en gratis API-nøgleLæs referencen

Prøv det

Anonymt: 1 anmodning hvert 5. minut pr. rute. Med en nøgle: 1 pr. minut.

GET
Indlæser forhåndsvisningen…
Gennemse

Ruter

Alle ruter svarer med JSON på en GET-anmodning, og browsere på alle sites kan kalde API'et (CORS). Hverken /drops, /rewards eller /badges kræver tilmelding; en gratis API-nøgle hæver grænsen på hver af dem.

De tre ruter svarer på samme måde: listen, tidspunktet for den seneste hentning fra Twitch (refreshedAt) og din anmodningsgrænse (rateLimit).

RuteBeskrivelse
GET /dropsDrops-kampagner efter spil. Alle aktive Drops-kampagner, grupperet efter spil, i games: ét element pr. spil, med dets kampagner i rewards.
GET /rewardsBelønningskampagner. Alle aktive belønningskampagner (begivenheder på hele Twitch, chatbadges, partnerbelønninger), i campaigns.
GET /badgesGlobale chatbadges. De globale chatbadges fra Twitch, ét element pr. version i badges, med hvordan man får dem, når det vides.

Godkendelse

Læsning af /drops, /rewards og /badges kræver hverken konto eller nøgle. Anonyme kald tælles pr. IP-adresse: 1 anmodning hvert 5. minut på hver rute.

Nøgler er gratis: log ind med Discord, Twitch eller GitHub, opret en i kontrolpanelet, og send den i headeren X-API-Key. En nøgle hæver som standard din grænse til 1 anmodning pr. minut, mere efter anmodning, og viser din trafik.

Anmodningsheader

HeaderVærdiBeskrivelse
X-API-Keyjdk_…Din API-nøgle: valgfri på alle ruter. En ukendt, tilbagekaldt eller deaktiveret nøgle afvises aldrig: kaldet tæller som anonymt, og x-api-key-status: invalid fortæller det.
Eksempel på anmodning · 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øgle

En nøgle er gratis. Den hæver din grænse fra 1 anmodning hvert 5. minut til 1 anmodning pr. minut på hver rute, og dit kontrolpanel viser dens trafik.

  1. Log ind med Discord, Twitch eller GitHub: ingen adgangskode, ingen formular.
  2. Åbn API-nøgler i dit kontrolpanel, og opret en nøgle, der er opkaldt efter din bot eller dit site.
  3. Kopiér nøglen, når den vises (kun én gang), og send den i headeren X-API-Key fra din server.

Hent Drops-kampagner

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

Alle aktive Drops-kampagner, grupperet efter spil: ét element i games pr. spil, med dets kampagner i rewards, sammen med tidspunktet for den seneste Twitch-scanning og din anmodningsgrænse.

Svarets body

FeltTypeBeskrivelse
gamesGame[]De aktive kampagner i rækkefølgen fra den seneste scanning. Et tomt array er et gyldigt svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den seneste vellykkede Twitch-scanning, null før den første.
rateLimit{ limit, remaining, resetAt }Din grænse på denne rute efter dette kald, som headerne ratelimit-* angiver den: limit anmodninger pr. vindue, remaining, der stadig er tilladt, og resetAt, hvornår hele grænsen er tilbage (ISO 8601).

Game

Ét element i games.

FeltTypeBeskrivelse
gameIdstringSpillets Twitch-id.
gameDisplayNamestringSpillets navn.
gameBoxArtURLstring (URL)Spillets coverbillede, 120×160.
startAtstring (ISO 8601)Start på spillets tidligste kampagne.
endAtstring (ISO 8601)Slut på spillets seneste kampagne.
rewardsDropCampaign[]Spillets Drops-kampagner.
Felter i DropCampaign, TimeBasedDrop og Benefit

DropCampaign

En Drops-kampagne, i rewards for et spil.

FeltTypeBeskrivelse
idstringKampagnens Twitch-id.
name, descriptionstringNavn og beskrivelse fra udgiveren.
owner{ id, name }Udgiveren, der kører kampagnen.
game{ id, displayName, slug }Kampagnens spil.
statusstringTwitch-status, ACTIVE for en igangværende kampagne.
startAt, endAtstring (ISO 8601)Kampagnens periode.
imageURLstring (URL)Kampagnens billede.
detailsURL, accountLinkURLstring (URL)Udgiverens informationsside og side til kontotilknytning.
allow{ isEnabled, channels? }Kanaler, der må give Drops, når isEnabled er true; ellers alle kanaler, der streamer spillet. displayName kan være null eller mangle.
timeBasedDropsTimeBasedDrop[]Drops, der optjenes ved at se med.
eventBasedDropsunknown[]Drops, der optjenes via begivenheder, videregivet uændret fra Twitch.
firstSeenAtstring (ISO 8601) | nullHvornår dette API første gang så kampagnen. En kampagne, der kommer tilbage mindre end et døgn efter at have forladt listen, beholder sin dato. null for de kampagner, API'et allerede leverede, da feltet kom til.

TimeBasedDrop

Et Drop, der optjenes ved at se med, i timeBasedDrops.

FeltTypeBeskrivelse
id, namestringDroppets Twitch-id og navn.
startAt, endAtstring (ISO 8601)Perioden, hvor Droppet kan optjenes.
requiredMinutesWatchednumberMinutters seertid, der kræves.
requiredSubsnumberAbonnementer, der kræves.
repeat{ everyHours, times } | nullTilføjet af dette API: hvor ofte Drop'et kan fås igen, med times (hvor mange gange) og everyHours (24: én gang om dagen; null, når Twitch ikke oplyser det). requiredMinutesWatched er så seertiden for én periode. null for et Drop, der fås én gang.
preconditionDropsunknownDrops, der skal optjenes først, videregivet uændret fra Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Hvad Droppet giver, og hvor mange gange det kan hentes.

Benefit

En genstand i spillet, i benefitEdges.

FeltTypeBeskrivelse
id, namestringGenstandens Twitch-id og navn.
imageAssetURLstring (URL)Billede af genstanden.
createdAtstring (ISO 8601)Dato, hvor genstanden blev oprettet på Twitch.
distributionTypestringHvordan genstanden leveres: DIRECT_ENTITLEMENT for en genstand i spillet, BADGE for et chatbadge.
entitlementLimitnumberHvor mange gange genstanden kan hentes.
isIosAvailablebooleanOm genstanden kan hentes på iOS.
game, ownerOrganization{ id, name }Genstandens spil og udgiver.

Svarkoder

StatusBeskrivelse
200De aktive kampagner. En tom liste er et gyldigt svar.
304Intet er ændret siden den ETag, du sendte: behold din kopi. Gratis, det tæller ikke med i din grænse.
429RATE_LIMITED: Vent det antal sekunder, som Retry-After angiver.
429INVALID_API_KEY_RATE_LIMITED: Nøglen genkendes ikke, og den anonyme grænse for din IP-adresse er brugt op: ret nøglen.
503SERVICE_UNAVAILABLE: Ingen liste indlæst endnu (lige efter en genstart af API'et): prøv igen efter Retry-After. Gratis, det tæller ikke med i din grænse.
Eksempel på anmodning
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ønningskampagner

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

Alle aktive belønningskampagner (begivenheder på hele Twitch, chatbadges, partnerbelønninger) i campaigns, sammen med tidspunktet for den seneste Twitch-scanning og din anmodningsgrænse.

Svarets body

FeltTypeBeskrivelse
campaignsRewardCampaign[]De aktive kampagner i rækkefølgen fra den seneste scanning. Et tomt array er et gyldigt svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den seneste vellykkede Twitch-scanning, null før den første.
rateLimit{ limit, remaining, resetAt }Din grænse på denne rute efter dette kald, som headerne ratelimit-* angiver den: limit anmodninger pr. vindue, remaining, der stadig er tilladt, og resetAt, hvornår hele grænsen er tilbage (ISO 8601).

RewardCampaign

Ét element i campaigns.

FeltTypeBeskrivelse
id, name, brandstringKampagnens Twitch-id, navn og mærke.
statusstringStatus på tidspunktet for forespørgslen, ud fra datoerne: UPCOMING før startsAt, ACTIVE indtil endsAt, derefter EXPIRED.
summary, instructionsstringTekster, som Twitch viser.
startsAt, endsAtstring (ISO 8601)Kampagnens periode.
image{ image1xURL }Kampagnens billede.
aboutURL, externalURLstring (URL)Kampagnens hjælpeside og eksterne side.
isSitewidebooleanOm alle kanaler tæller, ikke kun dem for et bestemt spil.
game{ id, displayName, slug }?Kampagnens spil, hvis den har et.
rewardValueURLParamstringVærdi, som Twitch tilføjer i indløsningslinkene.
unlockRequirements{ minuteWatchedGoal, subsGoal }Minutters seertid og abonnementer, der kræves.
rewardGroupsRewardGroup[]?Belønninger, der optjenes én gruppe ad gangen, hver gruppe med sit eget mål: én belønning om dagen er én gruppe om dagen. Kun når Twitch sender dem.
rewardsReward[]Kampagnens belønninger, inklusive gruppernes, hver én gang.
firstSeenAtstring (ISO 8601) | nullHvornår dette API første gang så kampagnen. En kampagne, der kommer tilbage mindre end et døgn efter at have forladt listen, beholder sin dato. null for de kampagner, API'et allerede leverede, da feltet kom til.
Felter for belønninger

RewardGroup

En gruppe belønninger i en belønningskampagne, der optjenes samlet.

FeltTypeBeskrivelse
idstringGruppens Twitch-id.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Hvad gruppen kræver. Twitch tilføjer også Turbo- og begivenhedsmål her.
repeat{ everyHours, times } | nullHvor ofte gruppen kan fås igen, som et Drops repeat: minuteWatchedGoal er så seertiden for én periode. null for en gruppe, der fås én gang.
categories{ id, displayName, slug }[]De kategorier, hvis livekanaler tæller, en hvilken som helst af dem; tom, når Twitch ikke nævner nogen.
rewardsReward[]Gruppens belønninger, som også står i kampagnens rewards.

Reward

En belønning i en belønningskampagne.

FeltTypeBeskrivelse
id, namestringBelønningens Twitch-id og navn.
bannerImage, thumbnailImage{ image1xURL }Billeder af belønningen.
earnableUntilstring (ISO 8601)Sidste tidspunkt, hvor belønningen kan optjenes.
redemptionInstructions, redemptionURLstringHvordan og hvor belønningen indløses.

Svarkoder

StatusBeskrivelse
200De aktive kampagner. En tom liste er et gyldigt svar.
304Intet er ændret siden den ETag, du sendte: behold din kopi. Gratis, det tæller ikke med i din grænse.
429RATE_LIMITED: Vent det antal sekunder, som Retry-After angiver.
429INVALID_API_KEY_RATE_LIMITED: Nøglen genkendes ikke, og den anonyme grænse for din IP-adresse er brugt op: ret nøglen.
503SERVICE_UNAVAILABLE: Ingen liste indlæst endnu (lige efter en genstart af API'et): prøv igen efter Retry-After. Gratis, det tæller ikke med i din grænse.
Eksempel på anmodning
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 chatbadges

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

De globale chatbadges fra Twitch i badges, ét element pr. version, hvert med, hvordan man får det, når dette API ved det (requirement), samt tidspunktet for den seneste hentning af badgene fra Twitch og din anmodningsgrænse.

Svarets body

FeltTypeBeskrivelse
badgesBadge[]De globale badges, ét element pr. version. Et tomt array er et gyldigt svar.
refreshedAtstring (ISO 8601) | nullTidspunktet for den seneste vellykkede hentning af badgene fra Twitch (hvert 5. minut), null før den første.
rateLimit{ limit, remaining, resetAt }Din grænse på denne rute efter dette kald, som headerne ratelimit-* angiver den: limit anmodninger pr. vindue, remaining, der stadig er tilladt, og resetAt, hvornår hele grænsen er tilbage (ISO 8601).

Badge

Ét element i badges: én version af et globalt chatbadge, som Twitch angiver det nu.

FeltTypeBeskrivelse
setId, versionIdstringBadgesættet og dets version: sammen betegner de ét badge (sub-gifter og 5).
title, descriptionstringDets navn og Twitchs beskrivelse, på engelsk.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Dets billede i 18, 36 og 72 pixels.
clickAction, clickUrlstring | nullHvad Twitch gør, når der klikkes på badget, og dets link; null, når Twitch ikke angiver noget.
firstSeenAtstring (ISO 8601) | nullHvornår dette API første gang så badget. Kommer et badge tilbage mere end 7 dage efter, at Twitch fjernede det, får det en ny dato; kommer det tilbage før, beholder det sin gamle. null for de badges, der allerede fandtes ved dets første hentning.
requirementBadgeRequirement | nullHvordan man får det; null, når dette API ikke ved det.
Felter i BadgeRequirement

BadgeRequirement

Hvordan man får et badge: fra den Drops-kampagne, der giver det (DROPS), eller fra Twitchs egen beskrivelse af et abonnements- eller seerbadge (TWITCH_DESCRIPTION).

FeltTypeBeskrivelse
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS eller TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue, præcis når det er nok at se med: en DROPS-kampagne, der kræver seertid (requiredMinutes over 0) og intet abonnement (requiredSubs 0).
requiredMinutes, requiredSubsnumberMinutters seertid og abonnementer eller gaveabonnementer, det kræver.
gameId, gameNamestringSpillet: dets Twitch-id (null, når det er ukendt) og dets navn.
channels, channelCountstring[] (≤ 5), numberDe første 5 kanaler, der giver det (brugernavne), og hvor mange der er; 0: alle kanaler, der streamer spillet.
startAt, endAtstring (ISO 8601) | nullHvornår kampagnen kører; null for TWITCH_DESCRIPTION. En afsluttet kampagne bliver på listen.
campaignId, campaignNamestring | nullDrops-kampagnen; null for TWITCH_DESCRIPTION.
repeat{ everyHours, times } | nullKun DROPS: seertiden kræves igen i hver periode, idet requiredMinutes gælder én periode, med times og everyHours (20 min om dagen på 3 dage: times 3, everyHours 24); ellers null.
categories{ id, name }[] (≤ 50)Kun DROPS: de kategorier, hvis livekanaler tæller, en hvilken som helst af dem (id og name, højst 50); gameId og gameName er den første. Ellers tom.
collection{ chestSize, completeAll } | nullKun DROPS: badget er én af belønningerne i en eventsamling, kampagnen. chestSize: det kommer ud af en kiste med så mange belønninger, én pr. kiste, aldrig efter eget valg (null: gives direkte). completeAll: gives for at fuldføre hele samlingen, abonnementer inklusive. Ellers null.
evolvesFrom{ setId, versionId } | nullKun DROPS: det badge, der skal være valgt i chatten, før du ser, angivet ved dets setId og versionId i denne liste: en Pokémon-udvikling kræver sit forrige stadie (Pikachu: Pichu). Ellers null, eller når det er ukendt.

Svarkoder

StatusBeskrivelse
200De globale badges. En tom liste er et gyldigt svar.
304Intet er ændret siden den ETag, du sendte: behold din kopi. Gratis, det tæller ikke med i din grænse.
429RATE_LIMITED: Vent det antal sekunder, som Retry-After angiver.
429INVALID_API_KEY_RATE_LIMITED: Nøglen genkendes ikke, og den anonyme grænse for din IP-adresse er brugt op: ret nøglen.
503SERVICE_UNAVAILABLE: Ingen liste indlæst endnu (lige efter en genstart af API'et): prøv igen efter Retry-After. Gratis, det tæller ikke med i din grænse.
Eksempel på anmodning
curl https://drops.sunkwi.com/api/twitch/badges
Indlæser forhåndsvisningen…

Anmodningsgrænser

Hver rute har sin egen tæller: kald til /drops bruger aldrig af budgettet for /rewards eller /badges. Kampagnerne ændres én gang i minuttet og badgene hvert 5. minut, så hyppigere forespørgsler giver intet nyt.

KalderGrænse pr. ruteTælles pr.
Anonym1 anmodning hvert 5. minutIP-adresse
Med en API-nøgle1 anmodning pr. minut som standard, mere efter anmodningAPI-nøgle

Svarheaders

Headers, som API'et læser og sender.

HeaderRetningBeskrivelse
x-last-updated-atresponseTidspunktet for den seneste vellykkede hentning fra Twitch: scanningen for /drops og /rewards, badgene for /badges.
x-refresh-interval-secondsresponseSekunder mellem to hentninger fra Twitch: hyppigere forespørgsler giver de samme data (60 for /drops og /rewards, 300 for /badges).
ratelimit-limitresponseTilladte anmodninger i vinduet for denne rute.
ratelimit-remainingresponseResterende anmodninger i det aktuelle vindue.
ratelimit-resetresponseSekunder, til en anmodning tillades igen.
ratelimit-policyresponsePolitikken, som <grænse>;w=<vindue i sekunder>.
retry-afterresponseSekunder at vente før et nyt forsøg, ved et 429- eller 503-svar.
x-api-keyrequestDin API-nøgle: valgfri på alle ruter.
x-api-key-statusresponseinvalid, når den sendte nøgle er ukendt, tilbagekaldt eller deaktiveret: kaldet talte som anonymt, mod grænsen for din IP-adresse.
etagresponseMærket for dette svar. Send det tilbage i If-None-Match: så længe dataene ikke har ændret sig, er svaret en 304, der ikke tæller med i din grænse.
if-none-matchrequestETag fra dit seneste svar, valgfri: en uændret liste svarer 304 Not Modified, gratis.
Et andet anonymt kald inden for 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" }

Fejl

Fejl svarer med en JSON-body med en fast kode: { "code": "RATE_LIMITED" }. Koderne ændres aldrig: byg på code, ikke på en besked.

StatusKodeBeskrivelse
429RATE_LIMITEDFor mange anmodninger på denne rute: vent det antal sekunder, som Retry-After angiver.
429INVALID_API_KEY_RATE_LIMITEDFor mange anmodninger, og headeren X-API-Key indeholder en ukendt, tilbagekaldt eller deaktiveret nøgle: kaldet talte som anonymt. Ret nøglen, eller vent det antal sekunder, som Retry-After angiver.
503SERVICE_UNAVAILABLEIngen liste er indlæst endnu (lige efter en genstart af API'et). Intet bliver brugt: prøv igen efter det antal sekunder, som Retry-After angiver.
404NOT_FOUNDRuten findes ikke.
500INTERNAL_SERVER_ERRORServeren fejlede: prøv igen senere.
Eksempel på fejl
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

Fra sitet til API'et

Alle sider på dette site læser de samme ruter. Her kan du se, hvor det, en side viser, findes i svarene.

SideRuteHvor i svaret
Drops/drops/dropsgames: ét element pr. spil, med dets kampagner i rewards. Gittervisningen tegner startAt og endAt for hver kampagne.
En spilside/drops/<game>/dropsÉt element i games, matchet på gameId. Hver kampagne er games[i].rewards[j]; dens belønninger er benefitEdges i timeBasedDrops, med requiredMinutesWatched.
Belønninger/rewards/rewardscampaigns: ét element pr. belønningskampagne, med dens belønninger i rewards og det, den kræver, i unlockRequirements.
En belønningskampagneside/rewards/<campaign>/rewardsÉt element i campaigns, matchet på id; dets belønninger står i rewards.
Badges/badges/badgesbadges: alle elementer, dem med et requirement først, med hvordan man får dem. Gittervisningen tegner requirement.startAt og requirement.endAt for hvert badge.
En badgeside/badges/<badge>/badgesÉt element i badges, matchet på setId og versionId; »Sådan får du det« er dets requirement.