緯度経度での住所検索
API名:
location
概要:
リクエストパラメータで指定された緯度経度の住所情報を返却します。
※一部パラメータを利用するには別途契約が必要です。
※多言語情報の出力には別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.6781444,139.7693167
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| latlon | ○ | - |
緯度経度 取得したい地点の緯度経度を指定します。 本項目は必須項目であるため、未指定の場合はエラーとなります。 100件まで複数値指定できますが、URLの長さ制限の影響を受けます。 複数値指定した場合、PVカウントは指定緯度経度1件につき1PVです。 |
||||||
| datum | TOKYO |
測地系 入出力緯度経度の測地系を指定します。 |
|||||||
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||||||
| d2d | F |
到着地点情報(D2D) 到着地点情報(D2D)を取得するかどうかを真偽値で指定します。 ※本機能を利用する場合には別途契約が必要です。
|
|||||||
| multilanguage | F |
多言語情報 検索結果に多言語情報を含むかどうかを真偽値で指定します。 ※本機能を利用する場合には別途契約が必要です。 ※多言語情報を含む場合と含まない場合で、データ鮮度の違いにより検索結果が異なる可能性がございます。
|
出力データ
出力フォーマット
"code":string,
"point":{"lat":number,
"lon":number},
"parts":["string","string","string","string","string","string"],
"kana":"string",
"zipcode":null,
"match":null,
"end":boolean,
"bounds":object,
"kanaParts":["string","string","string","string","string","string"],
"level":"string",
"language": {"jp":{"text":"string"
"parts": ["string","string","string","string","string","string"]}
"zh-cn":{"text":"string"
"parts": ["string","string","string","string","string","string"]}
"zh-tw":{"text":"string"
"parts": ["string","string","string","string","string","string"]}
"en":{"text":"string"
"parts": ["string","string","string","string","string","string"]}
"ko":{"text":"string"
"parts": ["string","string","string","string","string","string"]}}}
"zipcode":"string",
"around":boolean,
"addressPoints":[{"lat":number,
"lon":number},
{"lat":number,
"lon":number},
{"lat":number,
"lon":number},
{"lat":number,
"lon":number},
{"lat":number,
"lon":number},
{"lat":number,
"lon":number}]}
"d2d":[{"code":"string",
"point":{"lat":number,
"lon":number}}]}];
...]
| キー名 | データ型 | 説明 | |||
|---|---|---|---|---|---|
| address | object | 緯度経度で指定された地点の住所が入ります。 | |||
| text | string | 住所表記文字列が入ります。 | |||
| code | string | 住所コードが入ります。 | |||
| point | object | 代表点緯度経度が入ります。 | |||
| parts | array | 住所階層毎に分割された文字列(string型)の配列が入ります。 | |||
| kana | string | 住所読み仮名が入ります。大文字（促音、拗音なし）で出力されます。 | |||
| zipcode |
現在この出力値は使用されておりません。 常にnullが入ります。 |
||||
| match |
現在この出力値は使用されておりません。 常にnullが入ります。 |
||||
| end | boolean |
住所にさらに下の階層がある場合は false, そうでない場合は trueが入ります。 不明の場合は null となります。 |
|||
| bounds | object |
行政界ポリゴンの緯度経度矩形範囲が入ります。 データは街区までで、街区以上の住所でもない場合があります。 データがない場合は null となります。行政界ポリゴンデータは住宅地図ベースのものしかないため、データ更新時期によっては住所とずれる場合があります。 |
|||
| kanaParts | array | 住所階層毎に分割された住所読み仮名(string型)の配列が入ります。 | |||
| level | string | 住所階層コードが入ります。 | |||
| language | object |
翻訳住所のオブジェクトが入ります。 住所出力フォーマット詳細のlanguegeデータが入ります。 |
|||
| zipcode | string | 緯度経度で指定された地点の郵便番号が入ります。 | |||
| around | boolean |
周辺住所かどうかのフラグが入ります。 この値が true の場合、指定した地点が海上など住所の取得できない場所であったため近傍の住所を取得したことを示します。 |
|||
| addressPoints | array |
住所階層毎の代表点座標が緯度経度の配列で入ります。 配列数は出力データaddress->partsの配列数と一致します。 本配列の要素は出力データaddress->partsの該当階層が住所が無い場合、nullとなります。
また、枝番はあるが地番が無い住所が存在する(地番及び枝番はそれぞれ固有の建物を指す)ため、枝番の代表点は返却されるが地番の代表点はnullになる場合があります。
|
|||
| d2d | array |
到着地点情報のオブジェクトが配列で入ります。 到着地点情報がない場合、空の配列となります。 配列形式となっていますが、現状複数件の地点が返却されることはありません。 |
|||
| code | string |
到着地点の種別が入ります。
|
|||
| point | LatLon | 到着地点の緯度経度が入ります。 | |||
出力例
[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.6781444,139.7693167
"code":"131010550010000900001",
"point":{"lat":35.67855,
"lon":139.7699944},
"parts":["東京都","千代田区","丸の内","１丁目","９","１"],
"kana":"トウキヨウトチヨダクマルノウチ",
"zipcode":null,
"match":null,
"end":null,
"bounds":null,
"kanaParts":["トウキヨウト","チヨダク","マルノウチ","","",""],
"level":"tbn",
"language":null},
"zipcode":"100-0005",
"around":false,
"addressPoints":[{"lat":35.6863167,
"lon":139.6950472},
{"lat":35.6908056,
"lon":139.7568194},
{"lat":35.6734139,
"lon":139.7683556},
{"lat":35.6803806,
"lon":139.7696861},
{"lat":35.6771611,
"lon":139.7704111},
{"lat":35.67855,
"lon":139.7699944}]}]
[当該階層の住所がない場合、要素がnullになる例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=36.1028525,139.6051278
"code":"112100260000000000014",
"point":{"lat":36.1028525,
"lon":139.6051278},
"parts":["埼玉県","加須市","常泉","","","７３"],
"kana":"サイタマケンカゾシツネズミ",
"zipcode":null,
"match":null,
"end":null,
"bounds":null,
"kanaParts":["サイタマケン","カゾシ","ツネズミ","","",""],
"level":"tbn",
"language":null},
"zipcode":"411-0000",
"around":false,
"addressPoints":[{"lat":35.8537417,
"lon":139.6521139}, //都道府県
{"lat":36.1282611,
"lon":139.6049583}, //市区町村
{"lat":36.1028525,
"lon":139.6051278}, //町・大字
null, //字・丁目なし
null, //街区なし
{"lat":36.1028525,
"lon":139.6051278}]}] //地番
[枝番の代表点が返却されるが 地番の代表点がnullになる例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.1490389,138.9893972
"code":"22206A20000000000001000003",
"point":{"lat":35.1490389,
"lon":138.9893972},
"parts":["静岡県","三島市","","","","４７４５","４５８"],
"kana":"シズオカケンミシマシ",
"match":null,
"end":null,
"bounds":null,
"kanaParts":["シズオカケン","ミシマシ","","","","",""],
"level":"ebn",
"language":null},
"zipcode":"411-0000",
"around":false,
"addressPoints":[{"lat":34.9734639,
"lon":138.3862306}, //都道府県
{"lat":35.1489222,
"lon":138.9893778}, //市区町村
null, //町・大字
null, //字・丁目
null, //街区
null, //地番の代表点がnull
{"lat":35.1490389,
"lon":138.9893972}]}] //枝番
[d2d=Tを指定時の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=36.224327162,139.982884817&d2d=T
"code":"082100510000000000246",
"point":{"lat":36.2244528,
"lon":139.9822028},
"parts":["茨城県","下妻市","若柳","","","丙３４９"],
"kana":"イバラキケンシモツマシワカヤナギ",
"zipcode":null,
"match":null,
"end":null,
"bounds":null,
"kanaParts":["イバラキケン","シモツマシ","ワカヤナギ","","",""],
"level":"tbn",
"language":null},
"zipcode":"304-0012",
"around":false,
"addressPoints":[{"lat":36.3386667,
"lon":140.4501417},
{"lat":36.1813333,
"lon":139.9706444},
{"lat":36.2205,
"lon":139.9804778},
null,
null,
{"lat":36.2244528,
"lon":139.9822028}],
"d2d":[{"code":"01",
"point":{"lat":36.2242417,
"lon":139.9822333}}]}]
[multilanguage=Tを指定時の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=36.224327162,139.982884817&multilanguage=T
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=36.224327162,139.982884817&multilanguage=T
"code":"082100510000000000246",
"point":{"lat":36.2244528,
"lon":139.9822028},
"parts":["茨城県","下妻市","若柳","","","丙３４９"],
"kana":"イバラキケンシモツマシワカヤナギ",
"zipcode":null,
"match":null,
"end":null,
"bounds":null,
"kanaParts":["イバラキケン","シモツマシ","ワカヤナギ","","",""],
"level":"tbn",
"language": {"jp":{"text":"茨城県 下妻市 若柳 丙３４９"
"parts": ["茨城県","下妻市","若柳","","","丙３４９"]}
"zh-cn":{"text":"茨城县 下妻市 若柳 丙３４９"
"parts": ["茨城县","下妻市","若柳","","","丙３４９"]}
"zh-tw":{"text":"茨城縣 下妻市 若柳 丙３４９"
"parts": ["茨城縣","下妻市","若柳","","","丙３４９"]}
"en":{"text":"Ibaraki Shimotsuma Wakayanagi 丙３４９"
"parts": ["Ibaraki","Shimotsuma","Wakayanagi","","","丙３４９"]}
"ko":{"text":"이바라키현 시모츠마시 와카야나기 丙３４９"
"parts": ["이바라키현","시모츠마시","","","丙３４９"]}}}
"zipcode":"304-0012",
"around":false,
"addressPoints":[{"lat":36.3386667,
"lon":140.4501417},
{"lat":36.1813333,
"lon":139.9706444},
{"lat":36.2205,
"lon":139.9804778},
null,
null,
{"lat":36.2244528,
"lon":139.9822028}]}]
[指定された地点に該当するデータが存在しない場合]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/location?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.445514167,140.774265556
null
]