郵便番号での住所検索

API名: 

address/zipcode

概要: 

リクエストパラメータで指定される郵便番号に該当する住所情報を返却します。

URI: 

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcode

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=105-7421

リクエストパラメータ

パラメータ 必須 デフォルト値 説明
zipcode - 郵便番号
7桁の郵便番号を指定します。
本項目は必須項目であるため、未指定の場合はエラーとなります。
datum   TOKYO 測地系
返却される住所代表点の測地系を指定します。
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は0~20000 です。
20001以上の指定をした場合は20000指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の指定をした場合は1000指定と同様の結果となります。
llunit   dec 緯度経度形式
緯度経度形式を指定します。

出力データ

出力フォーマット

{"info":{"hit":1},
 "item":[{"text":"東京都港区東新橋1丁目",
          "code":"13103023001",
          "point":{"lat":35.6621611,
                   "lon":139.7642944},
          "parts":["東京都","港区","東新橋","1丁目"],
          "kana":"トウキヨウトミナトクヒガシシンバシ",
          "end":null,
          "bounds":null,
          "kanaParts":["トウキヨウト","ミナトク","ヒガシシンバシ",""],
          "level":"azc"}]}
キー名 データ型 説明
info   object 検索結果の情報が入ります。
  hit number 入力された条件に対してヒットした件数が入ります。
item   array 検索結果の住所の配列が入ります。検索結果が0件の場合は空の配列となります。
※ end及びboundsは常にnullになります。

出力例

[例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=105-7421

{"info":{"hit":1},
 "item":[{"text":"東京都港区東新橋1丁目",
          "code":"13103023001",
          "point":{"lat":35.6621611,
                   "lon":139.7642944},
          "parts":["東京都","港区","東新橋","1丁目"],
          "kana":"トウキヨウトミナトクヒガシシンバシ",
          "end":null,
          "bounds":null,
          "kanaParts":["トウキヨウト","ミナトク","ヒガシシンバシ",""],
          "level":"azc"}]}

[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcode?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=105-7400

{"info":{"hit":0},
 "item":[]}