short_term_energy_outlook
Monthly short term (18 month) projections using EIA's STEO model.
Examples
from openbb import obb
obb.eia.short_term_energy_outlook(provider='eia')
# Get the US Energy Markets Summary table.
obb.eia.short_term_energy_outlook(provider='eia', table='01')
Parameters
- standard
- eia
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.
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.
symbol: str | None | list[str | None]
Symbol to get data for. If provided, overrides the 'table' parameter to return only the specified symbol from the STEO API. Multiple items allowed.
table: str | None
Default: 01
Description
The specific table within the STEO dataset. Default is '01'. When 'symbol' is provided, this parameter is ignored.
01: US Energy Markets Summary
02: Nominal Energy Prices
03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories
03b: Non-OPEC Petroleum and Other Liquid Fuels Production
03c: World Petroleum and Other Liquid Fuels Production
03d: World Crude Oil Production
03e: World Petroleum and Other Liquid Fuels Consumption
04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories
04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances
04c: US Regional Motor Gasoline Prices and Inventories
04d: US Biofuel Supply, Consumption, and Inventories
05a: US Natural Gas Supply, Consumption, and Inventories
05b: US Regional Natural Gas Prices
06: US Coal Supply, Consumption, and Inventories
07a: US Electricity Industry Overview
07b: US Regional Electricity Retail Sales
07c: US Regional Electricity Prices
07d1: US Regional Electricity Generation, Electric Power Sector
07d2: US Regional Electricity Generation, Electric Power Sector, continued
07e: US Electricity Generating Capacity
08: US Renewable Energy Consumption
09a: US Macroeconomic Indicators and CO2 Emissions
09b: US Regional Macroeconomic Data
09c: US Regional Weather Data
10a: Drilling Productivity Metrics
10b: Crude Oil and Natural Gas Production from Shale and Tight Formations
Choices
- 01
- 02
- 03a
- 03b
- 03c
- 03d
- 03e
- 04a
- 04b
- 04c
- 04d
- 05a
- 05b
- 06
- 07a
- 07b
- 07c
- 07d1
- 07d2
- 07e
- 08
- 09a
- 09b
- 09c
- 10a
- 10b
frequency: str | None
Default: month
The frequency of the data. Default is 'month'.
Choices
- month
- quarter
- annual
Returns
results: ShortTermEnergyOutlook
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
date: date | str
The date of the data.
table: str | None
Table name for the data.
symbol: str
Symbol representing the entity requested in the data.
order: int | None
Presented order of the data, relative to the table.
title: str | None
Title of the data.
value: float | int
Value of the data.
unit: str | None
Unit or scale of the data.
date: date | str
The date of the data.
table: str | None
Table name for the data.
symbol: str
Symbol representing the entity requested in the data.
order: int | None
Presented order of the data, relative to the table.
title: str | None
Title of the data.
value: float | int
Value of the data.
unit: str | None
Unit or scale of the data.