Μετάβαση στο περιεχόμενο
Twitch Drops API

Αναφορά του Twitch Drops API

Ένα δωρεάν JSON API με κάθε ενεργή καμπάνια Twitch Drops και ανταμοιβών, που ανανεώνεται κάθε λεπτό, και με τα καθολικά σήματα συνομιλίας του Twitch. Καλέστε το ανώνυμα ή με ένα δωρεάν κλειδί API για υψηλότερο όριο.

Βασικό URLhttps://drops.sunkwi.com/api/twitch
Αποκτήστε δωρεάν κλειδί APIΔιαβάστε την αναφορά

Δοκιμάστε το

Ανώνυμα: 1 αίτημα κάθε 5 λεπ. ανά διαδρομή. Με κλειδί: 1 ανά λεπτό.

GET
Φόρτωση προεπισκόπησης…
Περιήγηση

Διαδρομές

Κάθε διαδρομή απαντά με JSON σε ένα αίτημα GET και τα προγράμματα περιήγησης οποιουδήποτε ιστότοπου μπορούν να καλέσουν το API (CORS). Ούτε το /drops, ούτε το /rewards, ούτε το /badges απαιτούν εγγραφή· ένα δωρεάν κλειδί API ανεβάζει το όριο σε καθένα από αυτά.

Και οι τρεις διαδρομές απαντούν με τον ίδιο τρόπο: η λίστα, η ώρα της τελευταίας ανάγνωσης του Twitch (refreshedAt) και το όριο αιτημάτων σας (rateLimit).

ΔιαδρομήΠεριγραφή
GET /dropsΚαμπάνιες Drops ανά παιχνίδι. Κάθε ενεργή καμπάνια Drops, ομαδοποιημένη ανά παιχνίδι, στο games: ένα στοιχείο ανά παιχνίδι, με τις καμπάνιες του στο rewards.
GET /rewardsΚαμπάνιες ανταμοιβών. Κάθε ενεργή καμπάνια ανταμοιβών (εκδηλώσεις σε όλο το Twitch, σήματα συνομιλίας, ανταμοιβές συνεργατών), στο campaigns.
GET /badgesΚαθολικά σήματα συνομιλίας. Τα καθολικά σήματα συνομιλίας του Twitch, ένα στοιχείο ανά έκδοση στο badges, με τον τρόπο απόκτησης όταν είναι γνωστός.

Έλεγχος ταυτότητας

Η ανάγνωση των /drops, /rewards και /badges δεν απαιτεί λογαριασμό ούτε κλειδί. Οι ανώνυμες κλήσεις μετρώνται ανά διεύθυνση IP: 1 αίτημα κάθε 5 λεπ. σε κάθε διαδρομή.

Τα κλειδιά είναι δωρεάν: συνδεθείτε με 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

Ένα κλειδί είναι δωρεάν. Αυξάνει το όριό σας από 1 αίτημα κάθε 5 λεπ. σε 1 αίτημα ανά λεπτό σε κάθε διαδρομή, και ο πίνακας ελέγχου σας δείχνει την κίνησή του.

  1. Συνδεθείτε με Discord, Twitch ή GitHub: χωρίς κωδικό πρόσβασης, χωρίς φόρμα.
  2. Ανοίξτε τα Κλειδιά API στον πίνακα ελέγχου σας και δημιουργήστε ένα κλειδί με το όνομα του bot ή του ιστότοπού σας.
  3. Αντιγράψτε το κλειδί όταν εμφανιστεί (μόνο μία φορά) και στείλτε το στην κεφαλίδα X-API-Key, από τον διακομιστή σας.

Λήψη καμπανιών Drops

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

Κάθε ενεργή καμπάνια Drops, ομαδοποιημένη ανά παιχνίδι: ένα στοιχείο του games ανά παιχνίδι, με τις καμπάνιες του στο rewards, μαζί με την ώρα της τελευταίας σάρωσης του Twitch και το όριο αιτημάτων σας.

Σώμα απάντησης

ΠεδίοΤύποςΠεριγραφή
gamesGame[]Οι ενεργές καμπάνιες, με τη σειρά της τελευταίας σάρωσης. Ένας κενός πίνακας είναι έγκυρη απάντηση.
refreshedAtstring (ISO 8601) | nullΏρα της τελευταίας επιτυχούς σάρωσης του Twitch, null πριν από την πρώτη.
rateLimit{ limit, remaining, resetAt }Το όριό σας σε αυτή τη διαδρομή μετά από αυτή την κλήση, όπως το δίνουν οι κεφαλίδες ratelimit-*: limit αιτήματα ανά παράθυρο, remaining που επιτρέπονται ακόμη, και resetAt, πότε επιστρέφει ολόκληρο το όριο (ISO 8601).

