Eia State Electricity Profiles Costs And Savings From Energy Efficiency Programs
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyPrograms | EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyProgramsQueryParams | EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyProgramsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyProgramsData,
EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyProgramsQueryParams,
)
Parameters
- standard
- eia
data_type: str | None | list[str | None]
Data column(s) to return, comma-separated. The default returns every column. Choices: all_other_costs (thousand dollars); customer_incentive = Cost of Customer Incentives (thousand dollars); energy_savings = Annual Energy Savings (megawatthours); potential_peak_savings = Peak Demand Savings (megawatts). Multiple items allowed.
Choices
- all_other_costs
- customer_incentive
- energy_savings
- potential_peak_savings
sector: str | None | list[str | None]
Sector filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all_sectors
- commercial
- industrial
- residential
- transportation
state: str | None | list[str | None]
State filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- alabama
- alaska
- arizona
- arkansas
- california
- colorado
- connecticut
- delaware
- district_of_columbia
- florida
- georgia
- hawaii
- idaho
- illinois
- indiana
- iowa
- kansas
- kentucky
- louisiana
- maine
- maryland
- massachusetts
- michigan
- minnesota
- mississippi
- missouri
- montana
- nebraska
- nevada
- new_hampshire
- new_jersey
- new_mexico
- new_york
- north_carolina
- north_dakota
- ohio
- oklahoma
- oregon
- pennsylvania
- rhode_island
- south_carolina
- south_dakota
- tennessee
- texas
- united_states
- utah
- vermont
- virginia
- washington
- west_virginia
- wisconsin
- wyoming
time_period: str | None | list[str | None]
Time Period Included in Costs and Savings filter. Multiple items allowed.
Choices
- expected_life_cycle_of_programs
- reporting_year
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 code.
state_name: str | None
State name.
time_period: str | None
Time Period Included in Costs and Savings code.
time_period_name: str | None
Time Period Included in Costs and Savings name.
all_other_costs: float | None
All Other Costs (thousand dollars). Withheld or unavailable values return as null.
customer_incentive: float | None
Cost of Customer Incentives (thousand dollars). Withheld or unavailable values return as null.
energy_savings: float | None
Annual Energy Savings (megawatthours). Withheld or unavailable values return as null.
potential_peak_savings: float | None
Peak Demand Savings (megawatts). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.