道沿いスポットカテゴリ検索

/spot/line/category_code [GET]

基本情報

概要

カテゴリと緯度経度形状情報を条件として、スポットの一覧を取得します。
スポットとは下記のような施設全般を指します。

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

禁止事項

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

URL

https://{HOST}/{CID}/v1/spot/line/category_code

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

出力形式

  • JSON

対応言語

  • ja

出力順

  • 指定した緯度経度形状情報からの直線距離昇順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
category カテゴリコード 文字列 検索したいカテゴリコード
coords 緯度経度形状情報 カンマ区切りの緯度経度の配列 形状点の地点数
最小値:2
最大値:150
形状点をつないでできるポリラインをもとに、空間検索を行います。
・「緯度,経度」の順で指定
・ミリ秒表記、度表記(10進数)に対応
・形状点列の合計距離が150kmより短くなるように指定してください
width 線の太さ(単位:m) 数値 最小値:5
最大値:500
検索する線の太さを設定します
limit データの出力件数 数値 10 最小値:1
最大値:100
スポットデータの出力数
offset データの出力開始位置 数値 0 最小値:0
最大値:2000
何件目から表示されるか(1件目が0)を指定します
options 追加出力情報 文字列 exact_coord:スポット到着地点
detail:詳細情報
追加で出力する情報
・ピリオド区切りで複数指定可能
※exact_coordはD2Dオプション申込時のみ利用可能
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

パラメータ構成例

  • 表参道〜外苑駅前の道沿い100mにあるコンビニを10件検索
/spot/line/category_code?category=0201&width=100&coords=%5B%5B128394666%2C502965778%5D%2C%5B128394486%2C502965626%5D%2C%5B128394486%2C502965626%5D%2C%5B128394335%2C502965828%5D%2C%5B128394259%2C502965940%5D%2C%5B128393993%2C502966321%5D%2C%5B128393824%2C502966591%5D%2C%5B128393525%2C502967020%5D%2C%5B128393795%2C502967041%5D%2C%5B128394050%2C502967290%5D%2C%5B128393960%2C502967448%5D%2C%5B128393676%2C502967200%5D%2C%5B128393600%2C502967131%5D%2C%5B128393780%2C502966840%5D%2C%5B128394306%2C502966008%5D%2C%5B128394367%2C502965940%5D%2C%5B128394724%2C502966253%5D%2C%5B128395822%2C502967268%5D%2C%5B128397067%2C502968395%5D%2C%5B128397755%2C502969000%5D%2C%5B128398583%2C502969694%5D%2C%5B128399512%2C502970555%5D%2C%5B128400592%2C502971520%5D%2C%5B128400710%2C502971631%5D%2C%5B128401146%2C502972016%5D%2C%5B128401715%2C502972553%5D%2C%5B128403562%2C502974194%5D%2C%5B128403846%2C502974418%5D%2C%5B128405675%2C502975904%5D%2C%5B128406892%2C502976894%5D%2C%5B128407763%2C502977568%5D%2C%5B128408062%2C502977816%5D%2C%5B128407882%2C502978108%5D%2C%5B128408436%2C502978536%5D%2C%5B128408616%2C502978244%5D%2C%5B128408886%2C502978493%5D%2C%5B128409606%2C502979123%5D%2C%5B128410207%2C502979659%5D%2C%5B128411046%2C502980426%5D%2C%5B128411330%2C502980696%5D%2C%5B128411359%2C502980743%5D%2C%5B128411644%2C502981214%5D%2C%5B128412018%2C502981808%5D%2C%5B128411986%2C502981844%5D%5D&limit=10

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト レスポンスのヒット数などの情報
スポット情報 items Spotオブジェクト スポット情報のまとまり
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Spotオブジェクト

名称 レスポンス名 型名 配列 説明
スポットコード code 文字列
スポット名 name 文字列
スポット名の読み仮名 ruby 文字列
電話番号 phone 文字列 表示用電話番号
ハイフン区切りの電話番号
住所コード address_code 文字列
住所の表示名 address_name 文字列
緯度経度 coord Coordinateオブジェクト
距離(単位:m) distance 数値 検索基点からの距離(単位:m)
郵便番号 postal_code 文字列
カテゴリ一覧 categories Categoryオブジェクト
道路情報 road_info RoadInfoオブジェクト データが存在する場合のみ出力
サブカテゴリ情報 subcategories SubCategoryオブジェクト
詳細情報 details SpotDetailオブジェクト パラメータ「options=detail」指定時かつデータが存在する場合のみ出力
出力優先度を考慮してソートされています
スポット到着地点の緯度経度 exact_coord SpotExactCoordオブジェクト パラメータ「options=exact_coord」指定時のみ出力
データに入っている場合のみ出力

Coordinateオブジェクト

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

Categoryオブジェクト

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

SubCategoryオブジェクト

名称 レスポンス名 型名 配列 説明
カテゴリ一覧 - Categoryオブジェクト レスポンス名なし
Categoryオブジェクトの配列

サブカテゴリについて

「薬局」系のスポットは「病院/医療」や「生活雑貨/日用品」といった複数カテゴリに分類され、代表カテゴリ以外のものがサブカテゴリとしてここに出力されます。
代表カテゴリの選定は株式会社ナビタイムジャパンにて独自に行っており、変更はできません。
また、カテゴリ指定時はこれら全てのものが検索対象となります。

