Eia Petroleum Refinery Yield
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumRefineryYield | EiaPetroleumRefineryYieldQueryParams | EiaPetroleumRefineryYieldData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumRefineryYieldData,
EiaPetroleumRefineryYieldQueryParams,
)
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
- asphalt_and_road_oil
- aviation_gasoline
- distillate_fuel_oil
- finished_motor_gasoline
- kerosene
- kerosene_type_jet_fuel
- lubricants
- miscellaneous_petroleum_products
- naphtha_for_petrochemical_feedstock_use
- natural_gas_liquids_and_liquid_refinery_gases
- other_oils_for_petrochemical_feedstock_use
- petroleum_coke
- processing_gain
- residual_fuel_oil
- special_naphthas
- still_gas
- waxes
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- na
- padd_1
- padd_2
- padd_3
- padd_4
- padd_5
- us
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. There are 262 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.