エラーとレート制限
エラー形式
すべてのエラーはJSON本文を返します。
json
{
"message": "Human-readable description",
"code": "MACHINE_READABLE_CODE"
}認証エラーには追加で authenticated フィールドが含まれます。
json
{
"message": "Invalid API key",
"code": "INVALID_API_KEY_EXCEPTION",
"authenticated": false
}HTTPステータスコード
| ステータス | 意味 |
|---|---|
400 Bad Request | 必須フィールドの不足、無効な値、または制約違反 |
401 Unauthorized | APIキーがない、または無効 |
403 Forbidden | 認証済みだが、この操作を実行する権限がない |
404 Not Found | リソースが存在しない、または現在の権限では到達できない |
429 Too Many Requests | レート制限を超過 |
500 Internal Server Error | 予期しないサーバーエラー |
レート制限
各エンドポイントには、レート制限を決めるティアが割り当てられます。カウンターはルートごとに計算され、同じアカウントが所有するすべてのAPIキー間で共有されます。
| ティア | 上限 | 期間 | ブロック時間 |
|---|---|---|---|
| Tier 1 | 5回 | 5分 | 30分 |
| Tier 2 | 5回 | 1分 | 10分 |
| Tier 3 | 20回 | 1分 | 10分 |
| Tier 4 | 60回 | 1分 | 10分 |
すべてのレスポンスには次のヘッダーが含まれます。
| ヘッダー | 説明 |
|---|---|
x-ratelimit-limit | 現在のウィンドウ内の最大リクエスト数 |
x-ratelimit-remaining | 現在のウィンドウで残っているリクエスト数 |
x-ratelimit-reset | 現在のウィンドウがリセットされるまでの秒数 |
ブロック中は、429 ステータスとともに x-ratelimit-reset のみ返されます。