Eia Ieo
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EiaIeo | EiaIeoQueryParams | EiaIeoData |
Import Statement
from openbb_core.provider.standard_models. import (
EiaIeoData,
EiaIeoQueryParams,
)
Parameters
- standard
- eia
release: str | None
Default: 2023
The International Energy Outlook release. Facet values vary by release; use the facet_options endpoint to list them.
history: str | None | list[str | None]
History filter. Multiple items allowed.
Choices
- historic
- projection
region: str | None | list[str | None]
Region filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- africa
- africa_and_middle_east
- americas
- asia_pacific
- australia_and_new_zealand
- australia_new_zealand
- brazil
- canada
- china
- eastern_europe_and_eurasia
- europe_and_eurasia
- india
- japan
- mexico
- mexico_and_other_oecd_americas
- middle_east
- no_regional_tables
- oecd_europe
- other_americas
- other_asia_pacific
- other_non_oecd_americas
- other_non_oecd_asia
- other_non_oecd_europe_and_eurasia
- russia
- south_korea
- total_non_oecd
- total_oecd
- total_world
- united_states
- western_europe
scenario: str | None | list[str | None]
Scenario filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- high_economic_growth
- high_oil_price
- high_zero_carbon_technology_cost
- low_economic_growth
- low_oil_price
- low_zero_carbon_technology_cost
- reference
series: str | None | list[str | None]
Series filter. Accepts a comma-separated list of values. Use the facet_options endpoint for the valid values. Multiple items allowed.
table: str | None | list[str | None]
Table filter. Accepts a comma-separated list of values. Multiple items allowed.
Choices
- aircraft_efficiency
- buildings_delivered_energy_consumption_by_end_use_sector
- delivered_energy_consumption_by_end_use_sector_and_fuel
- freight_air_transport
- industrial_energy_consumption_by_sector_for_selected_regions
- international_other_liquid_fuels_a_production_by_region_and
- light_duty_vehicle_stocks_by_technology
- new_light_duty_vehicle_sales_by_technology
- passenger_air_travel
- passenger_aircraft_capacity
- revenue_freight_air_transport
- revenue_passenger_air_travel
- total_commercial_jet_fuel_use_by_region
- transportation_sector_energy_consumption_by_region_and_fuel
- transportation_sector_freight_transport_energy_consumption
- transportation_sector_passenger_transport_energy
- world_carbon_dioxide_emissions_by_region
- world_carbon_dioxide_emissions_from_coal_use_by_region
- world_carbon_dioxide_emissions_from_liquids_use_by_region
- world_carbon_dioxide_emissions_from_natural_gas_use_by
- world_carbon_dioxide_intensity_of_energy_use_by_region
- world_coal_consumption_by_region
- world_coal_exports_by_region
- world_coal_imports_by_region
- world_coal_supply_by_region
- world_consumption_of_hydroelectricity_and_other_renewable
- world_crude_oil_a_production_by_region_and_country
- world_energy_intensity_by_region
- world_gross_domestic_product_by_region_expressed_in_market
- world_gross_domestic_product_by_region_expressed_in
- world_gross_domestic_product_per_capita_by_region_expressed
- world_installed_coal_fired_generating_capacity_by_region
- world_installed_geothermal_generating_capacity_by_region
- world_installed_hydroelectric_and_other_renewable
- world_installed_hydroelectric_generating_capacity_by_region
- world_installed_liquids_fired_generating_capacity_by_region
- world_installed_natural_gas_fired_generating_capacity_by
- world_installed_nuclear_generating_capacity_by_region_and
- world_installed_other_renewable_generating_capacity_by
- world_installed_solar_generating_capacity_by_region_and
- world_installed_wind_powered_generating_capacity_by_region
- world_liquids_consumption_by_region
- world_metallurgical_coal_consumptiom_by_region
- world_metallurgical_coal_consumption_by_region
- world_metallurgical_coal_exports_by_region
- world_metallurgical_coal_imports_by_region
- world_metallurgical_coal_net_trade_by_region
- world_metallurgical_coal_supply_by_region
- world_natural_gas_consumption_by_region
- world_net_coal_fired_electricity_generation_by_region_and
- world_net_geothermal_electricity_generation_by_region_and
- world_net_hydroelectric_and_other_renewable_electricity
- world_net_hydroelectric_electricity_generation_by_region
- world_net_liquids_fired_electricity_generation_by_region
- world_net_natural_gas_fired_electricity_generation_by
- world_net_nuclear_electricity_generation_by_region_and
- world_net_other_renewable_electricity_generation_by_region
- world_net_solar_electricity_generation_by_region_and_country
- world_net_trade_in_natural_gas_by_region
- world_net_wind_powered_electricity_generation_by_region_and
- world_nuclear_energy_consumption_by_region
- world_other_natural_gas_production_by_region
- world_petroleum_and_other_liquids_production_by_region_and
- world_population_by_region
- world_thermal_coal_consumptiom_by_region
- world_thermal_coal_exports_by_region
- world_thermal_coal_imports_by_region
- world_thermal_coal_net_trade_by_region
- world_thermal_coal_supply_by_region
- world_tight_gas_shale_gas_and_coalbed_methane_production_by
- world_total_coal_consumptiom_by_region
- world_total_coal_exports_by_region
- world_total_coal_imports_by_region
- world_total_coal_net_trade_by_region
- world_total_coal_supply_by_region
- world_total_energy_consumption_by_region_and_fuel
- world_total_installed_generating_capacity_by_region_and
- world_total_natural_gas_production_by_region
- world_total_net_electricity_generation_by_region_and_country
- world_total_primary_energy_consumption_by_region
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
history: str | None
History code.
history_name: str | None
History name.
region: str | None
Region code.
region_name: str | None
Region name.
scenario: str | None
Scenario code.
scenario_name: str | None
Scenario name.
series: str | None
Series code.
series_name: str | None
Series name.
table: str | None
Table code.
table_name: str | None
Table 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.