Eia Petroleum Stocks Of Selected Products
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumStocksOfSelectedProducts | EiaPetroleumStocksOfSelectedProductsQueryParams | EiaPetroleumStocksOfSelectedProductsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumStocksOfSelectedProductsData,
EiaPetroleumStocksOfSelectedProductsQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- distillate_fuel_oil
- distillate_fuel_oil_0_to_15_ppm_sulfur
- distillate_fuel_oil_greater_than_500_ppm_sulfur
- distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur
- propane_and_propylene
- residual_fuel_oil
- total_gasoline
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- padd_1
- padd_1a
- padd_1b
- padd_1c
- padd_2
- padd_3
- padd_4
- padd_5
- us
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_thousand_barrels
- central_atlantic_ending_stocks_of_distillate_fuel_oil_0_to
- central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- central_atlantic_ending_stocks_of_propane_and_propylene
- central_atlantic_ending_stocks_of_residual_fuel_oil
- central_atlantic_ending_stocks_of_total_gasoline
- east_coast_ending_stocks_of_distillate_fuel_oil
- east_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm
- east_coast_padd_1_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- east_coast_padd_1_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- east_coast_ending_stocks_of_propane_and_propylene
- east_coast_ending_stocks_of_residual_fuel_oil
- east_coast_ending_stocks_of_total_gasoline
- gulf_coast_ending_stocks_of_distillate_fuel_oil
- gulf_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm
- gulf_coast_padd_3_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- gulf_coast_padd_3_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- gulf_coast_ending_stocks_of_propane_and_propylene
- gulf_coast_ending_stocks_of_residual_fuel_oil
- gulf_coast_ending_stocks_of_total_gasoline
- lower_atlantic_ending_stocks_of_distillate_fuel_oil
- lower_atlantic_ending_stocks_of_distillate_fuel_oil_0_to_15
- lower_atlantic_padd_1c_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- lower_atlantic_padd_1c_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- lower_atlantic_ending_stocks_of_propane_and_propylene
- lower_atlantic_ending_stocks_of_residual_fuel_oil
- lower_atlantic_ending_stocks_of_total_gasoline
- midwest_ending_stocks_of_distillate_fuel_oil
- midwest_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm
- midwest_padd_2_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- midwest_padd_2_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- midwest_ending_stocks_of_propane_and_propylene
- midwest_ending_stocks_of_residual_fuel_oil
- midwest_ending_stocks_of_total_gasoline
- new_england_ending_stocks_of_distillate_fuel_oil_0_to_15
- new_england_padd_1a_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- new_england_ending_stocks_of_distillate_fuel_oil
- new_england_padd_1a_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- new_england_ending_stocks_of_propane_and_propylene
- new_england_ending_stocks_of_residual_fuel_oil
- new_england_ending_stocks_of_total_gasoline
- rocky_mountain_ending_stocks_of_distillate_fuel_oil
- rocky_mountain_ending_stocks_of_distillate_fuel_oil_0_to_15
- rocky_mountain_padd_4_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- rocky_mountain_padd_4_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- rocky_mountain_ending_stocks_of_propane_and_propylene
- rocky_mountain_ending_stocks_of_residual_fuel_oil
- rocky_mountain_ending_stocks_of_total_gasoline
- us_ending_stocks_of_distillate_fuel_oil
- us_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm_sulfur
- us_ending_stocks_of_distillate_fuel_oil_greater_than_500
- us_ending_stocks_of_distillate_fuel_oil_greater_than_15_to
- us_ending_stocks_of_propane_and_propylene
- us_ending_stocks_of_residual_fuel_oil
- us_ending_stocks_of_total_gasoline
- west_coast_ending_stocks_of_distillate_fuel_oil
- west_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm
- west_coast_padd_5_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels
- west_coast_padd_5_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels
- west_coast_ending_stocks_of_propane_and_propylene
- west_coast_ending_stocks_of_residual_fuel_oil
- west_coast_ending_stocks_of_total_gasoline
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.