ガソリンスタンド検索 (/gasstation/list)

基本情報

ガソリンスタンドの情報を取得できます。
ガソリン価格や支払方法等の情報の取得も可能です。
出力形式 デフォルト出力順
JSON
直線距離が短い順

リクエストパラメータ

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

パラメータ名 概要 入力値 必須 デフォルト 説明
address 住所コード 文字列
yes
addressもしくはcoordのどちらかは必須。
 
大字レベルまでの住所コードを指定可能。
詳細は 住所データについて を参照。
coord 緯度経度の指定 カンマ区切りの数値(緯度,経度)
yes
addressもしくはcoordのどちらかは必須。
  緯度経度の形式に関しては 緯度経度の形式について を参照
category カテゴリコード 文字列    
ガソリンスタンドの各会社カテゴリのみ指定可能。
詳細は カテゴリ を参照。
type ガソリンスタンドの種類 文字列    
以下の値を指定することが可能。
* full - フルサービス
* self - セルフサービス
gas-price-max-age ガソリン価格の更新日時の最長期間
数値
(単位は日数)
   
時刻は切り捨てて計算される。
指定期間内で、通常価格・会員価格のレギュラー・ハイオク・軽油・灯油のいずれかが更新されたデータを取得可能。
gas-price-exclude-no-value ガソリン価格を持たないガソリンスタンドを除くための設定値 boolean     trueの場合、いずれのガソリン価格も持たないスポットは出力されない。
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) 駐車場の情報

TextItem オブジェクト

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

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

FuelPrice オブジェクト

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