入門指南

請求次數限制

每位用戶的所有金鑰合計,最多可發出每分鐘 120 個請求。計數器會在每分鐘開始時重設。

使用有效金鑰時,回應會在以下標頭顯示用量:

名稱類型說明
X-RateLimit-Limitinteger每分鐘容許的請求數目。
X-RateLimit-Remaininginteger目前這一分鐘尚餘的請求數目。
X-RateLimit-Resetinteger距離計數器重設的秒數。
Retry-Afterinteger只會在 429 回應中出現:重試前須等候的秒數。

超出限制時,回應為 429,錯誤代碼為 rate_limited。請等候 Retry-After 指定的時間後再重試。

沒有附上有效金鑰的請求(沒有金鑰、金鑰錯誤或已撤銷)會按每個 IP 地址每分鐘 30 次限制。

避免達到限制

  • 將 per_page 設為最多 100,以較少請求取得更多項目。
  • 如要監察電視狀態,每分鐘查詢一次已經足夠。
  • 處理大量工作時,請把請求分散在不同時間發出,並留意 X-RateLimit-Remaining。
回應標頭200
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117
X-RateLimit-Reset: 42
已達到限制429
HTTP/1.1 429 Too Many Requests
Retry-After: 18
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 18

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Try again in 18 seconds."
  }
}