ガソリン平均価格検索

/gas_price [GET]

基本情報

概要

住所コードと集計期間を指定してガソリン平均価格を取得します。
※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります

URL

https://{HOST}/{CID}/v1/gas_price

※APIマーケットでは提供しておりません

出力形式

JSON

対応言語

ja

ガソリン価格データについて

ガソリンデータは過去１ヶ月分(31日前 ~ 1日前)が保持されています。
データの存在しない期間を指定するとエラーを返します。
全種類の価格が常に取得できる訳ではありません。

パラメータ

パラメータ名	必須	概要	型名	上下限/選択値	備考
code	✔	住所コード	文字列		ピリオド区切りで複数指定可能です住所コードは2桁(都道府県レベル)または5桁(市区町村レベル)でのみ指定可能です全国を指定したい場合は"all"と入力してください
start_date	(✔)	集計開始日	文字列(日付) YYYY-MM-DD	31日前から1日前までの日付
end_date	(✔)	集計終了日	文字列(日付) YYYY-MM-DD	31日前から1日前までの日付

集計期間について

集計期間の指定が必須となります。以下の指定方法のうち、いずれかで指定してください。
① start_dateのみ指定
② end_dateのみ指定
③ start_dateとend_dateの両方を指定
※ start_dateとend_dateの時系列が逆の場合、エラーを出力します。
以下に現在の日付を12月10日とした時の例を示します。

パラメータ構成例

住所：東京、集計開始日：2020年12月1日の平均ガソリン価格を検索

/gas_price?code=13&start_date=2020-12-01

住所：東京と神奈川、集計終了日：2020年12月1日の平均ガソリン価格を検索

/gas_price?code=13.14&end_date=2020-12-01

集計開始日：2020年12月1日、集計終了日：12月7日の全国の平均ガソリン価格を検索

/gas_price?code=all&start_date=2020-12-01&end_date=2020-12-07

レスポンス

名称	レスポンス名	型名	配列	説明
集計開始日時	start_date	文字列(日付時刻)		start_date指定時のみ出力
集計終了日時	end_date	文字列(日付時刻)		end_date指定時のみ出力
ガソリン料金情報	items	GasPriceオブジェクト	◯	ガソリン情報のまとまり

GasPriceオブジェクト

名称	レスポンス名	型名	説明
住所コード	address_code	文字列	全国指定時は出力されません
住所名	address_name	文字列	全国指定時は「全国」と出力
レギュラー価格	regular	文字列
ハイオク価格	highoctane	文字列
軽油価格	diesel	文字列
灯油価格	kerosene	文字列
会員レギュラー価格	member_regular	文字列
会員ハイオク価格	member_highoctane	文字列
会員軽油価格	member_diesel	文字列
会員灯油価格	member_kerosene	文字列

会員価格について

レスポンスで出力される会員価格は、検索対象住所にあるガソリンスタンドの会員価格の平均です。

レスポンス例

{
    "start_date": "2020-12-01T00:00:00+09:00",
    "items": [
        {
            "address_code": "13",
            "address_name": "東京都",
            "regular": "129.2",
            "diesel": "107",
            "kerosene": "1422.5",
            "member_regular": "124.9",
            "member_highoctane": "135.8",
            "member_diesel": "104.9",
            "member_kerosene": "1386.5"
        }
    ]
}