郵便番号情報検索

API名: 
address/zipcodelist
概要: 

リクエストパラメータで指定される郵便番号を元に前方一致で検索し、該当する郵便番号データを返却します。

URI: 

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

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

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

出力データ
出力フォーマット
{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":127},
 "item":[{"zipcode":"1110021",
          "address":{"text":"東京都台東区日本堤１丁目",
                     "code":"13106022001",
                     "point":{"lat":35.7230806,
                              "lon":139.8015111},
                     "parts":["東京都","台東区","日本堤","１丁目"],
                     "kana":"トウキヨウトタイトウクニホンヅツミ",
                     "end":null,
                     "bounds":null,
                     "kanaParts":["トウキヨウト","タイトウク","ニホンヅツミ",""],
                     "level":"azc"}},
          ...]}
キー名 データ型 説明
status   object ステータス情報が入ります。
info   object 検索結果の情報が入ります。
  hit number 入力された条件に対してヒットした件数が入ります。
item   array 検索結果の配列が入ります。検索結果が0件の場合は空の配列となります。
  zipcode number 郵便番号(ハイフン無し)が入ります。
  address object 検索結果の住所の配列が入ります。
※ end及びboundsは常にnullになります。

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelist?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&zipcode=111

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":127},
 "item":[{"zipcode":"1110021",
          "address":{"text":"東京都台東区日本堤１丁目",
                     "code":"13106022001",
                     "point":{"lat":35.7230806,
                              "lon":139.8015111},
                     "parts":["東京都","台東区","日本堤","１丁目"],
                     "kana":"トウキヨウトタイトウクニホンヅツミ",
                     "end":null,
                     "bounds":null,
                     "kanaParts":["トウキヨウト","タイトウク","ニホンヅツミ",""],
                     "level":"azc"}},
         {"zipcode":"1110021",
          "address":{"text":"東京都台東区日本堤２丁目",
                     "code":"13106022002",
                     "point":{"lat":35.7244972,
                              "lon":139.80075},
                     "parts":["東京都","台東区","日本堤","２丁目"],
                     "kana":"トウキヨウトタイトウクニホンヅツミ",
                     "end":null,
                     "bounds":null,
                     "kanaParts":["トウキヨウト","タイトウク","ニホンヅツミ",""],
                     "level":"azc"}},
         {"zipcode":"1110022",
          "address":{"text":"東京都台東区清川１丁目",
                     "code":"13106012001",
                     "point":{"lat":35.7215139,
                              "lon":139.8069194},
                     "parts":["東京都","台東区","清川","１丁目"],
                     "kana":"トウキヨウトタイトウクキヨカワ",
                     "end":null,
                     "bounds":null,
                     "kanaParts":["トウキヨウト","タイトウク","キヨカワ",""],
                     "level":"azc"}},
         ...]}

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

{"status":{"code":"0000",
           "text":"OK"},
 "info":{"hit":0},
 "item":[]}