スポット検索 (/spot/list)

基本情報

キーワードやカテゴリ、住所等指定した条件に該当する店舗情報を検索します。

出力形式 デフォルト ソート順
JSON キーワードの類似順

リクエストパラメータ

共通パラメータについて も参照してください。

パラメータ名 概要 入力値 必須 デフォルト 説明
word 検索キーワード 文字列      
address 住所コード 文字列    
指定した住所コードの住所内にある店舗に絞り込みを行います。
有効桁数は以下の通りです。
- 2桁(都道府県)
- 5桁(市区町村)
- 8桁(町・大字)
- 11桁(丁目・小字)
ピリオド区切りで複数指定可能
詳細は address-list を参照してください。
category カテゴリコード 文字列    
ピリオド区切りで複数指定が可能です。
詳細は category-tree を参照してください。
coord 緯度経度の指定。 カンマ区切りの数値(緯度,経度)     緯度経度の形式に関しては 緯度経度の形式について を参照
radius
検索範囲の半径
周辺のスポット検索をする際の半径値を設定する。
数値   2000
単位は「メートル」
coord指定時に有効です。
上限値は100000(10km)となります。
add 出力したい追加情報
文字列
- detail - 詳細情報
- opening_hours - 営業時間情報
    ピリオド区切りで複数指定が可能です。

フリーワード検索について

  • ふりがなの指定でも検索可能です
  • 独自の検索評価スコアによってヒットするスポットが決定されます
  • 検索ワードはスペースで区切ることで、複数指定することができます
  • 「改行」や「タブ」は消去したうえで検索されます

返却のソート順について

ソート順は以下の優先度に基づいて決定されます

優先度 パラメータ ソート内容
1 coord 指定緯度経度からの距離順
2 word キーワードの類似順
3 (上記のパラメータが未指定の場合) ナビタイム独自のランキング順

レスポンスオブジェクト

レスポンスオブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
count Object (Count) 検索件数情報
unit Object (Unit) 単位情報
items Array (Spot) 検索結果一覧

例:

{
    "count": {
        "total": 1560,
        "offset": 100,
        "limit": 10
    },
    "items": [
        {
            "code": "1240-a89011",
            "provider": {
                    "id": "00001",
                    "name": "ナビタイムジャパン"
            },
            "name": "◯◯レストラン二号店",
            "ruby": "◯◯れすとらんにごうてん",
            "address_name": "東京都大田区蒲田◯◯◯",
            "address_code": "13○○○○○",
            "postal_code": "ooo-xxxx",
            "coord": { ... },
            "categories": [ ... ],
            "phone": "03-xxxx-xxxx",
            "distance": 1000
        },
        ...
    ]
}

Count オブジェクト

Count オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
total Number 検索条件に該当する総件数
offset Number 出力項目の表示開始位置
limit Number 出力項目数の最大値

例:

{
   "total": 87,
   "offset": 0,
   "limit": 10
}

Spot オブジェクト

Spot オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
code String
スポットに紐づくユニークID
name String スポット名
ruby String スポット名の読み仮名
phone String 電話番号
address_code String 住所コード
address_name String 住所の表示名
postal_code String 郵便番号
coord Object (Coordinate) 緯度経度
distance
(OPTIONAL)
数値
距離(m)
検索条件に緯度経度を指定した場合に指定緯度経度からの距離を表示する。
categories
(OPTIONAL)
Array (Category) カテゴリの一覧
provider Object (Provider) 提供者情報
details
(OPTIONAL)
Array (SpotDetail)
詳細情報
追加情報パラメータ add=detail が指定されたときのみ出力される。

Category オブジェクト

Category オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
code String カテゴリコード
name String カテゴリ名
ruby String カテゴリ名の読み仮名
level String 階層の深さ
children Array (Category)
子要素
"/category/tree" でのみ出力される。

例:

{
   "code": "0112001001",
   "name": "人気スポット",
   "ruby": "にんきすぽっと",
   "level": "detail"
}
{
   "code": "0801001",
   "name": "ガソリンスタンド",
   "ruby": "がそりんすたんど",
   "level": "small",
   "children": [
       {
           "code": "0801001003",
           "name": "エネオス(JXTG)",
           "ruby": "えねおす/じぇいえっくすてぃーじー",
           "level": "detail"
       },
       ...
   ]
}

Coordinate オブジェクト

Coordinate オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
lat Number 緯度
lon Number 経度

例:

{
   "lat": 35.68956761,
   "lon": 139.70070036
}

SpotDetail オブジェクト

SpotDetail オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
texts
(OPTIONAL)
Array (TextItem) テキスト形式での情報表示
urls
(OPTIONAL)
Array (TextItem) URL情報
images
(OPTIONAL)
Array (Image) 画像情報
fuel_price
(OPTIONAL)
Object(FuelPrice) ガソリン価格情報
parking_status
(OPTIONAL)
Object(ParkingStatus) 駐車場の情報

Provider オブジェクト

Provider オブジェクトは次のプロパティを持ちます。

注釈

注意事項 にも記載していますが、データ提供元情報である本情報は必ず表示するようにしてください。

プロパティ名 データ型 説明
id String 提供者ID
name String 提供者名
url
(OPTIONAL)
String URL
icon.path
(OPTIONAL)
String アイコンのパス
copyright
(OPTIONAL)
String ライセンス表記

TextItem オブジェクト

TextItem オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
label String 見出し
value String 文字列値