Eia Petroleum Spot Prices
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumSpotPrices | EiaPetroleumSpotPricesQueryParams | EiaPetroleumSpotPricesData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumSpotPricesData,
EiaPetroleumSpotPricesQueryParams,
)
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
- carb_diesel
- conventional_regular_gasoline
- kerosene_type_jet_fuel
- no_2_diesel_low_sulfur
- no_2_fuel_oil_heating_oil
- propane
- reformulated_regular_gasoline
- uk_brent_crude_oil
- wti_crude_oil
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- los_angeles
- na
- new_york_city
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- cushing_ok_wti_spot_price_fob
- europe_brent_spot_price_fob
- los_angeles_reformulated_rbob_regular_gasoline_spot_price
- los_angeles_ca_ultra_low_sulfur_carb_diesel_spot_price
- mont_belvieu_tx_propane_spot_price_fob
- new_york_harbor_conventional_gasoline_regular_spot_price_fob
- new_york_harbor_no_2_heating_oil_spot_price_fob
- new_york_harbor_ultra_low_sulfur_no_2_diesel_spot_price
- us_gulf_coast_conventional_gasoline_regular_spot_price_fob
- us_gulf_coast_kerosene_type_jet_fuel_spot_price_fob
- us_gulf_coast_ultra_low_sulfur_no_2_diesel_spot_price
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.