駐車場検索 (/parking/list)

基本情報

駐車場スポットの情報を検索します。
幅や高さ、満空情報などを参照することが可能です。
出力形式 デフォルト出力順
JSON
SpotIDで昇順
緯度経度指定時は、距離の近さで昇順

リクエストパラメータ

パラメータ名 概要 入力値 必須 デフォルト 備考
address 住所コード 文字列
yes
addressもしくはcoordのどちらかは必須です。
  大字レベル(11ケタ末尾0)まで指定可
coord 緯度経度 カンマ区切りの数値(緯度,経度)
yes
addressもしくはcoordのどちらかは必須です。
  緯度経度の形式に関しては 緯度経度の形式について を参照
radius 検索半径 数値   2000
単位はメートル
緯度経度を指定したときのみ有効です。
最大値は100000m(100km)となります。
category カテゴリコード 文字列    
駐車場の各ブランドカテゴリのみ指定可能です。
例:リパーク(0805001003)など
詳細は こちら をご参照ください。
始点と終点の直線距離が150km以下になるようにしてください。
add 追加情報の指定 文字列    
追加で情報を出力します。。
以下の値が指定可能です。
* detail - 詳細情報

レスポンスオブジェクト

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

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

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 が指定されたときのみ出力される。

Provider オブジェクト

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

注釈

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

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

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) 駐車場の情報

ParkingStatus オブジェクト

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

プロパティ名 データ型 説明
code
(OPTIONAL)
String
ステータスコード
0 - 空
1 - 混雑
2 - 満車
3 - 閉鎖
7 - 不明
text
(OPTIONAL)
String 状態を表す文字列
update_time
(OPTIONAL)
String データ更新時刻

注釈

「不明」はセンサーの障害やお祭りなどで利用できない状態を表します。

TextItem オブジェクト

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

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