住所コードの下位階層住所一覧検索

API名: 
address/list
概要: 

リクエストパラメータで指定される住所コードを元に指定した住所の下位階層の住所リストを返却します。

※多言語情報の出力には別途契約が必要です。

URI: 

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

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

リクエストパラメータ
パラメータ 必須 デフォルト値 説明
addrcode   - 絞込み住所コード
検索範囲を指定の住所コードに限定します。
指定がない場合は都道府県のリストを取得します。
datum   TOKYO 測地系
返却される住所代表点の測地系を指定します。
limit   0,100 検索結果取得件数
検索結果取得件数を指定します。
取得開始位置の指定範囲は0~20000 です。
20001以上の指定をした場合は20000指定と同様の結果となります。
取得件数の指定範囲は 1~1000 です。
1001以上の指定をした場合は1000指定と同様の結果となります。
llunit   dec 緯度経度形式
緯度経度形式を指定します。
sort   autokana 出力順
出力順を指定します。複数指定できます。
デフォルトは昇順で、降順指定の場合ソートキーの前方にマイナス(-)を付加します。
入力値 説明
todcode 都道府県コード
shkcode 市区町村コード
oazcode 大字コード
azccode 字丁目コード
gikcode 街区コード
tbncode 地番コード
ebncode 枝番コード
todkana 都道府県名カナ
shkkana 市区町村名カナ
oazkana 大字名カナ
azckana 字丁目名カナ
autokana 自動カナソート
出力対象(item→level)となった検索結果の住所レベルに応じて、自動的にソートキーを設定します。
住所レベルとソートキーの関係は下の表の通りとなります。
zipcode 郵便番号
autokana指定時のsortキー
出力値
item→level
sortパラメータ
市区町村 todcode,shkcode
大字 todcode,shkcode,oazkana
字丁目 todcode,shkcode,oazkana,azckana
街区 todcode,shkcode,oazkana,azckana,gikcode
地番 todcode,shkcode,oazkana,azckana,gikcode,tbncode
枝番 todcode,shkcode,oazkana,azckana,gikcode,tbncode,ebncode
skip   1 出力順
検索結果の住所が1件のみだった場合の出力内容を制御します。
入力値 説明
0 指定住所コードの1階層下のレベルのみ検索
1 1件だった場合、自動的に下位レベルを検索し出力

出力データ
出力フォーマット
{"info":{"hit":6},
 "item":[{"text":"東京都港区新橋1丁目",
          "code":"13103016001",
          "point":{"lat":35.6650083,
                   "lon":139.7612583},
          "parts":["東京都","港区","新橋","1丁目"],
          "kana":"トウキヨウトミナトクシンバシ",
          "zipcode":"105-0004",
          "end":false,
          "bounds":{"sw":{"lat":35.6632611,
                          "lon":139.7581528},
                    "ne":{"lat":35.6663358,
                          "lon":139.7658286}},
          "kanaParts":["トウキヨウト","ミナトク","シンバシ",""],
          "level":"azc",
          "language":{"en":{"text":"Tokyo Minato Shinbashi 1",
                            "parts":["Tokyo","Minato","Shinbashi","1"]},
                      "zh-cn":{"text":"东京都 港区 新桥 1",
                               "parts":["东京都","港区","新桥","1"]},
                      "zh-tw":{"text":"東京都 港區 新橋 1",
                               "parts":["東京都","港區","新橋","1"]},
                      "ko":{"text":"도쿄도 미나토구 신바시 1",
                            "parts":["도쿄도","미나토구","신바시","1"]}}},
          ...]}

キー名 データ型 説明
info   object 検索結果の情報が入ります。
  hit number 入力された条件に対してヒットした件数が入ります。
item   array 検索結果の住所の配列が入ります。検索結果が0件の場合は空の配列となります。

出力例

[通常出力例(多言語情報出力契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/list?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=131010580000000000001

	
{"info":{"hit":1},
 "item":[{"text":"東京都千代田区四番町1−8",
          "code":"13101058000000000000100001",
          "point":{"lat":35.686175,
                   "lon":139.7432},
          "parts":["東京都","千代田区","四番町","","","1","8"],
          "kana":"トウキヨウトチヨダクヨンバンチヨウ",
          "zipcode":"102-0081",
          "end":true,
          "bounds":null,
          "kanaParts":["トウキヨウト","チヨダク","ヨンバンチヨウ","","","",""],
          "level":"ebn",
          "language":{"en":{"text":"Tokyo Chiyoda Yonbancho 1-8",
                            "parts":["Tokyo","Chiyoda","Yonbancho","","","1","8"]},
                      "zh-cn":{"text":"东京都千代田区四番町1-8",
                               "parts":["东京都","千代田区","四番町","","","1","8"]},
                      "zh-tw":{"text":"東京都千代田區四番町1-8",
                               "parts":["東京都","千代田區","四番町","","","1","8"]},
                      "ko":{"text":"도쿄도치요다구욘반쵸1-8",
                            "parts":["도쿄도","치요다구","욘반쵸","","","1","8"]}}}]}

[通常出力例(多言語情報出力未契約時)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/list?if_clientidJSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=131010580000000000001

{"info":{"hit":1},
 "item":[{"text":"東京都千代田区四番町1−8",
          "code":"13101058000000000000100001",
          "point":{"lat":35.686175,
                   "lon":139.7432},
          "parts":["東京都","千代田区","四番町","","","1","8"],
          "kana":"トウキヨウトチヨダクヨンバンチヨウ",
          "zipcode":"102-0081",
          "end":true,
          "bounds":null,
          "kanaParts":["トウキヨウト","チヨダク","ヨンバンチヨウ","","","",""],
          "level":"ebn",
          "language":null}]}

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

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