Pereiti prie turinio
Twitch Drops API

Twitch Drops API žinynas

Nemokama JSON API su visomis aktyviomis Twitch Drops ir apdovanojimų kampanijomis, atnaujinamomis kas minutę, ir Twitch visuotiniais pokalbių ženkleliais. Kreipkitės anonimiškai arba su nemokamu API raktu, kad gautumėte didesnį limitą.

Bazinis URLhttps://drops.sunkwi.com/api/twitch
Gauti nemokamą API raktąSkaityti žinyną

Išbandykite

Anonimiškai: 1 užklausa kas 5 min. kiekvienam maršrutui. Su raktu: 1 per minutę.

GET
Įkeliama peržiūra…
Naršyti

Maršrutai

Kiekvienas maršrutas į GET užklausą atsako JSON formatu, o bet kurios svetainės naršyklės gali kreiptis į API (CORS). Nei /drops, nei /rewards, nei /badges nereikia registruotis; nemokamas API raktas kiekviename iš jų pakelia ribą.

Visi trys maršrutai atsako vienodai: sąrašas, paskutinio duomenų gavimo iš Twitch laikas (refreshedAt) ir jūsų užklausų limitas (rateLimit).

MaršrutasAprašymas
GET /dropsDrops kampanijos pagal žaidimą. Visos aktyvios Drops kampanijos, sugrupuotos pagal žaidimą, masyve games: vienas elementas kiekvienam žaidimui, jo kampanijos – rewards.
GET /rewardsApdovanojimų kampanijos. Visos aktyvios apdovanojimų kampanijos (renginiai visoje Twitch platformoje, pokalbių ženkleliai, partnerių apdovanojimai), masyve campaigns.
GET /badgesVisuotiniai pokalbių ženkleliai. Twitch visuotiniai pokalbių ženkleliai, po vieną elementą kiekvienai versijai masyve badges, su gavimo būdu, kai jis žinomas.

Autentifikavimas

/drops, /rewards ir /badges skaitymui nereikia nei paskyros, nei rakto. Anoniminiai iškvietimai skaičiuojami pagal IP adresą: 1 užklausa kas 5 min. kiekvienam maršrutui.

Raktai nemokami: prisijunkite su Discord, Twitch ar GitHub, sukurkite raktą valdymo skydelyje ir siųskite jį antraštėje X-API-Key. Pagal numatytuosius nustatymus raktas padidina jūsų limitą iki 1 užklausa per minutę (paprašius – daugiau) ir rodo jūsų srautą.

Užklausos antraštė

AntraštėReikšmėAprašymas
X-API-Keyjdk_…Jūsų API raktas: neprivalomas kiekviename maršrute. Nežinomas, panaikintas ar išjungtas raktas niekada neatmetamas: iškvietimas laikomas anoniminiu, ir tai nurodo x-api-key-status: invalid.
Užklausos pavyzdys · 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

Gaukite nemokamą API raktą

Raktas nemokamas. Jis padidina jūsų limitą nuo 1 užklausos kas 5 min. iki 1 užklausa per minutę kiekvienam maršrutui, o valdymo skydelyje matysite jo srautą.

  1. Prisijunkite su Discord, Twitch ar GitHub: be slaptažodžio, be formų.
  2. Valdymo skydelyje atidarykite API raktai ir sukurkite raktą savo boto ar svetainės pavadinimu.
  3. Nukopijuokite raktą, kai jis bus parodytas (tik vieną kartą), ir siųskite jį antraštėje X-API-Key iš savo serverio.

Gauti Drops kampanijas

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

Visos aktyvios Drops kampanijos, sugrupuotos pagal žaidimą: vienas games elementas kiekvienam žaidimui, jo kampanijos – rewards, kartu su paskutinio Twitch nuskaitymo laiku ir jūsų užklausų limitu.

Atsakymo turinys

