住所コードの下位階層住所一覧検索
API名:
概要:
リクエストパラメータで指定される住所コードを元に指定した住所の下位階層の住所リストを返却します。
※多言語情報の出力には別途契約が必要です。
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 |
出力順
出力順を指定します。複数指定できます。
デフォルトは昇順で、降順指定の場合ソートキーの前方にマイナス(-)を付加します。
autokana指定時のsortキー
|
|||||||||||||||||||||||||||||||||||||||||||
| skip | 1 |
下位レベル自動検索
検索結果の住所が1件のみだった場合の出力内容を制御します。
|
出力データ
出力フォーマット
{"info":{"hit":6}, "item":[{"text":"東京都港区新橋１丁目", "code":"13103016001", "point":{"lat":35.6650083, "lon":139.7612583}, "parts":["東京都","港区","新橋","１丁目"], "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":"東京都千代田区四番町１−８", "code":"13101058000000000000100001", "point":{"lat":35.686175, "lon":139.7432}, "parts":["東京都","千代田区","四番町","","","１","８"], "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":"東京都千代田区四番町１−８", "code":"13101058000000000000100001", "point":{"lat":35.686175, "lon":139.7432}, "parts":["東京都","千代田区","四番町","","","１","８"], "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":[]}