ドキュメント
エラーと回数制限
エラーのときは {"success": false, "error": {"code": "...", "message": "..."}} の形で返ります。
エラーの一覧
| HTTP | code | 意味 | 回数 |
|---|---|---|---|
| 400 | invalid_parameter | pref・order・limit・offset の値が正しくない | 数えない |
| 401 | missing_api_key / invalid_api_key | キーが無い・正しくない・再発行で無効になった | 数えない |
| 403 | account_disabled | アカウントが停止されている | 数えない |
| 404 | not_found | 呼び出し先が無い | 数えない |
| 404 | municipality_not_found / axis_not_found | 市区町村コード・偏差値の項目が見つからない | 数えない |
| 405 | method_not_allowed | GET 以外で呼んだ | 数えない |
| 429 | rate_limited / quota_exceeded | 1分の上限・1日の上限を超えた（Retry-After 秒後に再試行） | 数えない |
| 500 | internal_error | サーバーのエラー | 数えない |
| 503 | data_unavailable | 一時的にデータを読み込めない（Retry-After 秒後に再試行） | 数えない |
回数制限
- 1日
- 無料 100 回 ／ 有料 10,000 回（日本時間の0時に戻ります）
- 1分
- 無料 60 回 ／ 有料 600 回
- ランキング
- 1回で 100 件まで
残り回数の確かめ方
| 応答ヘッダ | 内容 |
|---|---|
X-RateLimit-Limit | 今日の上限回数 |
X-RateLimit-Remaining | 今日の残り回数 |
X-RateLimit-Reset | 回数が戻る時刻（UNIX時刻） |
Retry-After | 429・503 のとき、再試行までの秒数 |
数え方
- データを返した呼び出し（HTTP 200）を1回と数えます。どの呼び出し先も1回です。
- キーやパラメータの誤り・見つからないコード・上限超過・当社側の障害など、データを返さなかった呼び出しは数えません。
© 合同会社IKACHI