Chuyển đến nội dung
Twitch Drops API

Tài liệu tham khảo Twitch Drops API

API JSON miễn phí liệt kê mọi chiến dịch Twitch Drops và chiến dịch phần thưởng đang diễn ra, cập nhật mỗi phút, cùng các huy hiệu trò chuyện toàn cục của Twitch. Gọi ẩn danh, hoặc dùng khóa API miễn phí để có giới hạn cao hơn.

URL gốchttps://drops.sunkwi.com/api/twitch
Nhận khóa API miễn phíĐọc tài liệu tham khảo

Dùng thử

Ẩn danh: 1 yêu cầu mỗi 5 phút cho mỗi route. Có khóa: 1 yêu cầu mỗi phút.

GET
Đang tải bản xem trước…
Duyệt

Route

Mọi route đều trả về JSON cho yêu cầu GET, và trình duyệt của bất kỳ trang web nào cũng có thể gọi API (CORS). Không route nào trong số /drops, /rewards hay /badges cần đăng ký; khóa API miễn phí sẽ tăng giới hạn trên mỗi route.

Cả ba route đều trả lời giống nhau: danh sách, thời điểm đọc Twitch gần nhất (refreshedAt) và giới hạn tần suất của bạn (rateLimit).

RouteMô tả
GET /dropsChiến dịch Drops theo game. Mọi chiến dịch Drops đang diễn ra, nhóm theo game, trong games: mỗi game một mục, các chiến dịch của game nằm trong rewards.
GET /rewardsChiến dịch phần thưởng. Mọi chiến dịch phần thưởng đang diễn ra (sự kiện toàn Twitch, huy hiệu trò chuyện, phần thưởng đối tác), trong campaigns.
GET /badgesHuy hiệu trò chuyện toàn cục. Các huy hiệu trò chuyện toàn cục của Twitch, mỗi phiên bản một mục trong badges, kèm cách nhận khi biết.

Xác thực

Đọc /drops, /rewards và /badges không cần tài khoản hay khóa. Lệnh gọi ẩn danh được tính theo địa chỉ IP: 1 yêu cầu mỗi 5 phút trên mỗi route.

Khóa hoàn toàn miễn phí: đăng nhập bằng Discord, Twitch hoặc GitHub, tạo khóa trong bảng điều khiển và gửi khóa trong header X-API-Key. Theo mặc định, khóa nâng giới hạn của bạn lên 1 yêu cầu mỗi phút, có thể nâng thêm khi có yêu cầu, và cho bạn xem lưu lượng của mình.

Header yêu cầu

HeaderGiá trịMô tả
X-API-Keyjdk_…Khóa API của bạn: không bắt buộc trên mọi route. Khóa không xác định, đã thu hồi hoặc bị vô hiệu hóa không bao giờ bị từ chối: lệnh gọi được tính là ẩn danh, và x-api-key-status: invalid cho biết điều đó.
Ví dụ yêu cầu · 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

Nhận khóa API miễn phí

Khóa hoàn toàn miễn phí. Khóa nâng giới hạn của bạn từ 1 yêu cầu mỗi 5 phút lên 1 yêu cầu mỗi phút trên mỗi route, và bảng điều khiển cho bạn xem lưu lượng của khóa.

  1. Đăng nhập bằng Discord, Twitch hoặc GitHub: không mật khẩu, không biểu mẫu.
  2. Mở Khóa API trong bảng điều khiển và tạo một khóa đặt theo tên bot hoặc trang web của bạn.
  3. Sao chép khóa khi khóa hiển thị (chỉ một lần) và gửi khóa trong header X-API-Key, từ máy chủ của bạn.

Lấy chiến dịch Drops

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

Mọi chiến dịch Drops đang diễn ra, nhóm theo game: mỗi game một mục trong games, các chiến dịch của game nằm trong rewards, kèm thời điểm của lần quét Twitch gần nhất và giới hạn tần suất của bạn.

Body phản hồi

