ข้ามไปยังเนื้อหา
Twitch Drops API

ข้อมูลอ้างอิง Twitch Drops API

API แบบ JSON ฟรีที่แสดงแคมเปญ Twitch Drops และแคมเปญรางวัลที่กำลังดำเนินอยู่ทั้งหมด อัปเดตทุกนาที รวมถึงยศในแชทส่วนกลางของ Twitch เรียกใช้แบบไม่ระบุตัวตน หรือใช้คีย์ API ฟรีเพื่อรับขีดจำกัดที่สูงขึ้น

URL หลักhttps://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 ในแดชบอร์ด แล้วสร้างคีย์ที่ตั้งชื่อตามบอทหรือเว็บไซต์ของคุณ
  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

ฟิลด์ประเภทคำอธิบาย
gameIdstringID ของเกมบน Twitch
gameDisplayNamestringชื่อเกม
gameBoxArtURLstring (URL)ภาพปกเกม ขนาด 120×160
startAtstring (ISO 8601)เวลาเริ่มของแคมเปญแรกสุดของเกม
endAtstring (ISO 8601)เวลาสิ้นสุดของแคมเปญที่จบช้าที่สุดของเกม
rewardsDropCampaign[]แคมเปญ Drops ของเกม
ฟิลด์ของ DropCampaign, TimeBasedDrop และ Benefit

DropCampaign

แคมเปญ Drops หนึ่งรายการ ใน rewards ของเกม

ฟิลด์ประเภทคำอธิบาย
idstringID ของแคมเปญบน 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, namestringID บน Twitch และชื่อของ Drop
startAt, endAtstring (ISO 8601)ช่วงเวลาที่รับ Drop ได้
requiredMinutesWatchednumberจำนวนนาทีที่ต้องรับชม
requiredSubsnumberจำนวนการสมัครสมาชิกที่ต้องใช้
repeat{ everyHours, times } | nullAPI นี้เพิ่มให้: ความถี่ที่ Drop ได้รับซ้ำได้ ด้วย times (จำนวนครั้ง) และ everyHours (24: วันละครั้ง หรือ null เมื่อ Twitch ไม่ได้ระบุ) เมื่อนั้น requiredMinutesWatched คือเวลารับชมของหนึ่งช่วง และเป็น null สำหรับ Drop ที่ได้รับครั้งเดียว
preconditionDropsunknownDrops ที่ต้องได้รับก่อน ส่งต่อมาจาก Twitch ตามเดิม
benefitEdges{ benefit: Benefit, entitlementLimit }[]สิ่งที่ Drop มอบให้ พร้อมจำนวนครั้งที่รับได้

Benefit

ไอเท็มในเกม ใน benefitEdges

ฟิลด์ประเภทคำอธิบาย
id, namestringID บน 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, brandstringID บน 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

กลุ่มรางวัลของแคมเปญรางวัลที่ได้รับพร้อมกัน

ฟิลด์ประเภทคำอธิบาย
idstringID ของกลุ่มบน 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, namestringID บน 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 พิกเซล
clickAction, clickUrlstring | nullสิ่งที่ Twitch ทำเมื่อคลิกยศ และลิงก์ของยศ เป็น null เมื่อ Twitch ไม่ได้ระบุ
firstSeenAtstring (ISO 8601) | nullเวลาที่ API นี้พบยศครั้งแรก ยศที่กลับมาหลังจาก Twitch นำออกไปเกิน 7 วันจะได้เวลาใหม่ ถ้ากลับมาเร็วกว่านั้นจะคงเวลาเดิมไว้ เป็น null สำหรับยศที่มีอยู่แล้วตอนอ่านครั้งแรก
requirementBadgeRequirement | nullวิธีรับ เป็น null เมื่อ API นี้ไม่ทราบ
ฟิลด์ของ BadgeRequirement

BadgeRequirement

วิธีรับยศ: จากแคมเปญ Drops ที่แจกยศนั้น (DROPS) หรือจากคำอธิบายของ Twitch เองสำหรับยศสมาชิกหรือยศการรับชม (TWITCH_DESCRIPTION)

ฟิลด์ประเภทคำอธิบาย
source'DROPS' | 'TWITCH_DESCRIPTION'DROPS หรือ TWITCH_DESCRIPTION
watchTimeOnlybooleanเป็น true เฉพาะเมื่อแค่รับชมก็พอ: แคมเปญ DROPS ที่ต้องใช้เวลารับชม (requiredMinutes มากกว่า 0) และไม่ต้องสมัครสมาชิก (requiredSubs เป็น 0)
requiredMinutes, requiredSubsnumberจำนวนนาทีที่ต้องรับชม และจำนวนการสมัครสมาชิกหรือการมอบสมาชิกเป็นของขวัญที่ต้องใช้
gameId, gameNamestringเกม: ID บน Twitch (null เมื่อไม่ทราบ) และชื่อเกม
channels, channelCountstring[] (≤ 5), number5 ช่องแรกที่แจกยศนี้ (ชื่อล็อกอิน) และจำนวนช่องทั้งหมด 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 ในรายการนี้ การวิวัฒนาการของโปเกมอนต้องมีร่างก่อนหน้า (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-matchrequestETag ของคำตอบล่าสุดของคุณ ไม่บังคับ: รายการที่ไม่เปลี่ยนจะตอบ 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 ของรายการนั้น