API仕様
郵便番号(一部) → 住所
GET
https://api-zipcode.jp/api/v1/search/zipcodes
概要
3桁以上の郵便番号から該当する全ての住所を検索できます。
消費ポイント・認証
消費ポイント
3 pt / リクエスト
Authentication
APIトークン必要
Headers
| key | type | value | |
|---|---|---|---|
| Authorization | string | Bearer <YOUR_API_TOKEN_HERE> | required |
| Content-type | string | application/json | required |
| Accept | string | application/json | required |
Query String
| key | type | value | |
|---|---|---|---|
| zip_code | number | 郵便番号(上3〜7桁) | required |
Responses
| ステータスコード | 説明 |
|---|---|
| 200 | OK(成功) |
| 401 | Unauthenticated. (トークンが無いか無効です) |
| 402 | There are not enough points. (ポイントが足りません) |
| 403 | Invalid ability provided. (トークンにアビリティがありません) |
| 422 | Unprocessable Entity. (リクエストが無効です) |
| 429 | Too Many Attempts. (レートリミッター発動) |
| 503 | Service Unavailable. (サーバーメンテナンス中です) |