Game

Ένα στοιχείο του games.

ΠεδίοΤύποςΠεριγραφή
gameIdstringΑναγνωριστικό Twitch του παιχνιδιού.
gameDisplayNamestringΌνομα του παιχνιδιού.
gameBoxArtURLstring (URL)Εξώφυλλο του παιχνιδιού, 120×160.
startAtstring (ISO 8601)Έναρξη της πρώτης καμπάνιας του παιχνιδιού.
endAtstring (ISO 8601)Λήξη της τελευταίας καμπάνιας του παιχνιδιού.
rewardsDropCampaign[]Οι καμπάνιες Drops του παιχνιδιού.
Πεδία DropCampaign, TimeBasedDrop και Benefit

DropCampaign

Μια καμπάνια Drops, στο rewards ενός παιχνιδιού.

ΠεδίοΤύποςΠεριγραφή
idstringΑναγνωριστικό Twitch της καμπάνιας.
name, descriptionstringΌνομα και περιγραφή από τον εκδότη.
owner{ id, name }Ο εκδότης που διοργανώνει την καμπάνια.
game{ id, displayName, slug }Το παιχνίδι της καμπάνιας.
statusstringΚατάσταση στο Twitch, ACTIVE για καμπάνια σε εξέλιξη.
startAt, endAtstring (ISO 8601)Περίοδος διεξαγωγής της καμπάνιας.
imageURLstring (URL)Εικόνα της καμπάνιας.
detailsURL, accountLinkURLstring (URL)Σελίδα λεπτομερειών και σελίδα σύνδεσης λογαριασμού του εκδότη.
allow{ isEnabled, channels? }Κανάλια που επιτρέπεται να δίνουν τα Drops όταν το isEnabled είναι true. Διαφορετικά, οποιοδήποτε κανάλι μεταδίδει το παιχνίδι. Το displayName μπορεί να είναι null ή να λείπει.
timeBasedDropsTimeBasedDrop[]Drops που κερδίζονται με παρακολούθηση.
eventBasedDropsunknown[]Drops που κερδίζονται μέσω εκδηλώσεων, όπως τα στέλνει το Twitch.
firstSeenAtstring (ISO 8601) | nullΠότε αυτό το API είδε την καμπάνια για πρώτη φορά. Μια καμπάνια που επιστρέφει λιγότερο από μία ημέρα αφού έφυγε από τη λίστα κρατά την ημερομηνία της. null για τις καμπάνιες που το API ήδη παρείχε όταν εμφανίστηκε αυτό το πεδίο.

TimeBasedDrop

Ένα Drop που κερδίζεται με παρακολούθηση, στο timeBasedDrops.

ΠεδίοΤύποςΠεριγραφή
id, namestringΑναγνωριστικό Twitch και όνομα του Drop.
startAt, endAtstring (ISO 8601)Περίοδος κατά την οποία μπορεί να κερδηθεί το Drop.
requiredMinutesWatchednumberΛεπτά παρακολούθησης που απαιτούνται.
requiredSubsnumberΣυνδρομές που απαιτούνται.
repeat{ everyHours, times } | nullΠροστίθεται από αυτό το API: πόσο συχνά κερδίζεται ξανά το Drop, με times (πόσες φορές) και everyHours (24: μία φορά την ημέρα· null όταν το Twitch δεν το λέει). Το requiredMinutesWatched είναι τότε ο χρόνος παρακολούθησης μίας περιόδου. null για Drop που κερδίζεται μία φορά.
preconditionDropsunknownDrops που πρέπει να κερδηθούν πρώτα, όπως τα στέλνει το Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Τι δίνει το Drop και πόσες φορές μπορεί να παραληφθεί.

Benefit

Ένα αντικείμενο παιχνιδιού, στο benefitEdges.

ΠεδίοΤύποςΠεριγραφή
id, namestringΑναγνωριστικό Twitch και όνομα του αντικειμένου.
imageAssetURLstring (URL)Εικόνα του αντικειμένου.
createdAtstring (ISO 8601)Ημερομηνία δημιουργίας του αντικειμένου στο Twitch.
distributionTypestringΠώς παραδίδεται το αντικείμενο: DIRECT_ENTITLEMENT για αντικείμενο παιχνιδιού, BADGE για σήμα συνομιλίας.
entitlementLimitnumberΠόσες φορές μπορεί να παραληφθεί το αντικείμενο.
isIosAvailablebooleanΑν το αντικείμενο μπορεί να παραληφθεί σε iOS.
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.