TrườngKiểuMô tả
gamesGame[]Các chiến dịch đang diễn ra, theo thứ tự của lần quét gần nhất. Mảng rỗng vẫn là phản hồi hợp lệ.
refreshedAtstring (ISO 8601) | nullThời điểm của lần quét Twitch thành công gần nhất, null trước lần quét đầu tiên.
rateLimit{ limit, remaining, resetAt }Giới hạn của bạn trên route này sau lần gọi này, đúng như các header ratelimit-* cho biết: limit yêu cầu mỗi khung thời gian, remaining yêu cầu còn được phép, và resetAt, thời điểm giới hạn được phục hồi hoàn toàn (ISO 8601).

Game

Một mục của games.

TrườngKiểuMô tả
gameIdstringID Twitch của game.
gameDisplayNamestringTên game.
gameBoxArtURLstring (URL)Ảnh bìa game, 120×160.
startAtstring (ISO 8601)Thời điểm bắt đầu của chiến dịch sớm nhất của game.
endAtstring (ISO 8601)Thời điểm kết thúc của chiến dịch muộn nhất của game.
rewardsDropCampaign[]Các chiến dịch Drops của game.
Các trường DropCampaign, TimeBasedDrop và Benefit

DropCampaign

Một chiến dịch Drops, trong rewards của một game.

TrườngKiểuMô tả
idstringID Twitch của chiến dịch.
name, descriptionstringTên và mô tả do nhà phát hành đặt.
owner{ id, name }Nhà phát hành tổ chức chiến dịch.
game{ id, displayName, slug }Game của chiến dịch.
statusstringTrạng thái Twitch, ACTIVE với chiến dịch đang diễn ra.
startAt, endAtstring (ISO 8601)Thời gian diễn ra chiến dịch.
imageURLstring (URL)Ảnh minh họa chiến dịch.
detailsURL, accountLinkURLstring (URL)Trang chi tiết và trang liên kết tài khoản của nhà phát hành.
allow{ isEnabled, channels? }Các kênh được phép trao Drops khi isEnabled là true; nếu không, mọi kênh đang phát game. displayName có thể là null hoặc không có.
timeBasedDropsTimeBasedDrop[]Drops nhận được bằng cách xem.
eventBasedDropsunknown[]Drops nhận được qua sự kiện, chuyển nguyên từ Twitch.
firstSeenAtstring (ISO 8601) | nullThời điểm API này thấy chiến dịch lần đầu. Chiến dịch quay lại trong vòng một ngày sau khi rời danh sách sẽ giữ thời điểm cũ. null cho các chiến dịch API đã cung cấp từ trước khi có trường này.

TimeBasedDrop

Một Drop nhận được bằng cách xem, trong timeBasedDrops.

TrườngKiểuMô tả
id, namestringID Twitch và tên của Drop.
startAt, endAtstring (ISO 8601)Khoảng thời gian có thể nhận Drop.
requiredMinutesWatchednumberSố phút xem cần thiết.
requiredSubsnumberSố lượt đăng ký cần thiết.
repeat{ everyHours, times } | nullDo API này thêm vào: tần suất nhận lại Drop, với times (số lần) và everyHours (24: mỗi ngày một lần; null khi Twitch không cho biết). Khi đó requiredMinutesWatched là thời gian xem của một chu kỳ. null với Drop chỉ nhận một lần.
preconditionDropsunknownDrops cần nhận trước, chuyển nguyên từ Twitch.
benefitEdges{ benefit: Benefit, entitlementLimit }[]Những gì Drop mang lại, kèm số lần có thể nhận.

Benefit

Một vật phẩm trong game, trong benefitEdges.

TrườngKiểuMô tả
id, namestringID Twitch và tên vật phẩm.
imageAssetURLstring (URL)Hình ảnh vật phẩm.
createdAtstring (ISO 8601)Ngày tạo vật phẩm trên Twitch.
distributionTypestringCách vật phẩm được trao: DIRECT_ENTITLEMENT cho vật phẩm trong game, BADGE cho huy hiệu trò chuyện.
entitlementLimitnumberSố lần có thể nhận vật phẩm.
isIosAvailablebooleanVật phẩm có thể nhận trên iOS hay không.
game, ownerOrganization{ id, name }Game và nhà phát hành của vật phẩm.

Mã phản hồi