RoadInfoオブジェクト

名称 レスポンス名 型名 配列 説明
道路種別の名称 name 文字列 値は常に"有料道路"が出力されます

SpotDetailオブジェクト

名称 レスポンス名 型名 配列 説明
フラグ情報 flags BooleanItemオブジェクト データが存在する場合のみ出力
テキスト情報 texts TextItemオブジェクト データが存在する場合のみ出力
駐車場の満空情報 parking_status ParkingStatusオブジェクト データが存在する場合のみ出力
大型車専用駐車場の満空情報 large_car_parking_status ParkingStatusオブジェクト データが存在する場合のみ出力
日付情報 dates TextItemオブジェクト データが存在する場合のみ出力
宣伝情報 copies TextItemオブジェクト データが存在する場合のみ出力
URL情報 urls TextItemオブジェクト データが存在する場合のみ出力
駐車場の静的な情報 parking Parkingオブジェクト データが存在する場合のみ出力

BooleanItemオブジェクト

名称 レスポンス名 型名 配列 説明
見出し label 文字列
真偽値 value 真偽値

TextItemオブジェクト

名称 レスポンス名 型名 配列 説明
見出し label 文字列
文字列値 value 文字列
項目ID id 文字列

ParkingStatusオブジェクト

名称 レスポンス名 型名 配列 説明
ステータスコード code 文字列 下記のうちいずれかの数字が格納されます
0 - 空
1 - 混雑
2 - 満車
3 - 閉鎖
7 - 不明
「不明」はセンサーの障害やお祭りなどで利用できない状態を表します
状態を表す文字列 text 文字列 ステータスコードによって出力される文字列が異なります
0 - 空
1 - 混雑
2 - 満車
3 - 閉鎖
7 - 不明
「不明」はセンサーの障害やお祭りなどで利用できない状態を表します
データ更新時刻 update_time 文字列

Parkingオブジェクト

名称 レスポンス名 型名 配列 説明
車両に関する制限 car_regulation ParkingCarRegulationオブジェクト
充電の可否 chargeable 真偽値
駐車可能台数 capacity 数値
駐車場の形式 building_type 文字列 flat:平地
solid:立体
underground:地下
machine:機械式
駐車場料金情報 prices ParkingPriceオブジェクト
料金支払い方法 payment_method 文字列 bill:紙幣
credit:クレジットカード
e_money:電子マネー
領収書の有無 receipt 真偽値 領収書がある場合のみtrueが出力されます

ParkingCarRegulationオブジェクト

名称 レスポンス名 型名 配列 説明
最大車高(cm) height 数値
最大車幅(cm) width 数値
最大車長(cm) length 数値
最大車重(kg) weight 数値
車種制限 car_type 文字列 3number:3ナンバー制限
5number:5ナンバー制限
imported:外車制限
rv:RV制限
1box:1ボックス制限

ParkingPriceオブジェクト

名称 レスポンス名 型名 配列 説明
曜日ID day_id 文字列 01:月曜日
02:火曜日
03:水曜日
04:木曜日
05:金曜日
06:土曜日
07:日曜日
11:祝日
区分別最大料金情報 max_price_divisions ParkingMaxPriceDivisionオブジェクト
区分別料金情報 price_divisions ParkingPriceDivisionオブジェクト

ParkingMaxPriceDivisionオブジェクト

名称 レスポンス名 型名 配列 説明
料金適用開始時間 from_time 文字列
料金適用終了時間 to_time 文字列
最大料金 max_price 文字列
日中フラグ in_daytime 真偽値 日中時間帯を含む場合はtrue

ParkingPriceDivisionオブジェクト

名称 レスポンス名 型名 配列 説明
料金適用開始時間 from_time 文字列
料金適用終了時間 to_time 文字列
料金計算の単位時間 unit_time 文字列
単位時間あたりの料金 unit_price 文字列
駐車場の満空情報 parking_status ParkingStatusオブジェクト 駐車場の満空情報を持つスポットの場合のみ出力

SpotExactCoordオブジェクト

名称 レスポンス名 型名 配列 説明
車向け到着地点緯度経度 car SpotExactCoordPointオブジェクト
徒歩向け到着地点緯度経度 walk SpotExactCoordPointオブジェクト

SpotExactCoordPointオブジェクト

名称 レスポンス名 型名 配列 説明
地点名称 name 文字列
緯度経度 coord Coordinateオブジェクト
識別番号 seq 数値 ・地点名称が同一の場合があり、その識別用

識別番号について

識別番号は、1つの到着地点緯度経度に対し任意の番号を割り当てております。
同じ緯度経度でこの番号が変わることはございません。また、同じスポット内で番号が重複することもございません。
今後、到着地点緯度経度の地点名称の変更や、到着地点緯度経度が追加・削除となる場合もございますので、差分確認などにご利用ください。

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度の測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列
距離の単位 distance 文字列

レスポンス例

{
    "count": {
        "total": 8,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "code": "01150-274944",
            "name": "ローソン メトロス表参道店",
            "ruby": "ろーそん めとろすおもてさんどうてん",
            "phone": "0338162604",
            "address_name": "東京都港区北青山3-6-12",
            "address_code": "13103008000",
            "coord": {
                "lat": 35.665148,
                "lon": 139.712513
            },
            "distance": 19,
            "postal_code": "1070061",
            "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",
        "distance": "metre"
    }
}