Eia Natural Gas Residential And Commercial Prices Selected States
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaNaturalGasResidentialAndCommercialPricesSelectedStates | EiaNaturalGasResidentialAndCommercialPricesSelectedStatesQueryParams | EiaNaturalGasResidentialAndCommercialPricesSelectedStatesData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaNaturalGasResidentialAndCommercialPricesSelectedStatesData,
EiaNaturalGasResidentialAndCommercialPricesSelectedStatesQueryParams,
)
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
- price_delivered_to_commercial_sectors
- price_delivered_to_residential_consumers
region: str | None | list[str | None]
DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- florida
- new_york
- ohio
- usa_dc
- usa_ga
- usa_md
- usa_mi
- usa_nj
- usa_pa
- usa_va
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- district_of_columbia_price_of_natural_gas_delivered_to
- district_of_columbia_price_of_natural_gas_sold_to
- florida_price_of_natural_gas_delivered_to_residential
- florida_price_of_natural_gas_sold_to_commercial_consumers
- georgia_price_of_natural_gas_delivered_to_residential
- georgia_price_of_natural_gas_sold_to_commercial_consumers
- maryland_price_of_natural_gas_delivered_to_residential
- maryland_price_of_natural_gas_sold_to_commercial_consumers
- michigan_price_of_natural_gas_delivered_to_residential
- michigan_price_of_natural_gas_sold_to_commercial_consumers
- new_jersey_price_of_natural_gas_delivered_to_residential
- new_jersey_price_of_natural_gas_sold_to_commercial_consumers
- new_york_price_of_natural_gas_delivered_to_residential
- new_york_price_of_natural_gas_sold_to_commercial_consumers
- ohio_price_of_natural_gas_delivered_to_residential_consumers
- ohio_price_of_natural_gas_sold_to_commercial_consumers
- pennsylvania_price_of_natural_gas_delivered_to_residential
- pennsylvania_price_of_natural_gas_sold_to_commercial
- virginia_price_of_natural_gas_delivered_to_residential
- virginia_price_of_natural_gas_sold_to_commercial_consumers
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.