API仕様：GET /api/v1/search/addresses

  1. トップ

GET https://api-zipcode.jp/api/v1/search/addresses

概要

都道府県、市区町村、町域、小字名・丁目・番地等、大口事業所名の一部（完全一致・部分一致・前方一致・後方一致）で該当する全ての郵便番号を検索できます。

消費ポイント

3 ポイント

Authentication

APIトークン必要

Headers

key type value
Authorization string Bearer <YOUR_API_TOKEN_HERE> required
Content-type string application/json required
X-Requested-With string XMLHttpRequest required

Query String

key type value
prefectures array[string] 都道府県名 required *1
prefecture_codes array[int] 都道府県コード required *1
city string 市区町村 optional
city_pattern_match integer 市区町村パターンマッチ
  • 1 : 完全一致
  • 2 : 部分一致
  • 3 : 前方一致
  • 4 : 後方一致
 optional *2
town string 町域 optional
town_pattern_match integer 町域パターンマッチ
  • 1 : 完全一致
  • 2 : 部分一致
  • 3 : 前方一致
  • 4 : 後方一致
 optional *2
block string 小字名・丁目・番地等 optional
block_pattern_match integer 小字名・丁目・番地等パターンマッチ
  • 1 : 完全一致
  • 2 : 部分一致
  • 3 : 前方一致
  • 4 : 後方一致
 optional *2
office string 大口事業所名 optional
office_pattern_match integer 大口事業所名パターンマッチ
  • 1 : 完全一致
  • 2 : 部分一致
  • 3 : 前方一致
  • 4 : 後方一致
 optional *2

*1 いずれか必須

*2 指定がない場合は完全一致

Responses JSON

key value
ステータスコード
  • 200 : OK（成功）
  • 401 : Unauthenticated. （トークンが無いか無効です）
  • 402 : There are not enough points. （ポイントが足りません）
  • 403 : Invalid ability provided. （トークンにアビリティがありません）
  • 422 : Unprocessable Entity. （リクエストが無効です）
  • 429 : Too Many Attempts. （レートリミッター発動）
  • 503 : Service Unavailable. （サーバーメンテナンス中です）

エクスプローラー

＊
＊

パターンマッチの指定がない場合は完全一致