ジオコーディング
API名:
address/geocoding
概要:
リクエストパラメータで指定した住所文字列と
ゼンリンが整備する住所データベースとをマッチングさせて該当する住所情報を返却します。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/geocoding
<API使用例>
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|
| address | ○ | - |
住所文字列 住所文字列を指定します。 本項目は必須項目であるため、未指定の場合はエラーとなります。 1000件まで複数値指定できますが、URLの長さ制限の影響を受けます。 複数値指定した場合、PVカウントは指定住所1件につき1PVです。 また、基本的に前方一致の検索となりますが、都道府県の省略は可能です。 |
| datum | TOKYO |
測地系 返却される住所代表点の測地系を指定します。 |
|
| level | ebn |
住所階層コードマッチングレベル マッチングさせる住所階層コードを指定します。 |
|
| kyoto | T |
京都通り名検索利用指定 京都通り名検索の利用を真偽値で指定します。 Tを指定することで京都通り名検索が利用できます。 |
|
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|
| outputzipcode | F |
郵便番号出力 返却値zipcodeに郵便番号を出力するかを真偽値で指定します。 T指定の場合は、F指定に比べ応答に若干時間を要する事があります。 |
出力データ
出力フォーマット
オブジェクトの配列を返却します。指定した住所文字列が住所データベースとマッチングしなかった場合、マッチングしなかった場所の配列要素がnullになります。
"code":string,
"point":LatLon,
"parts":[string, ...],
"kana":string,
"zipcode":string,
"match":boolean,
"end":boolean,
"bounds":LLBounds,
"kanaParts":[string, ...],
"level":string,
"language":null},
..., ...]
| キー名 | データ型 | 説明 |
|---|---|---|
| text | string | 指定した住所文字列に対して、住所データベースにマッチングした住所文字列が入ります。 |
| code | string | 住所コードが入ります。 |
| point | object | 代表点緯度経度が入ります。 |
| parts | array | 住所階層毎に分割された文字列(string型)の配列が入ります。 |
| kana | string | 住所読み仮名が入ります。大文字（促音、拗音なし）で出力されます。 |
| zipcode | string |
郵便番号が入ります。outputzipcode=Tの場合のみ有効です。 マッチした住所階層コード(level)の値がtod、shkの場合、データがない場合は null となります。 |
| match | boolean |
指定した住所文字列が完全に住所データベースとマッチングできたかどうかが入ります。 ※「丁目」⇔ハイフン(-)等、一部表記揺れは読み替えしています。 マッチングした場合はtrue, そうでない場合はfalseが入ります。 |
| end | boolean |
マッチングした住所データベースの住所にさらに下の階層がある場合はfalse, そうでない場合はtrueが入ります。不明の場合はnull となります。 |
| bounds | object |
行政界ポリゴンの緯度経度矩形範囲が入ります。 データは街区までで、街区以上の住所でもない場合があります。 データがない場合は null となります。データ更新時期によっては住所とずれる場合があります。 |
| kanaParts | array | 住所階層毎に分割された住所読み仮名(string型)の配列が入ります。 |
| level | string | 住所階層コードが入ります。 |
| language | 常にnullが入ります。 |
補足 matchとendについて
リクエストパラメータで指定した住所文字列と住所データベースのマッチング内容によって、
以下のようなケースになります。
| ケース | 指定した住所文字列の例 |
完全にマッチングした (match:true) |
住所最下層までマッチングした (end:true) |
|---|---|---|---|
| マッチング住所文字列 | |||
| 地番・枝番までを指定し、マッチングに相違ない場合 | 東京都港区新橋１丁目２－６ | ○ | ○ |
| 東京都港区新橋１丁目２－６ | |||
|
主に住所を地番・枝番まで指定しない場合 (指定した住所文字列は末尾までマッチングしたが、住所最下層ではない) |
東京都港区新橋１丁目２ | ○ | × |
| 東京都港区新橋１丁目２ | |||
|
主に末尾にビル名など不要な文字列が入っている場合 (指定した住所文字列が末尾までマッチングしなかったが、住所最下層である) |
東京都港区新橋１丁目２－６ 第一ホテル東京 |
× | ○ |
| 東京都港区新橋１丁目２－６ | |||
|
主に存在しない住所を指定した場合 (指定した住所文字列とのマッチングでなく、マッチングした住所は最下層ではない) |
東京都港区新橋１丁目２－９ | × | × |
| 東京都港区新橋１丁目２ |
[出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/geocoding?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&address=東京都千代田区丸の内１‐９‐１
"code":"131010550010000900001",
"point":{"lat":35.6797778,
"lon":139.77165},
"parts":["東京都","千代田区","丸の内","１丁目","９","１"],
"kana":"トウキヨウトチヨダクマルノウチ",
"zipcode":"105-0004",
"match":true,
"end":true,
"bounds":null,
"kanaParts":["トウキヨウト","チヨダク","マルノウチ","","",""],
"level":"tbn",
"language":null}]