Trạng tháiMô tả
200Các chiến dịch đang diễn ra. Danh sách rỗng vẫn là phản hồi hợp lệ.
304Không có gì thay đổi kể từ ETag bạn đã gửi: hãy giữ bản sao của bạn. Miễn phí, không tính vào giới hạn của bạn.
429RATE_LIMITED: Hãy chờ số giây ghi trong Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Không nhận ra khóa và giới hạn ẩn danh của địa chỉ IP của bạn đã hết: hãy sửa khóa.
503SERVICE_UNAVAILABLE: Chưa có danh sách nào được tải (ngay sau khi API khởi động lại): hãy thử lại sau Retry-After. Miễn phí, không tính vào giới hạn của bạn.
Ví dụ yêu cầu
curl https://drops.sunkwi.com/api/twitch/drops
Ví dụ phản hồi · 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" }}

Lấy chiến dịch phần thưởng

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

Mọi chiến dịch phần thưởng đang diễn ra (sự kiện toàn Twitch, huy hiệu trò chuyện, phần thưởng đối tác) trong campaigns, kèm thời điểm của lần quét Twitch gần nhất và giới hạn tần suất của bạn.

Body phản hồi

TrườngKiểuMô tả
campaignsRewardCampaign[]Các chiến dịch đang diễn ra, theo thứ tự của lần quét gần nhất. Mảng rỗng vẫn là phản hồi hợp lệ.
refreshedAtstring (ISO 8601) | nullThời điểm của lần quét Twitch thành công gần nhất, null trước lần quét đầu tiên.
rateLimit{ limit, remaining, resetAt }Giới hạn của bạn trên route này sau lần gọi này, đúng như các header ratelimit-* cho biết: limit yêu cầu mỗi khung thời gian, remaining yêu cầu còn được phép, và resetAt, thời điểm giới hạn được phục hồi hoàn toàn (ISO 8601).

RewardCampaign

Một mục của campaigns.

TrườngKiểuMô tả
id, name, brandstringID Twitch, tên và thương hiệu của chiến dịch.
statusstringTrạng thái tại thời điểm gửi yêu cầu, tính theo ngày: UPCOMING trước startsAt, ACTIVE đến endsAt, sau đó là EXPIRED.
summary, instructionsstringNội dung do Twitch hiển thị.
startsAt, endsAtstring (ISO 8601)Thời gian diễn ra chiến dịch.
image{ image1xURL }Ảnh minh họa chiến dịch.
aboutURL, externalURLstring (URL)Trang trợ giúp và trang bên ngoài của chiến dịch.
isSitewidebooleanMọi kênh đều được tính hay không, không chỉ các kênh của một game.
game{ id, displayName, slug }?Game của chiến dịch, nếu có.
rewardValueURLParamstringGiá trị Twitch thêm vào các liên kết đổi thưởng.
unlockRequirements{ minuteWatchedGoal, subsGoal }Số phút xem và số lượt đăng ký cần thiết.
rewardGroupsRewardGroup[]?Phần thưởng được nhận theo từng nhóm, mỗi nhóm có mục tiêu riêng: mỗi ngày một phần thưởng là mỗi ngày một nhóm. Chỉ có khi Twitch gửi.
rewardsReward[]Các phần thưởng của chiến dịch, bao gồm cả phần thưởng trong các nhóm, mỗi phần thưởng một lần.
firstSeenAtstring (ISO 8601) | nullThời điểm API này thấy chiến dịch lần đầu. Chiến dịch quay lại trong vòng một ngày sau khi rời danh sách sẽ giữ thời điểm cũ. null cho các chiến dịch API đã cung cấp từ trước khi có trường này.
Các trường phần thưởng

RewardGroup

Một nhóm phần thưởng của chiến dịch phần thưởng, được nhận cùng nhau.

TrườngKiểuMô tả
idstringID Twitch của nhóm.
unlockRequirements{ minuteWatchedGoal, subsGoal, turboSubsGoal?, eventTriggerGoal? }Yêu cầu của nhóm. Twitch thêm các mục tiêu Turbo và sự kiện vào đây.
repeat{ everyHours, times } | nullTần suất nhận lại nhóm, giống repeat của một Drop: khi đó minuteWatchedGoal là thời gian xem của một chu kỳ. null với nhóm chỉ nhận một lần.
categories{ id, displayName, slug }[]Các danh mục có kênh đang phát được tính, danh mục nào cũng được; rỗng khi Twitch không nêu danh mục nào.
rewardsReward[]Các phần thưởng của nhóm, cũng được liệt kê trong rewards của chiến dịch.

