スポットオートコンプリート
/spot/autocomplete [GET]
基本情報
概要
指定したワードに対するスポット名の自動補完候補を取得します。 スポットとは下記のような施設全般を指します。
- 飲食店、医療機関、娯楽施設、宿泊施設、小売店、公共施設、観光地 など
※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります
禁止事項
本APIで取得した駐車場データについて、データ提供元により許諾されていないため、
駐車場料金の安い順で表示することはお控えください。
URL
https://{HOST}/{CID}/v1/spot/autocomplete
※APIマーケットでは提供しておりません
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| word | ✔ | 検索ワード | 文字列 | 最小：2文字 最大：50文字 |
検索したいスポット名称 アラビア数字・漢数字はそのまま検索します |
|
| word_match | 検索方法 | 文字列 | prefix | ワードの検索方法 prefix : 前方一致 partial : 部分一致 |
||
| category_filter | カテゴリフィルター | 文字列 | カテゴリを絞り込むフィルター カテゴリコード(code)を指定する ・指定コードによる絞り込み:category_filter=code ・指定コードの除外：category_filter=-code ・複数指定の場合は上記指定を「.」区切りで指定 |
|||
| coord | 検索基点 | カンマ区切りの数値 | 検索を行う基準地点の緯度経度 ・「緯度,経度」の順で指定 ・ミリ秒表記、度表記(10進数)に対応 coordパラメータ指定時には指定した緯度経度からの距離順で返却されます |
|||
| radius | 検索範囲の半径(単位：m) | 数値 | 10000 | 最大値：100000 | coord指定時のみ有効 | |
| consider_distance | 距離の考慮 | 真偽値 | false | true：考慮する false：考慮しない |
距離を出力順序のスコアリングに反映させるかどうかを指定します 以下の場合はエラーとなります ・coordを指定していない場合 ・radiusと同時指定した場合 radiusとの違いについてはこちらをご覧ください |
|
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ※多言語オプション申込時のみ利用可能 |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
consider_distanceとradiusの違いについて
consider_distanceを指定した場合とradiusを指定した場合では、検索方法に以下のような違いがあります。
radiusを指定した場合：検索範囲を指定した検索が可能。
consider_distanceを指定した場合：検索範囲は全国として、指定したcoordから検索対象スポットまでの距離の近さを考慮した検索が可能。ただし検索ワード等を加味して総合的な判断を行うため、必ずしも距離が近い順に出力されるわけではありません。
データの出力件数について
当APIでは、出力件数が一律20までとなります。
langパラメータの指定時の注意点
・langパラメータ指定時のレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
・一部スポットは多言語データが存在しないため、langパラメータ指定時には返却されない場合があります。
パラメータ構成例
- 「とうｋ」で始まるスポット名称の候補を検索
/spot/autocomplete?word=とうｋ
- 「ぶど」を含むスポット名称の候補を取得
/spot/autocomplete?word=ぶど&word_match=partial
- 東京駅周辺で検索半径3km以内にある「公園」を含むスポット名称の候補を検索
/spot/autocomplete?coord=35.684031,139.764589&radius=3000&word=公園&word_match=partial
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポット情報 | items | Spot | 〇 | スポット情報のまとまり |
| 単位情報 | unit | Unit | 出力される単位の情報 |
Spotオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポットコード | code | 文字列 | ||
| スポット名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 住所コード | address_code | 文字列 | ||
| 住所の表示名 | address_name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 緯度経度 | coord | Coordinateオブジェクト | ||
| カテゴリ一覧 | categories | Categoryオブジェクト | 〇 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポットの緯度 | lat | 数値 | ||
| スポットの経度 | lon | 数値 |
Multilingualオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 英語名称 | en | 文字列 | ||
| 日本語名称 | ja | 文字列 | ||
| 韓国語名称 | ko | 文字列 | ||
| タイ語名称 | th | 文字列 | ||
| 中国語(簡体字)名称 | zh-CN | 文字列 | ||
| 中国語(繁体字)名称 | zh-TW | 文字列 |
Categoryオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| カテゴリコード | code | 文字列 | ||
| カテゴリ名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| カテゴリ名の読み仮名 | ruby | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 ただし"ja"を指定した場合のみ 他の言語コード指定時は返却しない |
|
| カテゴリコードのレベル | level | 文字列 | large, middle, small, detail の４階層 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{
"items": [
{
"code": "01150-246592",
"name": "ローソン 赤坂氷川公園前店",
"address_code": "13103001000",
"address_name": "東京都港区赤坂6-2-4",
"coord": {
"lat": 35.671332,
"lon": 139.737133
},
"categories": [
{
"code": "0201001009",
"name": "ローソン",
"ruby": "ろーそん",
"level": "detail"
},
{
"code": "0201001",
"name": "コンビニ",
"ruby": "こんびに",
"level": "small"
},
{
"code": "0201",
"name": "コンビニ",
"ruby": "こんびに",
"level": "middle"
},
{
"code": "02",
"name": "お買い物",
"ruby": "おかいもの",
"level": "large"
}
]
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
レスポンス例(word=Tok&lang=en指定時)
{
"items": [
{
"code": "02301-1400453",
"name": {
"en": "Tokyo Disneyland"
},
"address_code": "12227017000",
"address_name": {
"en": "Chiba Pref. Urayasushi Maihama 1-1"
},
"coord": {
"lat": 35.632548,
"lon": 139.881327
},
"categories": [
{
"code": "0101001001",
"name": {
"en": "Amusement Park / Theme Park"
},
"level": "detail"
},
{
"code": "0101001",
"name": {
"en": "Amusement Park / Theme Park"
},
"level": "small"
},
{
"code": "0101",
"name": {
"en": "Leisure / Outdoors"
},
"level": "middle"
},
{
"code": "01",
"name": {
"en": "Leisure / Hobbies"
},
"level": "large"
}
]
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}