緯度経度での郵便番号情報検索
API名:
address/zipcodelatlon
概要:
リクエストパラメータで指定される緯度経度を元に周辺の郵便番号データを返却します。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelatlon
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelatlon?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.7773116,139.6529444&radius=500
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|
| latlon | ○ | - | 緯度経度 |
| radius | 500 |
検索範囲指定 検索範囲の半径を指定します。(単位:m) 指定できる半径は 0～10000 です。 |
|
| datum | TOKYO |
測地系 入出力緯度経度の測地系を指定します。 |
|
| limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
出力データ
出力フォーマット
| キー名 | データ型 | 説明 | |||||
|---|---|---|---|---|---|---|---|
| status | object | ステータス情報が入ります。 | |||||
| code | string |
ステータスコードが入ります。
|
|||||
| text | string | ステータス内容に関するテキスト情報が入ります。 | |||||
| info | object | 検索結果の情報が入ります。 | |||||
| hit | number | 入力された条件に対してヒットした件数が入ります。 | |||||
| item | array | 検索結果の配列が入ります。検索結果が0件の場合は空の配列となります。 | |||||
| zipcode | number | 郵便番号(ハイフン無し)が入ります。 | |||||
| address | object |
検索結果の住所の配列が入ります。 ※ end及びboundsは常にnullになります。 |
|||||
| distance | number | 検索地点と代表点との距離(単位:m)が入ります。 | |||||
出力例
[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelatlon?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.7773116,139.6529444&radius=500
[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodelatlon?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&latlon=35.7032983,138.2820319
"text":"OK"},
"info":{"hit":0},"item":[]}