Eia Petroleum Weekly Retail Gasoline And Diesel Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumWeeklyRetailGasolineAndDieselPrices | EiaPetroleumWeeklyRetailGasolineAndDieselPricesQueryParams | EiaPetroleumWeeklyRetailGasolineAndDieselPricesData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumWeeklyRetailGasolineAndDieselPricesData,
EiaPetroleumWeeklyRetailGasolineAndDieselPricesQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'weekly'.
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- conventional_gasoline
- conventional_premium_gasoline
- conventional_regular_gasoline
- gasoline_conventional_midgrade
- gasoline_reformulated_midgrade
- midgrade_gasoline
- no_2_diesel
- no_2_diesel_low_sulfur_0_15_ppm
- no_2_diesel_low_sulfur_15_500_ppm
- premium_gasoline
- reformulated_motor_gasoline
- reformulated_premium_gasoline
- reformulated_regular_gasoline
- regular_gasoline
- total_gasoline
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- boston
- california
- chicago
- cleveland
- colorado
- denver
- florida
- houston
- los_angeles
- massachusetts
- miami
- minnesota
- new_york
- new_york_city
- ohio
- padd_1
- padd_1a
- padd_1b
- padd_1c
- padd_2
- padd_3
- padd_4
- padd_5
- padd_5_except_california
- san_francisco
- seattle
- texas
- us
- washington
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. There are 311 valid values - use the facet_options endpoint to list them. Multiple items allowed.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
sort: str | None
Default: asc
Sort the results by date.
limit: int | None
Maximum number of rows to return. The default returns all rows, paginating requests as needed.
Data
- standard
- eia
process: str | None
Process code.
process_name: str | None
Process name.
product: str | None
Product code.
product_name: str | None
Product name.
region: str | None
DuoArea code.
region_name: str | None
DuoArea name.
series: str | None
Series code.
series_name: str | None
Series name.
value: float | None
Value. Withheld or unavailable values return as null.
units: str | None
Unit of the value.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.