LaukasTipasAprašymas
gamesGame[]Aktyvios kampanijos, paskutinio nuskaitymo tvarka. Tuščias masyvas – tinkamas atsakymas.
refreshedAtstring (ISO 8601) | nullPaskutinio sėkmingo Twitch nuskaitymo laikas, null iki pirmojo.
rateLimit{ limit, remaining, resetAt }Jūsų limitas šiame maršrute po šio iškvietimo, kaip jį nurodo antraštės ratelimit-*: limit užklausų per langą, remaining dar leidžiamų ir resetAt – kada visas limitas atsistato (ISO 8601).

Game

Vienas games elementas.

LaukasTipasAprašymas
gameIdstringŽaidimo Twitch ID.
gameDisplayNamestringŽaidimo pavadinimas.
gameBoxArtURLstring (URL)Žaidimo viršelis, 120×160.
startAtstring (ISO 8601)Ankstyviausios žaidimo kampanijos pradžia.
endAtstring (ISO 8601)Vėliausios žaidimo kampanijos pabaiga.
rewardsDropCampaign[]Žaidimo Drops kampanijos.
DropCampaign, TimeBasedDrop ir Benefit laukai

DropCampaign

Drops kampanija žaidimo rewards sąraše.

LaukasTipasAprašymas
idstringKampanijos Twitch ID.
name, descriptionstringLeidėjo nurodytas pavadinimas ir aprašymas.
owner{ id, name }Kampaniją vykdantis leidėjas.
game{ id, displayName, slug }Kampanijos žaidimas.
statusstringTwitch būsena, vykstančios kampanijos – ACTIVE.
startAt, endAtstring (ISO 8601)Kampanijos vykdymo laikotarpis.
imageURLstring (URL)Kampanijos iliustracija.
detailsURL, accountLinkURLstring (URL)Leidėjo informacijos puslapis ir paskyros susiejimo puslapis.
allow{ isEnabled, channels? }Kanalai, kuriems leidžiama dalyti Drops, kai isEnabled yra true; kitu atveju – bet kuris žaidimą transliuojantis kanalas. displayName gali būti null arba jo gali nebūti.
timeBasedDropsTimeBasedDrop[]Drops, gaunami žiūrint.
eventBasedDropsunknown[]Drops, gaunami už renginius, perduodami tokie, kokius pateikia Twitch.
firstSeenAtstring (ISO 8601) | nullKada ši API pirmą kartą pamatė kampaniją. Kampanija, grįžusi į sąrašą praėjus mažiau nei parai po to, kai iš jo dingo, išlaiko savo datą. null kampanijoms, kurias API jau teikė, kai atsirado šis laukas.

TimeBasedDrop

Žiūrint gaunamas Drop, timeBasedDrops sąraše.

LaukasTipasAprašymas
id, namestringDrop Twitch ID ir pavadinimas.
startAt, endAtstring (ISO 8601)Laikotarpis, per kurį galima gauti Drop.
requiredMinutesWatchednumberKiek minučių reikia žiūrėti.
requiredSubsnumberKiek reikia prenumeratų.
repeat{ everyHours, times } | nullPrideda ši API: kaip dažnai Drop gaunamas vėl, su times (kiek kartų) ir everyHours (24: kartą per dieną; null, kai Twitch nenurodo). Tada requiredMinutesWatched yra vieno laikotarpio žiūrėjimo laikas. null, kai Drop gaunamas vieną kartą.
preconditionDropsunknownDrops, kuriuos reikia gauti pirmiau, perduodami tokie, kokius pateikia Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Ką duoda Drop ir kiek kartų tai galima atsiimti.

Benefit

Žaidimo daiktas benefitEdges sąraše.

LaukasTipasAprašymas
id, namestringDaikto Twitch ID ir pavadinimas.
imageAssetURLstring (URL)Daikto paveikslėlis.
createdAtstring (ISO 8601)Daikto sukūrimo Twitch platformoje data.
distributionTypestringKaip daiktas pristatomas: DIRECT_ENTITLEMENT – žaidimo daiktas, BADGE – pokalbių ženklelis.
entitlementLimitnumberKiek kartų daiktą galima atsiimti.
isIosAvailablebooleanAr daiktą galima atsiimti iOS įrenginyje.
game, ownerOrganization{ id, name }Daikto žaidimas ir leidėjas.

