Eia Petroleum Us Weekly Product Supplied
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumUsWeeklyProductSupplied | EiaPetroleumUsWeeklyProductSuppliedQueryParams | EiaPetroleumUsWeeklyProductSuppliedData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumUsWeeklyProductSuppliedData,
EiaPetroleumUsWeeklyProductSuppliedQueryParams,
)
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
- distillate_fuel_oil
- finished_motor_gasoline
- kerosene_type_jet_fuel
- other_oils
- propane_and_propylene
- residual_fuel_oil
- total_petroleum_products
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- us_product_supplied_of_distillate_fuel_oil
- us_product_supplied_of_finished_motor_gasoline
- us_product_supplied_of_kerosene_type_jet_fuel
- us_product_supplied_of_other_oils
- us_product_supplied_of_petroleum_products
- us_product_supplied_of_propane_and_propylene
- us_product_supplied_of_residual_fuel_oil
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.