Eia Electricity Electric Power Operations
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaElectricityElectricPowerOperations | EiaElectricityElectricPowerOperationsQueryParams | EiaElectricityElectricPowerOperationsData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaElectricityElectricPowerOperationsData,
EiaElectricityElectricPowerOperationsQueryParams,
)
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: ash_content = Average Ash Content of Consumed Fuel; consumption_for_eg = Consumption of Fuels for Electricity Generation (Physical Units); consumption_for_eg_btu = Consumption of Fuels for Electricity Generation (BTUs); consumption_uto = Consumption of Fuels for Useful Thermal Output (Physical Units); consumption_uto_btu = Consumption of Fuels for Useful Thermal Output (BTUs); cost = Average Cost of Fuels (per Physical Unit); cost_per_btu = Average Cost of Fuels (per BTU); generation = Utility Scale Electricity Net Generation; heat_content = Average Heat Content of Consumed Fuels; receipts = Receipts of Fuel (Physical Units); receipts_btu = Receipts of Fuel (BTUs); stocks = Stocks of Fuel (Physical Units); sulfur_content = Average Sulfur Content of Consumed Fuel; total_consumption = Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units); total_consumption_btu = Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs). Multiple items allowed.
Choices
- ash_content
- consumption_for_eg
- consumption_for_eg_btu
- consumption_uto
- consumption_uto_btu
- cost
- cost_per_btu
- generation
- heat_content
- receipts
- receipts_btu
- stocks
- sulfur_content
- total_consumption
- total_consumption_btu
fuel: str | None | list[str | None]
Energy Source filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all_coal_products
- all_fuels
- all_renewables
- anthracite_coal
- biogenic_municipal_solid_waste
- biomass
- bituminous_coal
- bituminous_coal_and_synthetic_coal
- coal_excluding_waste_coal
- conventional_hydroelectric
- distillate_fuel_oil
- estimated_small_scale_solar_photovoltaic
- estimated_total_solar
- estimated_total_solar_photovoltaic
- fossil_fuels
- geothermal
- hydro_electric_pumped_storage
- landfill_gas
- lignite_coal
- municiapl_landfill_gas
- natural_gas
- natural_gas_and_other_gases
- nuclear
- offshore_wind_turbine
- onshore_wind_turbine
- other
- other_gases
- other_renewables
- petroleum
- petroleum_coke
- petroleum_liquids
- refined_coal
- renewable
- renewable_waste_products
- residual_fuel_oil
- solar
- solar_photovoltaic
- solar_thermal
- subbituminous_coal
- waste_coal
- waste_oil_and_other_oils
- wind
- wood_and_wood_wastes
sector: str | None | list[str | None]
Sector filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- all_commercial
- all_industrial
- all_sectors
- coal_consumption
- commercial_chp
- commercial_non_chp
- electric_power
- electric_power_sector_non_chp
- electric_utility
- ipp_chp
- ipp_non_chp
- independent_power_producers
- industrial_chp
- industrial_non_chp
- residential
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
- pacific_contiguous
- pacific_noncontiguous
- pennsylvania
- puerto_rico
- 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
fuel: str | None
Energy Source code.
fuel_name: str | None
Energy Source name.
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.
ash_content: float | None
Average Ash Content of Consumed Fuel. Withheld or unavailable values return as null.
consumption_for_eg: float | None
Consumption of Fuels for Electricity Generation (Physical Units). Withheld or unavailable values return as null.
consumption_for_eg_btu: float | None
Consumption of Fuels for Electricity Generation (BTUs). Withheld or unavailable values return as null.
consumption_uto: float | None
Consumption of Fuels for Useful Thermal Output (Physical Units). Withheld or unavailable values return as null.
consumption_uto_btu: float | None
Consumption of Fuels for Useful Thermal Output (BTUs). Withheld or unavailable values return as null.
cost: float | None
Average Cost of Fuels (per Physical Unit). Withheld or unavailable values return as null.
cost_per_btu: float | None
Average Cost of Fuels (per BTU). Withheld or unavailable values return as null.
generation: float | None
Utility Scale Electricity Net Generation. Withheld or unavailable values return as null.
heat_content: float | None
Average Heat Content of Consumed Fuels. Withheld or unavailable values return as null.
receipts: float | None
Receipts of Fuel (Physical Units). Withheld or unavailable values return as null.
receipts_btu: float | None
Receipts of Fuel (BTUs). Withheld or unavailable values return as null.
stocks: float | None
Stocks of Fuel (Physical Units). Withheld or unavailable values return as null.
sulfur_content: float | None
Average Sulfur Content of Consumed Fuel. Withheld or unavailable values return as null.
total_consumption: float | None
Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units). Withheld or unavailable values return as null.
total_consumption_btu: float | None
Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs). Withheld or unavailable values return as null.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.