Eia Petroleum Weekly Imports Exports
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumWeeklyImportsExports | EiaPetroleumWeeklyImportsExportsQueryParams | EiaPetroleumWeeklyImportsExportsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumWeeklyImportsExportsData,
EiaPetroleumWeeklyImportsExportsQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'weekly'.
process: str | None | list[str | None]
Process filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- exports
- imports
- imports_excluding_spr
- imports_by_others_for_spr
- imports_by_spr
- net_imports
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- conventional_cbob_gasoline_blending_components
- conventional_gtab_gasoline_blending_components
- conventional_motor_gasoline
- conventional_motor_gasoline_with_alcohol
- conventional_other_gasoline_blending_components
- crude_oil
- crude_oil_and_petroleum_products
- distillate_fuel_oil
- distillate_fuel_oil_0_to_15_ppm_sulfur
- distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur
- distillate_fuel_oil_greater_than_2000_ppm_sulfur
- distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur
- finished_motor_gasoline
- finished_motor_gasoline_conventional_55
- finished_motor_gasoline_reformulated_other
- fuel_ethanol
- gasoline_blending_components
- kerosene
- kerosene_type_jet_fuel
- motor_gasoline_blending_components_reformulated_rbob
- motor_gasoline_finished_conventional_ed55_and_lower
- ngpls_lrgs
- other_conventional_motor_gasoline
- other_oils
- other_oils_excluding_fuel_ethanol
- propane_and_propylene
- reformulated_motor_gasoline
- reformulated_motor_gasoline_with_alcohol
- reformulated_rbob_with_alcohol_gasoline_blending_components
- reformulated_rbob_with_ether_gasoline_blending_components
- residual_fuel_oil
- total_gasoline
- total_petroleum_products
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 197 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.