Eia Electricity Electricity Sales To Ultimate Customers
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaElectricityElectricitySalesToUltimateCustomers | EiaElectricityElectricitySalesToUltimateCustomersQueryParams | EiaElectricityElectricitySalesToUltimateCustomersData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaElectricityElectricitySalesToUltimateCustomersData,
EiaElectricityElectricitySalesToUltimateCustomersQueryParams,
)
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
data_type: str | None | list[str | None]
Data column(s) to return, comma-separated. The default returns every column. Choices: customers = Number of Ultimate Customers (number of customers); price = Average Price of Electricity to Ultimate Customers (cents per kilowatt-hour); revenue = Revenue from Sales to Ultimate Customers (million dollars); sales = Megawatt-hours Sold to Ultimate Customers (million kilowatt hours). Multiple items allowed.
Choices
- customers
- price
- revenue
- sales
sector: str | None | list[str | None]
Sector filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all_sectors
- commercial
- industrial
- other
- residential
- transportation
state: str | None | list[str | None]
State / Census Region filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alabama
- alaska
- arizona
- arkansas
- california
- colorado
- connecticut
- delaware
- district_of_columbia
- east_north_central
- east_south_central
- florida
- georgia
- hawaii
- idaho
- illinois
- indiana
- iowa
- kansas
- kentucky
- louisiana
- maine
- maryland
- massachusetts
- michigan
- middle_atlantic
- minnesota
- mississippi
- missouri
- montana
- mountain
- nebraska
- nevada
- new_england
- new_hampshire
- new_jersey
- new_mexico
- new_york
- north_carolina
- north_dakota
- ohio
- oklahoma
- oregon
- pacific_contiguous
- pacific_noncontiguous
- pennsylvania
- rhode_island
- south_atlantic
- south_carolina
- south_dakota
- tennessee
- texas
- us_total
- utah
- vermont
- virginia
- washington
- west_north_central
- west_south_central
- west_virginia
- wisconsin
- wyoming
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
sector: str | None
Sector code.
sector_name: str | None
Sector name.
state: str | None
State / Census Region code.
state_name: str | None
State / Census Region name.
customers: float | None
Number of Ultimate Customers (number of customers). Withheld or unavailable values return as null.
price: float | None
Average Price of Electricity to Ultimate Customers (cents per kilowatt-hour). Withheld or unavailable values return as null.
revenue: float | None
Revenue from Sales to Ultimate Customers (million dollars). Withheld or unavailable values return as null.
sales: float | None
Megawatt-hours Sold to Ultimate Customers (million kilowatt hours). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.