Eia Petroleum Exports
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumExports | EiaPetroleumExportsQueryParams | EiaPetroleumExportsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumExportsData,
EiaPetroleumExportsQueryParams,
)
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
- aviation_gasoline_blending_components
- biodiesel
- biofuel_fuels
- conventional_gasoline_blending_components
- conventional_motor_gasoline
- crude_oil
- crude_oil_and_petroleum_products
- 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
- ethane
- ethane_ethylene
- finished_motor_gasoline
- finished_petroleum_products
- fuel_ethanol
- gasoline_blending_components
- hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons
- isobutane
- isobutane_isobutylene
- kerosene
- kerosene_and_light_oils
- kerosene_type_jet_fuel
- liquified_petroleum_gases
- lubricants
- mtbe
- miscellaneous_petroleum_products
- naphtha_for_petrochemical_feedstock_use
- naphthas_and_lighter
- natural_gas_liquids_and_liquid_refinery_gases
- natural_gas_plant_liquids
- natural_gasoline
- normal_butane
- normal_butane_butylene
- other_biofuels
- other_liquids
- other_oils_for_petrochemical_feedstock_use
- other_oxygenates
- oxygenates
- pentanes_plus
- petroleum_coke
- propane
- propane_and_propylene
- reformulated_gasoline_blending_components
- reformulated_motor_gasoline
- renewable_diesel_fuel
- residual_fuel_oil
- special_naphthas
- unfinished_oils
- waxes
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- 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 612 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.