ΠεδίοΤύποςΠεριγραφή
id, name, brandstringΑναγνωριστικό Twitch, όνομα και μάρκα της καμπάνιας.
statusstringΚατάσταση τη στιγμή του αιτήματος, βάσει των ημερομηνιών: UPCOMING πριν από το startsAt, ACTIVE έως το endsAt, έπειτα EXPIRED.
summary, instructionsstringΚείμενα που εμφανίζει το Twitch.
startsAt, endsAtstring (ISO 8601)Περίοδος διεξαγωγής της καμπάνιας.
image{ image1xURL }Εικόνα της καμπάνιας.
aboutURL, externalURLstring (URL)Σελίδα βοήθειας και εξωτερική σελίδα της καμπάνιας.
isSitewidebooleanΑν μετράει κάθε κανάλι, όχι μόνο εκείνα ενός παιχνιδιού.
game{ id, displayName, slug }?Το παιχνίδι της καμπάνιας, όταν υπάρχει.
rewardValueURLParamstringΤιμή που προσθέτει το Twitch στους συνδέσμους εξαργύρωσης.
unlockRequirements{ minuteWatchedGoal, subsGoal }Λεπτά παρακολούθησης και συνδρομές που απαιτούνται.
rewardGroupsRewardGroup[]?Ανταμοιβές που κερδίζονται μία ομάδα τη φορά, κάθε ομάδα με τον δικό της στόχο: μία ανταμοιβή την ημέρα σημαίνει μία ομάδα την ημέρα. Μόνο όταν τις στέλνει το Twitch.
rewardsReward[]Οι ανταμοιβές της καμπάνιας, μαζί με εκείνες των ομάδων της, η καθεμία μία φορά.
firstSeenAtstring (ISO 8601) | nullΠότε αυτό το API είδε την καμπάνια για πρώτη φορά. Μια καμπάνια που επιστρέφει λιγότερο από μία ημέρα αφού έφυγε από τη λίστα κρατά την ημερομηνία της. null για τις καμπάνιες που το API ήδη παρείχε όταν εμφανίστηκε αυτό το πεδίο.
Πεδία ανταμοιβών

RewardGroup

Μια ομάδα ανταμοιβών μιας καμπάνιας ανταμοιβών, που κερδίζονται μαζί.

ΠεδίοΤύποςΠεριγραφή
idstringΑναγνωριστικό Twitch της ομάδας.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Τι απαιτεί η ομάδα. Το Twitch προσθέτει εδώ στόχους Turbo και εκδηλώσεων.
repeat{ everyHours, times } | nullΠόσο συχνά κερδίζεται ξανά η ομάδα, όπως το repeat ενός Drop: το minuteWatchedGoal είναι τότε ο χρόνος παρακολούθησης μίας περιόδου. null για ομάδα που κερδίζεται μία φορά.
categories{ id, displayName, slug }[]Οι κατηγορίες των οποίων τα ζωντανά κανάλια μετρούν, οποιαδήποτε από αυτές· κενό όταν το Twitch δεν ορίζει καμία.
rewardsReward[]Οι ανταμοιβές της ομάδας, που εμφανίζονται και στο rewards της καμπάνιας.

Reward

Μια ανταμοιβή μιας καμπάνιας ανταμοιβών.

ΠεδίοΤύποςΠεριγραφή
id, namestringΑναγνωριστικό Twitch και όνομα της ανταμοιβής.
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, ένα στοιχείο ανά έκδοση, το καθένα με τον τρόπο απόκτησης όταν το API τον γνωρίζει (requirement), μαζί με την ώρα της τελευταίας ανάγνωσης των σημάτων του Twitch και το όριο αιτημάτων σας.

Σώμα απάντησης

