Short Term Energy Outlook
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ShortTermEnergyOutlook | ShortTermEnergyOutlookQueryParams | ShortTermEnergyOutlookData |
Import Statement
from openbb_core.provider.standard_models.short_term_energy_outlook import (
ShortTermEnergyOutlookData,
ShortTermEnergyOutlookQueryParams,
)
Parameters
- standard
- eia
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| symbol | Union[str, List[str]] | Symbol to get data for. If provided, overrides the 'table' parameter to return only the specified symbol from the STEO API. Multiple items allowed for provider(s): eia. | None | True |
| table | Literal['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'] | 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 | 01 | True |
| frequency | Literal['month', 'quarter', 'annual'] | The frequency of the data. Default is 'month'. | month | True |
Data
- standard
- eia
| Name | Type | Description |
|---|---|---|
| date | Union[date, str] | The date of the data. |
| table | str | Table name for the data. |
| symbol | str | Symbol representing the entity requested in the data. |
| order | int | Presented order of the data, relative to the table. |
| title | str | Title of the data. |
| value | Union[int, float] | Value of the data. |
| unit | str | Unit or scale of the data. |
| Name | Type | Description |
|---|---|---|
| date | Union[date, str] | The date of the data. |
| table | str | Table name for the data. |
| symbol | str | Symbol representing the entity requested in the data. |
| order | int | Presented order of the data, relative to the table. |
| title | str | Title of the data. |
| value | Union[int, float] | Value of the data. |
| unit | str | Unit or scale of the data. |