Reward

Một phần thưởng của chiến dịch phần thưởng.

TrườngKiểuMô tả
id, namestringID Twitch và tên phần thưởng.
bannerImage, thumbnailImage{ image1xURL }Hình ảnh của phần thưởng.
earnableUntilstring (ISO 8601)Thời điểm cuối cùng có thể nhận phần thưởng.
redemptionInstructions, redemptionURLstringCách đổi phần thưởng, và đổi ở đâu.

Mã phản hồi

Trạng tháiMô tả
200Các chiến dịch đang diễn ra. Danh sách rỗng vẫn là phản hồi hợp lệ.
304Không có gì thay đổi kể từ ETag bạn đã gửi: hãy giữ bản sao của bạn. Miễn phí, không tính vào giới hạn của bạn.
429RATE_LIMITED: Hãy chờ số giây ghi trong Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Không nhận ra khóa và giới hạn ẩn danh của địa chỉ IP của bạn đã hết: hãy sửa khóa.
503SERVICE_UNAVAILABLE: Chưa có danh sách nào được tải (ngay sau khi API khởi động lại): hãy thử lại sau Retry-After. Miễn phí, không tính vào giới hạn của bạn.
Ví dụ yêu cầu
curl https://drops.sunkwi.com/api/twitch/rewards
Ví dụ phản hồi · 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" }}

Lấy huy hiệu trò chuyện

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

Các huy hiệu trò chuyện toàn cục của Twitch trong badges, mỗi phiên bản một mục, kèm cách nhận khi API này biết (requirement), cùng thời điểm đọc huy hiệu Twitch gần nhất và giới hạn tần suất của bạn.

Body phản hồi

TrườngKiểuMô tả
badgesBadge[]Các huy hiệu toàn cục, mỗi phiên bản một mục. Mảng rỗng vẫn là phản hồi hợp lệ.
refreshedAtstring (ISO 8601) | nullThời điểm đọc huy hiệu Twitch thành công gần nhất (mỗi 5 phút), null trước lần đọc đầu tiên.
rateLimit{ limit, remaining, resetAt }Giới hạn của bạn trên route này sau lần gọi này, đúng như các header ratelimit-* cho biết: limit yêu cầu mỗi khung thời gian, remaining yêu cầu còn được phép, và resetAt, thời điểm giới hạn được phục hồi hoàn toàn (ISO 8601).

Badge

Một mục của badges: một phiên bản của một huy hiệu trò chuyện toàn cục, đúng như Twitch đang liệt kê.

TrườngKiểuMô tả
setId, versionIdstringBộ huy hiệu và phiên bản của nó: kết hợp lại, chúng xác định một huy hiệu (sub-gifter và 5).
title, descriptionstringTên và mô tả của Twitch, bằng tiếng Anh.
imageUrl1x, imageUrl2x, imageUrl4xstring (URL)Hình ảnh huy hiệu ở kích thước 18, 36 và 72 pixel.
clickAction, clickUrlstring | nullHành động của Twitch khi nhấp vào huy hiệu, và liên kết của nó; null khi Twitch không cung cấp.
firstSeenAtstring (ISO 8601) | nullThời điểm API này thấy huy hiệu lần đầu. Huy hiệu quay lại hơn 7 ngày sau khi Twitch gỡ bỏ sẽ nhận thời điểm mới; nếu quay lại sớm hơn, nó giữ thời điểm cũ. null cho các huy hiệu đã có từ lần đọc đầu tiên.
requirementBadgeRequirement | nullCách nhận; null khi API này không biết.
Các trường BadgeRequirement

BadgeRequirement

Cách nhận một huy hiệu: từ chiến dịch Drops trao huy hiệu đó (DROPS), hoặc từ chính mô tả của Twitch cho huy hiệu đăng ký hoặc xem (TWITCH_DESCRIPTION).