Atsakymo kodai

BūsenaAprašymas
200Aktyvios kampanijos. Tuščias sąrašas – tinkamas atsakymas.
304Nuo išsiųsto ETag niekas nepasikeitė: pasilikite savo kopiją. Nemokamai, neįskaičiuojama į jūsų limitą.
429RATE_LIMITED: Palaukite tiek sekundžių, kiek nurodo Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Raktas neatpažintas, o jūsų IP adreso anoniminis limitas išnaudotas: pataisykite raktą.
503SERVICE_UNAVAILABLE: Sąrašas dar neįkeltas (iškart po API paleidimo iš naujo): bandykite vėl po Retry-After. Nemokamai, neįskaičiuojama į jūsų limitą.
Užklausos pavyzdys
curl https://drops.sunkwi.com/api/twitch/drops
Atsakymo pavyzdys · 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" }}

Gauti apdovanojimų kampanijas

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

Visos aktyvios apdovanojimų kampanijos (renginiai visoje Twitch platformoje, pokalbių ženkleliai, partnerių apdovanojimai) masyve campaigns, kartu su paskutinio Twitch nuskaitymo laiku ir jūsų užklausų limitu.

Atsakymo turinys

LaukasTipasAprašymas
campaignsRewardCampaign[]Aktyvios kampanijos, paskutinio nuskaitymo tvarka. Tuščias masyvas – tinkamas atsakymas.
refreshedAtstring (ISO 8601) | nullPaskutinio sėkmingo Twitch nuskaitymo laikas, null iki pirmojo.
rateLimit{ limit, remaining, resetAt }Jūsų limitas šiame maršrute po šio iškvietimo, kaip jį nurodo antraštės ratelimit-*: limit užklausų per langą, remaining dar leidžiamų ir resetAt – kada visas limitas atsistato (ISO 8601).

RewardCampaign

Vienas campaigns elementas.

LaukasTipasAprašymas
id, name, brandstringKampanijos Twitch ID, pavadinimas ir prekės ženklas.
statusstringBūsena užklausos metu, nustatoma pagal datas: UPCOMING prieš startsAt, ACTIVE iki endsAt, vėliau EXPIRED.
summary, instructionsstringTwitch rodomi tekstai.
startsAt, endsAtstring (ISO 8601)Kampanijos vykdymo laikotarpis.
image{ image1xURL }Kampanijos iliustracija.
aboutURL, externalURLstring (URL)Kampanijos pagalbos puslapis ir išorinis puslapis.
isSitewidebooleanAr įskaitomas bet kuris kanalas, o ne tik vieno žaidimo kanalai.
game{ id, displayName, slug }?Kampanijos žaidimas, jei jis yra.
rewardValueURLParamstringReikšmė, kurią Twitch prideda prie atsiėmimo nuorodų.
unlockRequirements{ minuteWatchedGoal, subsGoal }Kiek reikia žiūrėjimo minučių ir prenumeratų.
rewardGroupsRewardGroup[]?Apdovanojimai, gaunami po vieną grupę, kiekviena grupė su savo tikslu: apdovanojimas per dieną – tai grupė per dieną. Tik kai Twitch juos siunčia.
rewardsReward[]Kampanijos apdovanojimai, įskaitant jos grupių apdovanojimus, kiekvienas po vieną kartą.
firstSeenAtstring (ISO 8601) | nullKada ši API pirmą kartą pamatė kampaniją. Kampanija, grįžusi į sąrašą praėjus mažiau nei parai po to, kai iš jo dingo, išlaiko savo datą. null kampanijoms, kurias API jau teikė, kai atsirado šis laukas.
Apdovanojimų laukai

RewardGroup

Apdovanojimų kampanijos apdovanojimų grupė, gaunama kartu.

