Eia Petroleum Prices Sales Volumes Stocks By State
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaPetroleumPricesSalesVolumesStocksByState | EiaPetroleumPricesSalesVolumesStocksByStateQueryParams | EiaPetroleumPricesSalesVolumesStocksByStateData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaPetroleumPricesSalesVolumesStocksByStateData,
EiaPetroleumPricesSalesVolumesStocksByStateQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
process: str | None | list[str | None]
Process filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all_sales_deliveries
- residential_price_by_all_sellers
- retail_sales_by_all_sellers
- retail_sales_by_refiners_and_gas_plants
- stocks_at_refineries_bulk_terminals_and_natural_gas_plants
- through_company_outlets_price
product: str | None | list[str | None]
Product filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- aviation_gasoline
- conventional_motor_gasoline
- 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
- finished_motor_gasoline
- gasoline_blending_components
- kerosene
- kerosene_type_jet_fuel
- midgrade_gasoline
- no_1_distillate
- no_2_diesel
- no_2_distillate
- no_2_fuel_oil_heating_oil
- no_4_distillate
- premium_gasoline
- propane
- reformulated_motor_gasoline
- regular_gasoline
- residual_fuel_oil
- total_gasoline
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- california
- colorado
- florida
- massachusetts
- minnesota
- new_york
- ohio
- padd_1
- padd_1a
- padd_1b
- padd_1c
- padd_2
- padd_3
- padd_4
- padd_5
- texas
- us
- usa_ak
- usa_al
- usa_ar
- usa_az
- usa_ct
- usa_dc
- usa_de
- usa_ga
- usa_hi
- usa_ia
- usa_id
- usa_il
- usa_in
- usa_ks
- usa_ky
- usa_la
- usa_md
- usa_me
- usa_mi
- usa_mo
- usa_ms
- usa_mt
- usa_nc
- usa_nd
- usa_ne
- usa_nh
- usa_nj
- usa_nm
- usa_nv
- usa_ok
- usa_or
- usa_pa
- usa_ri
- usa_sc
- usa_sd
- usa_tn
- usa_ut
- usa_va
- usa_vt
- usa_wi
- usa_wv
- usa_wy
- washington
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Use the facet_options endpoint for the valid values. 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.