住所ポリゴン検索
API名:
address_polygon
概要:
指定地点から住所ポリゴン検索を行います。
ゼンリンポリシーに則り提供される為、地点によってはポリゴンが無い場合があります。
※一部パラメータを利用するには別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address_polygon
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address_polygon?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=13&level=tod
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| latlon | ※ | - |
緯度経度
緯度経度を指定し、指定緯度経度を内包する住所ポリゴンを検索します。
※latlonとaddrcodeを同時に指定することはできません。 latlonとaddrcodeをどちらも指定していない場合、エラーとなります。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
| addrcode | ※ | - |
住所コード 住所コードを指定し、指定住所コードに該当した住所ポリゴンを検索します。 大字(8桁)まで指定可能です。大字以降の住所コード指定時、エラーとなります。 別途契約することで字丁目・街区(16桁)まで指定可能となります。 その場合、街区以降の住所コード指定時、エラーとなります。 ※latlonとaddrcodeを同時に指定することはできません。 latlonとaddrcodeをどちらも指定していない場合、エラーとなります。 ※一部パラメータを指定する際は別途契約が必要です。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
| level | tod |
住所ポリゴン階層 取得する住所ポリゴンの階層をtod,shk,oazから指定できます。 tod,shk,oaz以外の住所階層を指定時、エラーとなります。 別途契約をすることでazc,gikが指定可能となります。 その場合、tod,shk,oaz,azc,gik以外の住所階層を指定時、エラーとなります。 addrcodeを指定した場合は無効になります。 ※一部パラメータを指定する際は別途契約が必要です。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| thiningrate | - |
間引き率 ポリゴンの間引き率を小数または整数で指定します。 デフォルトは指定パラメータによって異なります。 0を指定すると間引きは行いません。下限値より小さい値を指定するとエラーとなります。
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| datum | TOKYO |
測地系 入出力緯度経度の測地系を指定します。 |
出力データ
出力フォーマット
{ "status":"OK", "result":{"type": "Feature", "geometry": { "type": "MultiPolygon", "coordinates":[ [ [ [102.0, 2.0], [103.0, 2.0], [103.0, 3.0], [102.0, 3.0], [102.0, 2.0] ] ], [ [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ], [ [100.2, 0.2], [100.8, 0.2], [100.8, 0.8], [100.2, 0.8], [100.2, 0.2] ] ] ]}, "properties":{"text":"住所名", "code":"住所コード", "point":{"lat":35.6632111, "lon":139.77165}, "parts":["都道府県名","市区町村名","大字名","字丁目名","街区名"]}} }
| キー名 | データ型 | 説明 | ||||
|---|---|---|---|---|---|---|
| status | string |
検索結果の情報が入ります。
|
||||
| result | object |
GeoJsonのFeatureが入ります。 クエリ条件に該当する住所ポリゴンが存在しない場合はnullとなります。 |
||||
| type | string | Feature固定となります。 | ||||
| geometry | object | 検索された住所ポリゴン情報が入ります。 | ||||
| type | string | ジオメトリのタイプPolygonもしくはMultiPolygonが入ります。 | ||||
| coordinates | array |
ポリゴンの点情報が入ります。 クエリパラメータllunitの指定に関わらず、10進度形式となります。 GeoJson仕様では測地系がWGS84に限定されていますが、本値はクエリパラメータdatumの指定が有効です。 |
||||
| properties | object | 検索された住所属性情報が入ります。 | ||||
| text | string |
住所表記文字列が入ります。 不明な場合nullとなります。 |
||||
| code | string |
住所コードが入ります。 不明な場合nullとなります。 |
||||
| point | object |
代表点緯度経度が入ります。 不明な場合nullとなります。 |
||||
| parts | array |
住所階層毎に分割された文字列が入ります。(最大大字まで返却、別途契約することで最大街区まで返却) 不明な場合空配列となります。 |
||||
出力例
[例:Polygon(穴なし)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address_polygon?
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
latlon=32.362644167%2C130.348281667&level=oaz&thiningrate=0.99&datum=TOKYO
{ "status":"OK", "result":{"type":"Feature", "geometry":{"type":"Polygon", "coordinates":[ [ [130.35401333333,32.357991111111], [130.34567111111,32.360711666667], [130.34449638889,32.367872222222], [130.35309055556,32.369665277778], [130.35401333333,32.357991111111] ] ] }, "properties":{"text":"熊本県天草市御所浦町横浦", "code":"43215051", "point":{"lat":32.3646472, "lon":130.3509056}, "parts":["熊本県","天草市","御所浦町横浦"]}} }
[例:Polygon(穴あり)]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address_polygon?
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
latlon=34.712639167%2C135.312305833&level=shk&thiningrate=0.99&datum=TOKYO
{ "status":"OK", "result":{"type":"Feature", "geometry":{"type":"MultiPolygon", "coordinates":[ [ [ [135.2788025,34.755307777778], [135.27906805556,34.755229166667], [135.27886361111,34.754634722222], [135.27854777778,34.7547275], [135.2788025,34.755307777778] ] ], [ [ [135.30970833333,34.7114275], [135.28283138889,34.748470555556], [135.2702475,34.777776111111], [135.31984472222,34.743061666667], [135.30970833333,34.7114275] ], [ [135.31177611111,34.711410833333], [135.31200611111,34.710648055556], [135.32384361111,34.712973055556], [135.32351166667,34.714161388889], [135.31177611111,34.711410833333] ] ] ] }, "properties":{"text":"兵庫県芦屋市", "code":"28206", "point":{"lat":34.7237056, "lon":135.3069556}, "parts":["兵庫県","芦屋市",""]}} }
[例:MultiPolygon]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address_polygon?
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&
latlon=41.542781944%2C140.917254444&level=oaz&thiningrate=0.99&datum=TOKYO
{ "status":"OK", "result":{"type":"Feature", "geometry":{"type":"MultiPolygon", "coordinates":[ [ [ [140.91338083333,41.553311388889], [140.91770472222,41.552065277778], [140.91649583333,41.549873333333], [140.91411583333,41.549557222222], [140.91338083333,41.553311388889] ] ], [ [ [140.93217,41.505204444444], [140.90607527778,41.512269166667], [140.91129722222,41.541548611111], [140.94153416667,41.525669722222], [140.93217,41.505204444444] ] ] ] }, "properties":{"text":"青森県下北郡大間町大間", "code":"02423001", "point":{"lat":41.5255333, "lon":140.9106889}, "parts":["青森県","下北郡|大間町","大間"]}} }
[例:検索結果が0件]
{"status":"OK", "result":null}