スポットコード検索

/spot/code [GET]

基本情報

概要

スポットコードを指定してスポット情報を取得します。 スポットとは下記のような施設全般を指します。

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

URL

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

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

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
code スポットコード 文字列 スポット情報が一意に紐付くコード
・ピリオド区切りで複数指定可能
opening_time 営業時間 文字列(日付時刻)
YYYY-MM-DDThh:mm:ss
現在時刻 「対象スポットが指定した日時に営業しているかどうか」がレスポンスに付与されます
「options=opening_hours」指定時かつ営業時間に関するデータが存在する場合のみ出力します
opening_time未指定時は現在時刻を指定します
options 追加出力情報 文字列 exact_coord:スポット到着地点
detail:詳細情報
opening_hours:営業時間情報
追加で出力する情報
・ピリオド区切りで複数指定可能
※exact_coordはD2Dオプション申込時のみ利用可能
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

パラメータ構成例

  • スポットコード「02301-1300571n」のスポット情報を取得
/spot/code?code=02301-1300571n

レスポンス

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

Spotオブジェクト

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

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

SpotOpeningHoursオブジェクト

名称 レスポンス名 型名 配列 説明
指定した時間の営業フラグ open 真偽値 true:opening_timeで指定した時刻が営業時間内の場合
false: opening_timeで指定した時刻が営業時間外の場合
24時間営業であることを示すフラグ open24h 真偽値 24時間営業であればtrue
営業時間情報一覧 schedule SpotOpeningHoursScheduleオブジェクト

SpotOpeningHoursScheduleオブジェクト

名称 レスポンス名 型名 配列 説明
曜日ID day_id 文字列 01:月曜日
02:火曜日
03:水曜日
04:木曜日
05:金曜日
06:土曜日
07:日曜日
11:祝日
休業日フラグ close 真偽値 休業日であればtrue
休業日が不明の場合は表示されません
指定した日時に該当する曜日を示すフラグ applied 真偽値 opening_timeパラメータで指定した日時に該当する曜日のオブジェクトだった場合にtrueが出力されます
該当する曜日以外の場合は表示されません
営業時間 periods SpotOpeningHoursPeriodオブジェクト

SpotOpeningHoursPeriodオブジェクト

名称 レスポンス名 型名 配列 説明
営業開始時間 open_time 文字列
営業終了時間 close_time 文字列

Unitオブジェクト

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

レスポンス例

{
    "items": [
        {
            "code": "02301-1300571n",
            "name": "東京ドーム",
            "ruby": "とうきょうどーむ",
            "phone": "0358009999",
            "address_name": "東京都文京区後楽1-3-61",
            "address_code": "13105005000",
            "coord": {
                "lat": 35.705613,
                "lon": 139.751925
            },
            "postal_code": "1120004",
            "categories": [
                {
                    "code": "0102015001",
                    "name": "スタジアム/球場",
                    "ruby": "すたじあむきゅうじょう",
                    "level": "detail"
                },
                {
                    "code": "0102015",
                    "name": "スタジアム/球場",
                    "ruby": "すたじあむきゅうじょう",
                    "level": "small"
                },
                {
                    "code": "0102",
                    "name": "スポーツ",
                    "ruby": "すぽーつ",
                    "level": "middle"
                },
                {
                    "code": "01",
                    "name": "遊ぶ/趣味",
                    "ruby": "あそぶしゅみ",
                    "level": "large"
                }
            ]
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}