total_energy
Monthly Energy Review series covering all energy sources, by MSN mnemonic.
Examples
from openbb import obb
# Monthly total US electricity net generation.
obb.eia.total_energy(provider='eia', msn='ELETPUS')
Parameters
- standard
- eia
frequency: str | None
The data frequency. The default is 'monthly'.
msn: str | None | list[str | None]
Unique series identifier filter. Accepts a comma-separated list of values. There are 984 valid values - use the facet_options endpoint to list them. 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.
Returns
results: EiaTotalEnergy
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- eia
msn: str | None
Unique series identifier code.
msn_name: str | None
Unique series identifier name.
value: float | None
Value. Withheld or unavailable values return as null.
unit: str | None
Unit of the value.
date: date | datetime | str
Start of the period the record covers. Hourly frequencies return a timestamp.