LaukasTipasAprašymas
idstringGrupės Twitch ID.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Ko reikalauja grupė. Twitch čia prideda Turbo ir renginių tikslus.
repeat{ everyHours, times } | nullKaip dažnai grupė gaunama vėl, kaip Drop repeat: tada minuteWatchedGoal yra vieno laikotarpio žiūrėjimo laikas. null, kai grupė gaunama vieną kartą.
categories{ id, displayName, slug }[]Kategorijos, kurių tiesioginiai kanalai įskaitomi, bet kuri iš jų; tuščia, kai Twitch nenurodo nė vienos.
rewardsReward[]Grupės apdovanojimai, taip pat išvardyti kampanijos rewards sąraše.

Reward

Apdovanojimų kampanijos apdovanojimas.

LaukasTipasAprašymas
id, namestringApdovanojimo Twitch ID ir pavadinimas.
bannerImage, thumbnailImage{ image1xURL }Apdovanojimo paveikslėliai.
earnableUntilstring (ISO 8601)Paskutinė akimirka, kai apdovanojimą dar galima gauti.
redemptionInstructions, redemptionURLstringKaip ir kur atsiimti apdovanojimą.

Atsakymo kodai

BūsenaAprašymas
200Aktyvios kampanijos. Tuščias sąrašas – tinkamas atsakymas.
304Nuo išsiųsto ETag niekas nepasikeitė: pasilikite savo kopiją. Nemokamai, neįskaičiuojama į jūsų limitą.
429RATE_LIMITED: Palaukite tiek sekundžių, kiek nurodo Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Raktas neatpažintas, o jūsų IP adreso anoniminis limitas išnaudotas: pataisykite raktą.
503SERVICE_UNAVAILABLE: Sąrašas dar neįkeltas (iškart po API paleidimo iš naujo): bandykite vėl po Retry-After. Nemokamai, neįskaičiuojama į jūsų limitą.
Užklausos pavyzdys
curl https://drops.sunkwi.com/api/twitch/rewards
Atsakymo pavyzdys · 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" }}

Gauti pokalbių ženklelius

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

Twitch visuotiniai pokalbių ženkleliai masyve badges, po vieną elementą kiekvienai versijai, kiekvienas su gavimo būdu, kai jį žino ši API (requirement), kartu su paskutinio Twitch ženklelių nuskaitymo laiku ir jūsų užklausų limitu.

Atsakymo turinys

LaukasTipasAprašymas
badgesBadge[]Visuotiniai ženkleliai, po vieną elementą kiekvienai versijai. Tuščias masyvas – tinkamas atsakymas.
refreshedAtstring (ISO 8601) | nullPaskutinio sėkmingo Twitch ženklelių nuskaitymo laikas (kas 5 minutes), null iki pirmojo.
rateLimit{ limit, remaining, resetAt }Jūsų limitas šiame maršrute po šio iškvietimo, kaip jį nurodo antraštės ratelimit-*: limit užklausų per langą, remaining dar leidžiamų ir resetAt – kada visas limitas atsistato (ISO 8601).

Badge

Vienas badges elementas: viena visuotinio pokalbių ženklelio versija, kaip ją dabar pateikia Twitch.

LaukasTipasAprašymas
setId, versionIdstringŽenklelių rinkinys ir jo versija: kartu jie nusako vieną ženklelį (sub-gifter ir 5).
title, descriptionstringJo pavadinimas ir Twitch aprašymas, anglų kalba.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Jo paveikslėlis 18, 36 ir 72 pikselių dydžio.
clickAction, clickUrlstring | nullKą Twitch daro paspaudus ženklelį, ir susijusi nuoroda; null, kai Twitch jos nepateikia.
firstSeenAtstring (ISO 8601) | nullKada ši API pirmą kartą pamatė ženklelį. Ženklelis, grįžęs praėjus daugiau nei 7 dienoms po to, kai Twitch jį pašalino, gauna naują datą; grįžęs anksčiau, išlaiko ankstesnę. null ženkleliams, kurie jau buvo per pirmąjį jos nuskaitymą.
requirementBadgeRequirement | nullKaip jį gauti; null, kai ši API nežino.
BadgeRequirement laukai

BadgeRequirement

Kaip gauti ženklelį: iš jį duodančios Drops kampanijos (DROPS) arba iš paties Twitch prenumeratos ar žiūrėjimo ženklelio aprašymo (TWITCH_DESCRIPTION).

