レート制限

shinp.info APIでは、サービスの安定性を確保するためにレート制限を設けています。

仕組み

レート制限はUnkeyを使用して実装されており、API Key単位で制御されます。

レート制限ヘッダー

レスポンスには以下のヘッダーが含まれます。

ヘッダー	説明
X-RateLimit-Limit	期間内のリクエスト上限数
X-RateLimit-Remaining	期間内の残りリクエスト数
X-RateLimit-Reset	制限がリセットされるUNIXタイムスタンプ

制限超過時のレスポンス

レート制限を超過した場合、429 Too Many Requests が返却されます。

{
    "type": "https://shinp.info/problems/rate-limit-exceeded",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "レート制限を超過しました。しばらく時間をおいてから再試行してください。"
}

推奨事項

• レスポンスヘッダーの X-RateLimit-Remaining を監視し、制限に達する前にリクエスト頻度を調整してください。
• 429 レスポンスを受け取った場合は、X-RateLimit-Reset の時刻まで待機してから再試行してください。