複数要素オートコンプリート
/multiple/autocomplete [GET]
基本情報
概要
キーワードを指定して様々な情報を取得します。
URL
https://{HOST}/{CID}/v1/multiple/autocomplete
※APIマーケットでは提供しておりません
出力形式
- json
対応言語
- ja
出力順
- 検索条件の適合順で返却
- キーワードの類似度と検索のランキングを考慮した株式会社ナビタイムジャパン独自のスコア降順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| word | (✔) | 検索ワード | 文字列 | 2文字以上50文字以下 | ふりがなの指定でも検索可能 スペースで区切ることで複数の検索ワードが指定可能 「改行」や「タブ」は消去したうえで検索される |
|
| types | 検索対象種別 | 文字列 | address.station | spot：スポット station：駅 airport：空港 address：住所 port：港 category：カテゴリ busstop：バス停 shuttle_busstop：シャトルバスのバス停 highway_busstop：高速バスのバス停 |
ピリオド区切りで複数指定可能 spot、busstop、shuttle_busstop、highway_busstopを利用する場合はオプション申込時のみ利用可能 |
|
| address_filter | 住所フィルター | 文字列 | 住所を絞り込むフィルター 住所コード(code)を指定する ・指定コードによる絞り込み:address_filter=code ・指定コードの除外：address_filter=-code ・複数指定の場合は、上記指定を「.」区切りで指定 |
|||
| category_filter | カテゴリフィルター | 文字列 | カテゴリを絞り込むフィルター カテゴリコード(code)を指定する ・指定コードによる絞り込み:category_filter=code ・指定コードの除外：category_filter=-code ・複数指定の場合は、上記指定を「.」区切りで指定 |
|||
| coord | 検索基点 | カンマ区切りの数値 | 検索を行う基準地点の緯度経度 ・「緯度,経度」の順で指定 ・ミリ秒表記、度表記(10進数)に対応 指定した場合は距離を出力順序のスコアリングに反映して検索します |
|||
| move | 移動手段の考慮 | 文字列 | car：車 totalnavi：公共交通+徒歩 |
未指定の場合の挙動はtotalnavi指定時と同等 | ||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
パラメータ構成例
- 検索ワード「羽田」で住所・駅・空港・港にあてはまる対象を検索
/multiple/autocomplete?word=羽田&type=address.station.airport.port
- 検索ワード「品川」で住所・駅にあてはまり、品川駅付近の対象を検索
/multiple/autocomplete?word=品川&types=address.station&coord=35.628066,139.738891
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 施設/駅/住所などの情報 | items | Candidateオブジェクト | 〇 | 施設/駅/住所などの情報 |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Candidateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| コード | code | 文字列 | 以下のいずれか - スポットコード - 住所コード - ノードID - カテゴリコード |
|
| 名称 | name | 文字列 | ||
| 読み仮名 | ruby | 文字列 | ||
| 主種別 | main_type | 文字列 | 以下のいずれか spot：スポット station：駅 airport：空港 address：住所 port：港 category：カテゴリ busstop：バス停 shuttle_busstop：シャトルバスのバス停 highway_busstop：高速バスのバス停 |
|
| 種別リスト | types | 文字列 | 〇 | 以下のいずれかが配列形式で返却される spot：スポット station：駅 airport：空港 address：住所 port：港 category：カテゴリ busstop：バス停 shuttle_busstop：シャトルバスのバス停 highway_busstop：高速バスのバス停 |
| 緯度経度 | coord | Coordinateオブジェクト | main_typeがcategoryの場合は出力されない データが存在する場合のみ出力 |
|
| 住所コード | address_code | 文字列 | main_typeがcategoryの場合は出力されない データが存在する場合のみ出力 |
|
| 住所の表示名 | address_name | 文字列 | main_typeがcategoryの場合は出力されない データが存在する場合のみ出力 |
|
| カテゴリコード | category_code | 文字列 | main_typeがspot,categoryのいずれかの場合のみ返却される データが存在する場合のみ出力 |
|
| カテゴリ名 | category_name | 文字列 | main_typeがspot,categoryのいずれかの場合のみ返却される データが存在する場合のみ出力 |
|
| 住所詳細情報 | address | AddressDetailオブジェクト | ||
| 距離 (単位：m) | distance | 数値 | 検索基点からの距離 main_typeがcategoryの場合は出力されない パラメータ「coord」指定時のみ出力 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポットの緯度 | lat | 数値 | ||
| スポットの経度 | lon | 数値 |
AddressDetailオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 住所階層終端フラグ | is_end | 真偽値 | 住所階層の深さが最下であることを表すフラグ 以下のいずれかが返却される true：詳細な住所は存在しない false：詳細な住所が存在する データが存在する場合のみ出力 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{
"items": [
{
"code": "00007825",
"name": "品川",
"ruby": "しながわ",
"address_code": "13103017000",
"address_name": "東京都港区高輪",
"coord": {
"lon": 139.738891,
"lat": 35.628066
},
"type": "station",
"distance": 0
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord": "degree",
"distance": "metre"
}
}