LaukasTipasAprašymas
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS arba TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue tik tada, kai užtenka žiūrėti: DROPS kampanija, reikalaujanti žiūrėjimo laiko (requiredMinutes daugiau nei 0) ir jokios prenumeratos (requiredSubs lygu 0).
requiredMinutes, requiredSubsnumberKiek reikia žiūrėjimo minučių ir prenumeratų ar dovanotų prenumeratų.
gameId, gameNamestringŽaidimas: jo Twitch ID (null, kai nežinomas) ir pavadinimas.
channels, channelCountstring[] (≤ 5), numberPirmieji 5 jį duodantys kanalai (prisijungimo vardai) ir kiek jų iš viso; 0: bet kuris žaidimą transliuojantis kanalas.
startAt, endAtstring (ISO 8601) | nullKampanijos vykdymo laikotarpis; TWITCH_DESCRIPTION atveju – null. Pasibaigusi kampanija lieka sąraše.
campaignId, campaignNamestring | nullDrops kampanija; TWITCH_DESCRIPTION atveju – null.
repeat{ everyHours, times } | nullTik DROPS: žiūrėjimo laikas reikalingas vėl kiekvieną laikotarpį, o requiredMinutes yra vieno laikotarpio, su times ir everyHours (20 min per dieną 3 dienas: times 3, everyHours 24); kitaip null.
categories{ id, name }[] (≤ 50)Tik DROPS: kategorijos, kurių tiesioginiai kanalai įskaitomi, bet kuri iš jų (id ir name, daugiausia 50); gameId ir gameName yra pirmoji. Kitaip tuščia.
collection{ chestSize, completeAll } | nullTik DROPS: ženklelis yra vienas iš renginio kolekcijos, t. y. kampanijos, apdovanojimų. chestSize: jis iškrenta iš skrynios su tiek apdovanojimų, po vieną iš skrynios, niekada pasirinktinai (null: duodamas tiesiogiai). completeAll: duodamas užbaigus visą kolekciją, įskaitant prenumeratas. Kitaip null.
evolvesFrom{ setId, versionId } | nullTik DROPS: ženklelis, kurį prieš žiūrint reikia pasirinkti pokalbyje, nurodytas jo setId ir versionId šiame sąraše: Pokémon evoliucijai reikia ankstesnės stadijos (Pikachu: Pichu). Kitais atvejais null, arba kai nežinomas.

Atsakymo kodai

BūsenaAprašymas
200Visuotiniai ženkleliai. Tuščias sąrašas – tinkamas atsakymas.
304Nuo išsiųsto ETag niekas nepasikeitė: pasilikite savo kopiją. Nemokamai, neįskaičiuojama į jūsų limitą.
429RATE_LIMITED: Palaukite tiek sekundžių, kiek nurodo Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Raktas neatpažintas, o jūsų IP adreso anoniminis limitas išnaudotas: pataisykite raktą.
503SERVICE_UNAVAILABLE: Sąrašas dar neįkeltas (iškart po API paleidimo iš naujo): bandykite vėl po Retry-After. Nemokamai, neįskaičiuojama į jūsų limitą.
Užklausos pavyzdys
curl https://drops.sunkwi.com/api/twitch/badges
Įkeliama peržiūra…

Užklausų limitai

Kiekvienas maršrutas turi savo skaitiklį: /drops iškvietimai niekada nenaudoja /rewards ar /badges limito. Kampanijos keičiasi kartą per minutę, o ženkleliai – kas 5 minutes, tad dažnesnės užklausos nieko naujo neduoda.

KlientasLimitas maršrutuiSkaičiuojama pagal
Anonimiškai1 užklausa kas 5 min.IP adresas
Su API raktuNumatytasis – 1 užklausa per minutę, paprašius – daugiauAPI raktas

Atsakymo antraštės

Antraštės, kurias API skaito ir siunčia.

