premiumbm_address
地番検索
地番検索を行います。
・地番フリーワード検索
住所文字列から該当する地番情報を検索します。
・地番リスト取得
住所コードに該当する地番情報を検索します。
・範囲指定地番検索
中心座標、半径で範囲を指定し範囲内の地番情報を検索します。
検索条件を複数指定した場合はAND結合となります。
ブルーマップデータについてはこちらをご確認ください。
地番とはなんですか。
※本APIを利用するには別途契約が必要です。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
| 名前 | 説明 |
|---|---|
| word string |
住所名称、読みを指定 最大文字数 255文字。 先頭から100文字までの文字列で検索します。 |
| word_match_type integer default 3 |
検索語句のマッチタイプを指定
|
| address_code string |
住所コードを指定 最大文字数 255 |
| code_match_type integer default 1 |
住所コードのマッチタイプを指定
|
| proximity array[number] ※カンマ区切り |
中心座標、半径で範囲を指定 代表点の近傍検索。 "経度,緯度,半径(m)"で指定してください。 半径の上限は5000です。 |
| address_level array[string] default TOD,SHK,OAZ,AZC,GIK,TBN,EBN |
検索する住所の階層を指定(複数指定可)
|
| sort array[string] default address_code |
出力順を指定(複数指定可) デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。 address_code
住所コード
address_read
住所読み
address_level
住所階層レベル
distance
検索座標と代表点の直線距離
|
| limit array[integer] ※カンマ区切り default List[0,100] |
検索結果取得件数を指定 "オフセット,件数"で指定してください。 1階層で10000レコードを超える住所があり、リスト表示での全件取得を可能とするため住所検索と地番検索のみ、オフセット値の上限を20000としています。 最大値 20000,1000 |
| datum string default JGD |
入出力座標の測地系を指定 JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)
|
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
| キー名 | 説明 | ||
|---|---|---|---|
| status string |
ステータス | ||
| result | info | hit integer |
検索結果総数 |
| item | address_code string |
住所コード | |
| address string |
住所 | ||
| address_read string |
住所読み | ||
| address_code2 string |
都道府県コード | ||
| address2 string |
都道府県名称 | ||
| address_read2 string |
都道府県名称読み | ||
| address_code3 string |
市区町村コード | ||
| address3 string |
市区町村名称 | ||
| address_read3 string |
市区町村名称読み | ||
| address_code4 string |
大字コード | ||
| address4 string |
大字名称 | ||
| address_read4 string |
大字名称読み | ||
| address_code5 string |
字丁目コード | ||
| address5 string |
字丁目名称 | ||
| address_read5 string |
字丁目名称読み | ||
| address_detail_code1 string |
街区コード | ||
| address_detail1 string |
街区名称 | ||
| address_detail_read1 string |
街区名称読み | ||
| address_detail_code2 string |
地番コード | ||
| address_detail2 string |
地番名称 | ||
| address_detail_read2 string |
地番名称読み | ||
| address_branch_code2 string |
枝番コード | ||
| address_branch2 string |
枝番名称 | ||
| address_branch_read2 string |
枝番名称読み | ||
| address_level string |
住所階層情報
|
||
| position array[number] |
["経度","緯度"] | ||
| distance number |
検索座標と代表点の直線距離(proximityを指定した場合のみ返却) | ||
Example
https://[domain]/search/bm_address?word_match_type=3&code_match_type=1&limit=0,100&datum=JGD
{
"status": "OK",
"result": {
"info": {
"hit": 45734946
},
"item": [
{
"address_code": "010000000000000000000000000000",
"address": "北海道",
"address_read": "ホッカイドウ",
"address_code2": "01",
"address2": "北海道",
"address_read2": "ホッカイドウ",
"address_code3": "000",
"address3": null,
"address_read3": null,
"address_code4": "00000",
"address4": null,
"address_read4": null,
"address_code5": "00000",
"address5": null,
"address_read5": null,
"address_detail_code1": "00000",
"address_detail1": null,
"address_detail_read1": null,
"address_detail_code2": "00000",
"address_detail2": null,
"address_detail_read2": null,
"address_branch_code2": "00000",
"address_branch2": null,
"address_branch_read2": null,
"address_level": "TOD",
"position": [
141.34685722222,
43.064514444444
],
"distance": null
},
{
"address_code": "011010000000000000000000000000",
"address": "北海道札幌市中央区",
"address_read": "ホッカイドウサツポロシ|チユウオウク",
"address_code2": "01",
"address2": "北海道",
"address_read2": "ホッカイドウ",
"address_code3": "101",
"address3": "札幌市|中央区",
"address_read3": "サツポロシ|チユウオウク",
"address_code4": "00000",
"address4": null,
"address_read4": null,
"address_code5": "00000",
"address5": null,
"address_read5": null,
"address_detail_code1": "00000",
"address_detail1": null,
"address_detail_read1": null,
"address_detail_code2": "00000",
"address_detail2": null,
"address_detail_read2": null,
"address_branch_code2": "00000",
"address_branch2": null,
"address_branch_read2": null,
"address_level": "SHK",
"position": [
141.32022027778,
43.037732777778
],
"distance": null
},
{
"address_code": "011011000100000000000000000000",
"address": "北海道札幌市中央区旭ケ丘",
"address_read": "ホッカイドウサツポロシ|チユウオウクアサヒガオカ",
"address_code2": "01",
"address2": "北海道",
"address_read2": "ホッカイドウ",
"address_code3": "101",
"address3": "札幌市|中央区",
"address_read3": "サツポロシ|チユウオウク",
"address_code4": "10001",
"address4": "旭ケ丘",
"address_read4": "アサヒガオカ",
"address_code5": "00000",
"address5": null,
"address_read5": null,
"address_detail_code1": "00000",
"address_detail1": null,
"address_detail_read1": null,
"address_detail_code2": "00000",
"address_detail2": null,
"address_detail_read2": null,
"address_branch_code2": "00000",
"address_branch2": null,
"address_branch_read2": null,
"address_level": "OAZ",
"position": [
141.32022027778,
43.037732777778
],
"distance": null
},
{
"address_code": "011011000110001000000000000000",
"address": "北海道札幌市中央区旭ケ丘１丁目",
"address_read": "ホッカイドウサツポロシ|チユウオウクアサヒガオカ",
"address_code2": "01",
"address2": "北海道",
"address_read2": "ホッカイドウ",
"address_code3": "101",
"address3": "札幌市|中央区",
"address_read3": "サツポロシ|チユウオウク",
"address_code4": "10001",
"address4": "旭ケ丘",
"address_read4": "アサヒガオカ",
"address_code5": "10001",
"address5": "１丁目",
"address_read5": null,
"address_detail_code1": "00000",
"address_detail1": null,
"address_detail_read1": null,
"address_detail_code2": "00000",
"address_detail2": null,
"address_detail_read2": null,
"address_branch_code2": "00000",
"address_branch2": null,
"address_branch_read2": null,
"address_level": "AZC",
"position": [
141.32013416667,
43.042777222222
],
"distance": null
},
・・・
]
}
}