ΠεδίοΤύποςΠεριγραφή
badgesBadge[]Τα καθολικά σήματα, ένα στοιχείο ανά έκδοση. Ένας κενός πίνακας είναι έγκυρη απάντηση.
refreshedAtstring (ISO 8601) | nullΏρα της τελευταίας επιτυχούς ανάγνωσης των σημάτων του Twitch (κάθε 5 λεπτά), null πριν από την πρώτη.
rateLimit{ limit, remaining, resetAt }Το όριό σας σε αυτή τη διαδρομή μετά από αυτή την κλήση, όπως το δίνουν οι κεφαλίδες ratelimit-*: limit αιτήματα ανά παράθυρο, remaining που επιτρέπονται ακόμη, και resetAt, πότε επιστρέφει ολόκληρο το όριο (ISO 8601).

Badge

Ένα στοιχείο του badges: μία έκδοση ενός καθολικού σήματος συνομιλίας, όπως το παραθέτει τώρα το Twitch.

ΠεδίοΤύποςΠεριγραφή
setId, versionIdstringΤο σύνολο του σήματος και η έκδοσή του: μαζί προσδιορίζουν ένα σήμα (sub-gifter και 5).
title, descriptionstringΤο όνομά του και η περιγραφή του Twitch, στα αγγλικά.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Η εικόνα του σε 18, 36 και 72 pixel.
clickAction, clickUrlstring | nullΤι κάνει το Twitch όταν πατηθεί το σήμα, και ο σύνδεσμός του. null όταν το Twitch δεν δίνει κανέναν.
firstSeenAtstring (ISO 8601) | nullΠότε αυτό το API είδε το σήμα για πρώτη φορά. Ένα σήμα που επιστρέφει περισσότερες από 7 ημέρες αφού το αφαίρεσε το Twitch παίρνει νέα ημερομηνία· αν επιστρέψει νωρίτερα, κρατά την προηγούμενη. null για τα σήματα που υπήρχαν ήδη στην πρώτη του ανάγνωση.
requirementBadgeRequirement | nullΠώς αποκτάται. null όταν αυτό το API δεν το γνωρίζει.
Πεδία BadgeRequirement

BadgeRequirement

Πώς αποκτάται ένα σήμα: από την καμπάνια Drops που το δίνει (DROPS) ή από την περιγραφή του ίδιου του Twitch για ένα σήμα συνδρομής ή παρακολούθησης (TWITCH_DESCRIPTION).