AntraštėKryptisAprašymas
x-last-updated-atresponsePaskutinio sėkmingo duomenų gavimo iš Twitch laikas: nuskaitymo – /drops ir /rewards, ženklelių – /badges.
x-refresh-interval-secondsresponseSekundės tarp dviejų duomenų gavimų iš Twitch: dažnesnės užklausos grąžina tuos pačius duomenis (60 – /drops ir /rewards, 300 – /badges).
ratelimit-limitresponseKiek užklausų šiam maršrutui leidžiama per langą.
ratelimit-remainingresponseKiek užklausų liko dabartiniame lange.
ratelimit-resetresponsePo kiek sekundžių vėl bus leidžiama siųsti užklausą.
ratelimit-policyresponsePolitika formatu <limitas>;w=<langas sekundėmis>.
retry-afterresponseKiek sekundžių palaukti prieš bandant vėl, gavus 429 arba 503 atsakymą.
x-api-keyrequestJūsų API raktas: neprivalomas kiekviename maršrute.
x-api-key-statusresponseinvalid, kai išsiųstas raktas nežinomas, panaikintas ar išjungtas: iškvietimas įskaitytas kaip anoniminis, į jūsų IP adreso limitą.
etagresponseŠio atsakymo žymė. Grąžinkite ją If-None-Match antraštėje: kol duomenys nepasikeitė, atsakymas yra 304, kuris neįskaičiuojamas į jūsų limitą.
if-none-matchrequestPaskutinio jūsų atsakymo ETag, neprivaloma: nepasikeitęs sąrašas atsako 304 Not Modified, nemokamai.
Antras anoniminis iškvietimas per 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" }

Klaidos

Klaidos grąžina JSON turinį su pastoviu kodu: { "code": "RATE_LIMITED" }. Kodai niekada nesikeičia: remkitės code, o ne pranešimo tekstu.

BūsenaKodasAprašymas
429RATE_LIMITEDPer daug užklausų šiam maršrutui: palaukite tiek sekundžių, kiek nurodo Retry-After.
429INVALID_API_KEY_RATE_LIMITEDPer daug užklausų, o antraštėje X-API-Key yra nežinomas, panaikintas ar išjungtas raktas: iškvietimas įskaitytas kaip anoniminis. Pataisykite raktą arba palaukite tiek sekundžių, kiek nurodo Retry-After.
503SERVICE_UNAVAILABLESąrašas dar neįkeltas (iškart po API paleidimo iš naujo). Niekas neišnaudojama: bandykite vėl po tiek sekundžių, kiek nurodo Retry-After.
404NOT_FOUNDTokio maršruto nėra.
500INTERNAL_SERVER_ERRORServerio klaida: bandykite vėliau.
Klaidos pavyzdys
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

Nuo svetainės iki API

Kiekvienas šios svetainės puslapis skaito tuos pačius maršrutus. Štai kur atsakymuose yra tai, ką rodo puslapis.

PuslapisMaršrutasKur atsakyme
Drops/drops/dropsgames: vienas elementas kiekvienam žaidimui, jo kampanijos – rewards. Rodinys „Tinklelis“ vaizduoja kiekvienos kampanijos startAt ir endAt.
Žaidimo puslapis/drops/<game>/dropsVienas games elementas, surastas pagal gameId. Kiekviena kampanija – games[i].rewards[j]; jos apdovanojimai – timeBasedDrops laukų benefitEdges, su requiredMinutesWatched.
Apdovanojimai/rewards/rewardscampaigns: vienas elementas kiekvienai apdovanojimų kampanijai, jos apdovanojimai – rewards, o reikalavimai – unlockRequirements.
Apdovanojimų kampanijos puslapis/rewards/<campaign>/rewardsVienas campaigns elementas, surastas pagal id; jo apdovanojimai – rewards.
Ženkleliai/badges/badgesbadges: visi elementai, pirmiau tie, kurie turi requirement, su gavimo būdu. Rodinys „Tinklelis“ vaizduoja kiekvieno ženklelio requirement.startAt ir requirement.endAt.
Ženklelio puslapis/badges/<badge>/badgesVienas badges elementas, surastas pagal setId ir versionId; „Kaip gauti“ – tai jo requirement.