building_name
建物・テナント名称検索
フリーワードや住所コードや経緯度座標から建物・テナント情報を検索します。
※一部パラメータを利用するには別途契約が必要です。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
名前 | 説明 |
---|---|
word string |
名称、読みを指定 複数ワードはスペース区切りで指定してください。AND検索となります。 最大文字数 1024 |
word_match_type integer default 3 |
検索語句のマッチタイプを指定
|
address_code_list array[string] |
住所コードを指定(前方一致) 複数指定の場合はOR検索となります。 各住所コードの最大文字数 255 指定できる値は最大50件 |
proximity array[number] ※カンマ区切り |
中心座標、半径で範囲を指定 代表点の近傍検索。 "経度,緯度,半径(m)"で指定してください。 半径の上限は5000です。 |
limit array[integer] ※カンマ区切り default List[0,100] |
検索結果取得件数を"オフセット,件数"で指定 最大値 2000,1000 |
datum string default JGD |
入出力座標の測地系を指定 JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)
|
sort array[string] |
出力順を指定(複数指定可) デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。 デフォルト指定はありません(順不同)。 name
名称
name_read
名称読み
distance
検索座標と代表点の直線距離
|
building_type array[integer] default 3 |
区分を指定(複数指定可)
|
building_use array[integer] ※カンマ区切り |
premium 建物用途を指定(複数指定可)※本パラメータを利用するには別途契約が必要です。 デフォルト指定はありません。 |
pastmap_year array[integer] ※カンマ区切り |
premium
過去地図年度を指定(複数指定可)※本パラメータを利用するには別途契約が必要です。 ※地域と提供年の組み合わせについては「過去地図データ提供地区一覧表」をご参照ください。 |
正規化仕様
- 半角カタカナおよびひらがなは全角カタカナに変換されます。
- 拗音・促音は全角カタカナ大文字に変換されます。
- 旧字体は新字体に変換されます。
- 囲み文字は囲みがない形に変換されます。
- 踊り字については繰り返す対象の文字列に変換されます。
- 表記ゆれとなりうる記号、横棒、一部のカタカナ語については統一されます。
- 以下の文字及び文字列は削除されます。
株式会社、有限会社、合資会社、合名会社、医療法人、財団法人、社団法人、宗教法人、学校法人、社会福祉法人
㈱、㈲、㈳、㈴、㈵、㈶、㈸、㈹、㈻、㈼、㈽、㈾、㈿
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
キー名 | 説明 | ||
---|---|---|---|
|
ステータス | ||
|
|
hit integer |
検索結果総数 |
|
|||
zid string |
建物ZID 建物等の地物毎にふられるパーマネントのID |
||
zid_attr string |
属性ZID 建物や地物内のテナント施設等といった属性情報毎にふられるパーマネントのID |
||
id string |
ID(地物) 建物ZIDを0パディングし22桁に揃えた文字列 |
||
id_attr string |
ID(属性) 属性ZIDを0パディングし22桁に揃えた文字列 |
||
building_name string |
建物名称(基本属性名称) | ||
name string |
名称(別記名称) | ||
name_read string |
名称読み 常にnullです |
||
name_read_through string |
名称読み下し 読みと読み下しの違いは以下の通り ・読み :英数字は英数字のまま返却 ・読み下し:英数字の読みを返却(例:1→イチ、A→エー) ※いずれか、もしくはいずれもnullで返却される場合があります |
||
post_code string |
郵便番号 | ||
address_code string |
住所コード | ||
address string |
住所 | ||
room_count integer |
premium
部屋数※本パラメータを利用するには別途契約が必要です。 |
||
tenant_floor_type integer |
premium
階数種別。該当階の地上、地下などの種別※本パラメータを利用するには別途契約が必要です。
|
||
tenant_floor string |
premium
テナント・部屋の階数※本パラメータを利用するには別途契約が必要です。 |
||
tenant_floor_num string |
premium
テナント・部屋の階数数値※本パラメータを利用するには別途契約が必要です。 |
||
tenant_room_name string |
premium
部屋名称※本パラメータを利用するには別途契約が必要です。 |
||
parking_exist_flag integer |
駐車場有無
|
||
building_type integer |
建物・テナント等を判別する区分
|
||
building_top_floor_num integer |
建物の最上階数 | ||
building_bottom_floor_num integer |
建物の地下階数 (地下階が存在しない場合は0、地下階数が不明な場合は-1が返却されます。) |
||
position array[number] |
["経度","緯度"] | ||
pastmap_id integer |
premium
過去地図管理ID(過去地図データの場合のみ)※本パラメータを利用するには別途契約が必要です。 |
||
pastmap_year integer |
premium
過去地図年度(過去地図データの場合のみ)※本パラメータを利用するには別途契約が必要です。 |
||
distance number |
検索座標と代表点の直線距離(proximityを指定した場合のみ返却) | ||
building_use string |
premium
建物用途
※本パラメータを利用するには別途契約が必要です。 |
||
building_use_level string |
premium
建物用途の推定情報
※本パラメータを利用するには別途契約が必要です。
|
Example
https://[domain]/search/building_name?word=%E6%9D%B1%E4%BA%AC&word_match_type=3&limit=0,100&datum=JGD
{
"status": "OK",
"result": {
"info": {
"hit": 53127
},
"item": [
{
"zid": "000000000000000000",
"zid_attr": "000000000000000000",
"id": "0000000000000000000000",
"id_attr": "0000000000000000000000",
"building_name": "○○○○会館",
"name": "東京都○○○○",
"name_read": null,
"name_read_through": null,
"post_code": null,
"address_code": "0000000000000000000000000",
"address": "東京都千代田区平河町○丁目○-○",
"building_type": 3,
"building_top_floor_num": null,
"building_bottom_floor_num": null,
"position": [
139.73891547309,
35.6792103407118
],
"pastmap_id": null,
"pastmap_year": null,
"distance": null,
"room_count": null,
"tenant_floor_type": 0,
"tenant_floor": null,
"tenant_floor_num": null,
"tenant_room_name": null,
"parking_exist_flag": 0,
"building_use": null,
"building_use_level": null
},
...
]
}
}