ΠεδίοΤύποςΠεριγραφή
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS ή TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue ακριβώς όταν αρκεί η παρακολούθηση: μια καμπάνια DROPS που απαιτεί χρόνο παρακολούθησης (requiredMinutes πάνω από 0) και καμία συνδρομή (requiredSubs 0).
requiredMinutes, requiredSubsnumberΛεπτά παρακολούθησης, και συνδρομές ή δωρεές συνδρομών, που απαιτεί.
gameId, gameNamestringΤο παιχνίδι: το αναγνωριστικό Twitch του (null όταν είναι άγνωστο) και το όνομά του.
channels, channelCountstring[] (≤ 5), numberΤα πρώτα 5 κανάλια που το δίνουν (ονόματα χρήστη) και πόσα είναι συνολικά. 0: οποιοδήποτε κανάλι μεταδίδει το παιχνίδι.
startAt, endAtstring (ISO 8601) | nullΠότε διεξάγεται η καμπάνια. null για TWITCH_DESCRIPTION. Μια καμπάνια που έληξε παραμένει.
campaignId, campaignNamestring | nullΗ καμπάνια Drops. null για TWITCH_DESCRIPTION.
repeat{ everyHours, times } | nullΜόνο για DROPS: ο χρόνος παρακολούθησης ζητείται ξανά σε κάθε περίοδο, με το requiredMinutes να αφορά μία περίοδο, με times και everyHours (20 λεπτά την ημέρα για 3 ημέρες: times 3, everyHours 24)· αλλιώς null.
categories{ id, name }[] (≤ 50)Μόνο για DROPS: οι κατηγορίες των οποίων τα ζωντανά κανάλια μετρούν, οποιαδήποτε από αυτές (id και name, έως 50)· τα gameId και gameName είναι η πρώτη. Αλλιώς κενό.
collection{ chestSize, completeAll } | nullΜόνο για DROPS: το σήμα είναι μία από τις ανταμοιβές μιας συλλογής εκδήλωσης, της καμπάνιας. chestSize: βγαίνει από σεντούκι με τόσες ανταμοιβές, μία ανά σεντούκι, ποτέ κατ' επιλογή (null: δίνεται απευθείας). completeAll: δίνεται για την ολοκλήρωση όλης της συλλογής, μαζί με τις συνδρομές. Αλλιώς null.
evolvesFrom{ setId, versionId } | nullΜόνο για DROPS: το σήμα που πρέπει να έχετε επιλέξει στη συνομιλία πριν παρακολουθήσετε, με τα setId και versionId του σε αυτή τη λίστα: μια εξέλιξη Pokémon ζητά το προηγούμενο στάδιό της (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. Οι καμπάνιες αλλάζουν μία φορά το λεπτό και τα σήματα κάθε 5 λεπτά, οπότε οι συχνότερες κλήσεις δεν φέρνουν τίποτα νέο.

ΠελάτηςΌριο ανά διαδρομήΜέτρηση ανά
Ανώνυμα1 αίτημα κάθε 5 λεπ.Διεύθυνση IP
Με κλειδί API1 αίτημα ανά λεπτό από προεπιλογή, αυξάνεται κατόπιν αιτήματοςΚλειδί API

Κεφαλίδες απάντησης

Κεφαλίδες που διαβάζει και στέλνει το API.

ΚεφαλίδαΚατεύθυνσηΠεριγραφή
x-last-updated-atresponseΏρα της τελευταίας επιτυχούς ανάγνωσης του Twitch: η σάρωση για τα /drops και /rewards, τα σήματα για το /badges.
x-refresh-interval-secondsresponseΔευτερόλεπτα μεταξύ δύο αναγνώσεων του Twitch: οι συχνότερες κλήσεις επιστρέφουν τα ίδια δεδομένα (60 για τα /drops και /rewards, 300 για το /badges).
ratelimit-limitresponseΑιτήματα που επιτρέπονται στο παράθυρο, για αυτή τη διαδρομή.
ratelimit-remainingresponseΑιτήματα που απομένουν στο τρέχον παράθυρο.
ratelimit-resetresponseΔευτερόλεπτα μέχρι να επιτραπεί ξανά αίτημα.
ratelimit-policyresponseΗ πολιτική, στη μορφή <όριο>;w=<παράθυρο σε δευτερόλεπτα>.
retry-afterresponseΔευτερόλεπτα αναμονής πριν από νέα δοκιμή, σε απάντηση 429 ή 503.
x-api-keyrequestΤο κλειδί API σας: προαιρετικό σε κάθε διαδρομή.
x-api-key-statusresponseinvalid όταν το κλειδί που στάλθηκε είναι άγνωστο, ανακληθέν ή απενεργοποιημένο: η κλήση μετρήθηκε ως ανώνυμη, στο όριο της διεύθυνσης IP σας.
etagresponseΕτικέτα αυτής της απάντησης. Στείλτε την πίσω στο If-None-Match: όσο τα δεδομένα δεν έχουν αλλάξει, η απάντηση είναι 304 και δεν μετρά στο όριό σας.
if-none-matchrequestΤο ETag της τελευταίας σας απάντησης, προαιρετικό: μια λίστα χωρίς αλλαγές απαντά 304 Not Modified, δωρεάν.
Δεύτερη ανώνυμη κλήση μέσα σε 5 λεπ.
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: ένα στοιχείο ανά παιχνίδι, με τις καμπάνιες του στο rewards. Η προβολή «Πλέγμα» σχεδιάζει τα startAt και endAt κάθε καμπάνιας.
Μια σελίδα παιχνιδιού/drops/<game>/dropsΈνα στοιχείο του games, με αντιστοίχιση στο gameId. Κάθε καμπάνια είναι το games[i].rewards[j]. Οι ανταμοιβές της είναι τα benefitEdges των timeBasedDrops, με requiredMinutesWatched.
Ανταμοιβές/rewards/rewardscampaigns: ένα στοιχείο ανά καμπάνια ανταμοιβών, με τις ανταμοιβές της στο rewards και τις απαιτήσεις της στο unlockRequirements.
Μια σελίδα καμπάνιας ανταμοιβών/rewards/<campaign>/rewardsΈνα στοιχείο του campaigns, με αντιστοίχιση στο id. Οι ανταμοιβές του βρίσκονται στο rewards.
Σήματα/badges/badgesbadges: όλα τα στοιχεία, πρώτα όσα έχουν requirement, με τον τρόπο απόκτησής τους. Η προβολή «Πλέγμα» σχεδιάζει τα requirement.startAt και requirement.endAt κάθε σήματος.
Μια σελίδα σήματος/badges/<badge>/badgesΈνα στοιχείο του badges, με αντιστοίχιση στα setId και versionId. Το «Πώς το αποκτάτε» είναι το requirement του.