緯度経度矩形範囲での郵便番号情報検索

API名:

address/zipcodebounds

概要:

リクエストパラメータで指定される緯度経度の範囲の、郵便番号データを返却します。

URI:

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodebounds

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodebounds?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&llbounds=35.6625506,139.7286503,35.6955028,139.7948269&limit=100&datum=TOKYO

リクエストパラメータ

パラメータ	必須	デフォルト値	説明
llbounds	○	-	矩形緯度経度の指定南西緯度、南西経度、北東緯度、北東経度の順で指定します。検索できる範囲は、一辺200km以内です。 (200kmを超えた結果は取得できません) 本項目は必須項目であるため、未指定の場合はエラーとなります。
datum		TOKYO	測地系入出力緯度経度の測地系を指定します。
llunit		dec	緯度経度形式緯度経度形式を指定します。
limit		0,100	検索結果取得件数検索結果取得件数を指定します。取得開始位置の指定範囲は 0～10000 です。 10001 以上の指定をした場合は10000指定と同様の結果となります。取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。

出力データ

出力フォーマット

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":2021},
"item":[{"zipcode":"1000001",
"address":{"text":"東京都千代田区千代田",
"code":"13101045000",
"point":{"lat":35.6806139,
"lon":139.7572056},
"parts":["東京都","千代田区","千代田",""],
"kana":"トウキヨウトチヨダクチヨダ",
"end":null,
"bounds":null,
"kanaParts":["トウキヨウト","チヨダク","チヨダ",""]
}},...]}

キー名		データ型	説明
status		object	ステータス情報が入ります。
info		object	検索結果の情報が入ります。
	hit	number	入力された条件に対してヒットした件数が入ります。
item		array	検索結果が0件の場合は空の配列となります。
	zipcode	string	郵便番号(ハイフン無し)が入ります。
	address	object	住所の配列が入ります。

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodebounds?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&llbounds=35.6625506,139.7286503,35.6955028,139.7948269

{"status":{"code":"0000",
               "text":"OK"},
"info":{"hit":2021},
"item":[{"zipcode":"1000001",
            "address":{"text":"東京都千代田区千代田",
                       "code":"13101045000",
                       "point":{"lat":35.6806139,
                                "lon":139.7572056},
                       "parts":["東京都","千代田区","千代田",""],
                       "kana":"トウキヨウトチヨダクチヨダ",
                       "end":null,
                       "bounds":null,
                       "kanaParts":["トウキヨウト","チヨダク","チヨダ",""],
                       "level":"azc"}},
           {"zipcode":"1000002",
            "address":{"text":"東京都千代田区皇居外苑",
                       "code":"13101039000",
                       "point":{"lat":35.6737278,
                                "lon":139.7620556},
                       "parts":["東京都","千代田区","皇居外苑",""],
                       "kana":"トウキヨウトチヨダクコウキヨガイエン",
                       "end":null,
                       "bounds":null,
                       "kanaParts":["トウキヨウト","チヨダク","コウキヨガイエン",""],
                       "level":"azc"}},
           {"zipcode":"1000003",
            "address":{"text":"東京都千代田区一ツ橋１丁目",
                       "code":"13101051001",
                       "point":{"lat":35.6875861,
                                "lon":139.7613028},
                       "parts":["東京都","千代田区","一ツ橋","１丁目"],
                       "kana":"トウキヨウトチヨダクヒトツバシ",
                       "end":null,
                       "bounds":null,
                       "kanaParts":["トウキヨウト","チヨダク","ヒトツバシ",""],
                       "level":"azc"}},
...]}

[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/zipcodebounds?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&llbounds=45.6625506,145.7286503,46.6955028,146.7948269

{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":0},
"item":[]}