TrườngKiểuMô tả
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS hoặc TWITCH_DESCRIPTION.
watchTimeOnlybooleantrue đúng khi chỉ cần xem: một chiến dịch DROPS yêu cầu thời gian xem (requiredMinutes lớn hơn 0) và không yêu cầu đăng ký (requiredSubs bằng 0).
requiredMinutes, requiredSubsnumberSố phút xem, và số lượt đăng ký hoặc tặng gói đăng ký, cần có.
gameId, gameNamestringGame: ID Twitch (null khi không biết) và tên.
channels, channelCountstring[] (≤ 5), number5 kênh đầu tiên trao huy hiệu (tên đăng nhập) và tổng số kênh; 0: mọi kênh đang phát game đó.
startAt, endAtstring (ISO 8601) | nullThời gian diễn ra chiến dịch; null với TWITCH_DESCRIPTION. Chiến dịch đã kết thúc vẫn được giữ lại.
campaignId, campaignNamestring | nullChiến dịch Drops; null với TWITCH_DESCRIPTION.
repeat{ everyHours, times } | nullChỉ DROPS: thời gian xem được yêu cầu lại mỗi chu kỳ, requiredMinutes là của một chu kỳ, kèm times và everyHours (20 phút mỗi ngày trong 3 ngày: times 3, everyHours 24); nếu không thì null.
categories{ id, name }[] (≤ 50)Chỉ DROPS: các danh mục có kênh đang phát được tính, danh mục nào cũng được (id và name, tối đa 50); gameId và gameName là danh mục đầu tiên. Nếu không thì rỗng.
collection{ chestSize, completeAll } | nullChỉ DROPS: huy hiệu là một phần thưởng của bộ sưu tập sự kiện, tức chiến dịch. chestSize: huy hiệu rơi ra từ một rương có ngần ấy phần thưởng, mỗi rương một cái, không bao giờ được chọn (null: trao trực tiếp). completeAll: trao khi hoàn thành toàn bộ bộ sưu tập, kể cả lượt đăng ký. Nếu không thì null.
evolvesFrom{ setId, versionId } | nullChỉ DROPS: huy hiệu cần đeo trong khung chat trước khi xem, theo setId và versionId của nó trong danh sách này: một lần tiến hóa Pokémon cần giai đoạn trước đó (Pikachu: Pichu). Trường hợp khác là null, hoặc khi chưa biết.

Mã phản hồi

Trạng tháiMô tả
200Các huy hiệu toàn cục. Danh sách rỗng vẫn là phản hồi hợp lệ.
304Không có gì thay đổi kể từ ETag bạn đã gửi: hãy giữ bản sao của bạn. Miễn phí, không tính vào giới hạn của bạn.
429RATE_LIMITED: Hãy chờ số giây ghi trong Retry-After.
429INVALID_API_KEY_RATE_LIMITED: Không nhận ra khóa và giới hạn ẩn danh của địa chỉ IP của bạn đã hết: hãy sửa khóa.
503SERVICE_UNAVAILABLE: Chưa có danh sách nào được tải (ngay sau khi API khởi động lại): hãy thử lại sau Retry-After. Miễn phí, không tính vào giới hạn của bạn.
Ví dụ yêu cầu
curl https://drops.sunkwi.com/api/twitch/badges
Đang tải bản xem trước…

Giới hạn tần suất

Mỗi route có bộ đếm riêng: gọi /drops không bao giờ dùng vào hạn mức của /rewards hay /badges. Chiến dịch thay đổi mỗi phút một lần và huy hiệu mỗi 5 phút, nên gọi nhanh hơn cũng không có gì mới.

Bên gọiGiới hạn mỗi routeTính theo
Ẩn danh1 yêu cầu mỗi 5 phútĐịa chỉ IP
Có khóa API1 yêu cầu mỗi phút theo mặc định, có thể nâng thêm khi có yêu cầuKhóa API

Header phản hồi

Các header mà API đọc và gửi.

