スポットオートコンプリート

/spot/autocomplete [GET]

基本情報

概要

指定したワードに対するスポット名の自動補完候補を取得します。 スポットとは下記のような施設全般を指します。

  • 飲食店、医療機関、娯楽施設、宿泊施設、小売店、公共施設、観光地 など

禁止事項

本APIで取得した駐車場データについて、データ提供元により許諾されていないため、
駐車場料金の安い順で表示することはお控えください。

URL

https://{HOST}/{CID}/v1/spot/autocomplete

※Rakuten RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
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パラメータ指定時のみ有効
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

データの出力件数について

当APIでは、出力件数が一律20までとなります。

パラメータ構成例

  • 「とうk」で始まるスポット名称の候補を検索
/spot/autocomplete?word=とうk
  • 「ぶど」を含むスポット名称の候補を取得
/spot/autocomplete?word=ぶど&word_match=partial
  • 東京駅周辺で検索半径3km以内にある「公園」を含むスポット名称の候補を検索
/spot/autocomplete?word_match=partial&coord=35.684031,139.764589&radius=3000&word=公園

レスポンス

名称 レスポンス名 型名 配列 説明
スポット情報 items Spot スポット情報のまとまり
単位情報 unit Unit 出力される単位の情報

Spotオブジェクト

名称 レスポンス名 型名 配列 説明
スポットコード code 文字列
スポット名 name 文字列
住所コード address_code 文字列
住所の表示名 address_name 文字列
緯度経度 coord Coordinateオブジェクト
カテゴリ一覧 categories Categoryオブジェクト

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
スポットの緯度 lat 数値
スポットの経度 lon 数値

Categoryオブジェクト

名称 レスポンス名 型名 配列 説明
カテゴリコード code 文字列
カテゴリ名 name 文字列
カテゴリ名の読み仮名 ruby 文字列
カテゴリコードのレベル level 文字列 large, middle, small, detail の4階層

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"
    }
}