HeaderChiềuMô tả
x-last-updated-atresponseThời điểm đọc Twitch thành công gần nhất: lần quét đối với /drops và /rewards, lần đọc huy hiệu đối với /badges.
x-refresh-interval-secondsresponseSố giây giữa hai lần đọc Twitch: hỏi thường xuyên hơn vẫn nhận được cùng dữ liệu (60 đối với /drops và /rewards, 300 đối với /badges).
ratelimit-limitresponseSố yêu cầu được phép trong khung thời gian, cho route này.
ratelimit-remainingresponseSố yêu cầu còn lại trong khung thời gian hiện tại.
ratelimit-resetresponseSố giây cho đến khi được gửi yêu cầu trở lại.
ratelimit-policyresponseChính sách, dạng <giới hạn>;w=<khoảng thời gian tính bằng giây>.
retry-afterresponseSố giây cần chờ trước khi thử lại, khi nhận phản hồi 429 hoặc 503.
x-api-keyrequestKhóa API của bạn: không bắt buộc trên mọi route.
x-api-key-statusresponseinvalid khi khóa được gửi không xác định, đã thu hồi hoặc bị vô hiệu hóa: lệnh gọi được tính là ẩn danh, vào giới hạn của địa chỉ IP của bạn.
etagresponseThẻ của câu trả lời này. Hãy gửi lại trong If-None-Match: khi dữ liệu chưa thay đổi, câu trả lời là 304 và không tính vào giới hạn của bạn.
if-none-matchrequestETag của câu trả lời gần nhất của bạn, không bắt buộc: danh sách không đổi sẽ trả về 304 Not Modified, miễn phí.
Lệnh gọi ẩn danh thứ hai trong vòng 5 phút
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" }

Lỗi

Lỗi trả về một body JSON với mã ổn định: { "code": "RATE_LIMITED" }. Mã không bao giờ thay đổi: hãy dựa vào code, không dựa vào thông báo.

Trạng tháiMãMô tả
429RATE_LIMITEDQuá nhiều yêu cầu trên route này: hãy chờ số giây ghi trong Retry-After.
429INVALID_API_KEY_RATE_LIMITEDQuá nhiều yêu cầu, và header X-API-Key chứa khóa không xác định, đã thu hồi hoặc bị vô hiệu hóa: lệnh gọi được tính là ẩn danh. Hãy sửa khóa, hoặc chờ số giây ghi trong Retry-After.
503SERVICE_UNAVAILABLEChưa có danh sách nào được tải (ngay sau khi API khởi động lại). Không tốn lượt nào: hãy thử lại sau số giây ghi trong Retry-After.
404NOT_FOUNDRoute không tồn tại.
500INTERNAL_SERVER_ERRORMáy chủ gặp lỗi: hãy thử lại sau.
Ví dụ lỗi
HTTP/1.1 404 Not Foundcontent-type: application/json; charset=utf-8
{ "code": "NOT_FOUND" }

Từ trang web đến API

Mọi trang của trang web này đều đọc chính các route này. Dưới đây là vị trí trong phản hồi của những gì mỗi trang hiển thị.

TrangRouteVị trí trong phản hồi
Drops/drops/dropsgames: mỗi game một mục, các chiến dịch của game nằm trong rewards. Chế độ lưới vẽ startAt và endAt của từng chiến dịch.
Trang game/drops/<game>/dropsMột mục của games, đối chiếu theo gameId. Mỗi chiến dịch là games[i].rewards[j]; phần thưởng của chiến dịch là các benefitEdges của timeBasedDrops, kèm requiredMinutesWatched.
Phần thưởng/rewards/rewardscampaigns: mỗi chiến dịch phần thưởng một mục, phần thưởng nằm trong rewards và yêu cầu nằm trong unlockRequirements.
Trang chiến dịch phần thưởng/rewards/<campaign>/rewardsMột mục của campaigns, đối chiếu theo id; phần thưởng nằm trong rewards.
Huy hiệu/badges/badgesbadges: mọi mục, các mục có requirement đứng trước, kèm cách nhận. Chế độ lưới vẽ requirement.startAt và requirement.endAt của từng huy hiệu.
Trang huy hiệu/badges/<badge>/badgesMột mục của badges, đối chiếu theo setId và versionId; “Cách nhận” là requirement của mục đó.