Skip to content

[V5] openbb-eia: Refactor for V5 + Add Full API Implementation#7584

Open
deeleeramone wants to merge 14 commits into
v5from
feature/v5-eia
Open

[V5] openbb-eia: Refactor for V5 + Add Full API Implementation#7584
deeleeramone wants to merge 14 commits into
v5from
feature/v5-eia

Conversation

@deeleeramone

@deeleeramone deeleeramone commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

This PR refactors the openbb-eia provider extension for the V5 format. The module now covers the full EIA V2 API surface, as well as including proxy-served iFrames of the data explorer apps available via eia.gov.

The Workspace app includes only the data explorers, so no API key is required to use them.

Screen.Recording.2026-07-14.at.7.52.38.PM.mov

Coverage includes over 200 endpoints (API key required for most):

  • obb.eia.coal.aggregate_production
  • obb.eia.coal.by_mine_by_plant
  • obb.eia.coal.consumption_and_quality
  • obb.eia.coal.exports_imports_quantity_price
  • obb.eia.coal.market_sales_price
  • obb.eia.coal.mine_aggregates
  • obb.eia.coal.mine_production
  • obb.eia.coal.mine_state_aggregates
  • obb.eia.coal.plant_aggregates
  • obb.eia.coal.plant_state_aggregates
  • obb.eia.coal.price_by_rank
  • obb.eia.coal.receipts
  • obb.eia.coal.reserves_capacity
  • obb.eia.petroleum.consumption_sales.adjusted_distillate_fuel_oil_and_kerosene_sales_by_end_use
  • obb.eia.petroleum.consumption_sales.adjusted_sales_of_distillate_fuel_oil_by_end_use
  • obb.eia.petroleum.consumption_sales.adjusted_sales_of_kerosene_by_end_use
  • obb.eia.petroleum.consumption_sales.adjusted_sales_of_residual_fuel_oil_by_end_use
  • obb.eia.petroleum.consumption_sales.distillate_fuel_oil_and_kerosene_sales_by_end_use
  • obb.eia.petroleum.consumption_sales.prime_supplier_sales_volumes
  • obb.eia.petroleum.consumption_sales.product_supplied
  • obb.eia.petroleum.consumption_sales.refiner_motor_gasoline_sales_volumes
  • obb.eia.petroleum.consumption_sales.refiner_residual_fuel_oil_and_no4_fuel_sales_volumes
  • obb.eia.petroleum.consumption_sales.refiner_sales_volumes_of_other_petroleum_products
  • obb.eia.petroleum.consumption_sales.sales_of_distillate_fuel_oil_by_end_use
  • obb.eia.petroleum.consumption_sales.sales_of_kerosene_by_end_use
  • obb.eia.petroleum.consumption_sales.sales_of_residual_fuel_oil_by_end_use
  • obb.eia.petroleum.consumption_sales.us_weekly_product_supplied
  • obb.eia.petroleum.crude_reserves_and_production.average_depth_of_crude_oil_and_natural_gas_wells
  • obb.eia.petroleum.crude_reserves_and_production.costs_of_crude_oil_and_natural_gas_wells_drilled
  • obb.eia.petroleum.crude_reserves_and_production.crude_oil_and_lease_condensate_production_by_api_gravity
  • obb.eia.petroleum.crude_reserves_and_production.crude_oil_and_natural_gas_drilling_activity
  • obb.eia.petroleum.crude_reserves_and_production.crude_oil_and_natural_gas_exploratory_and_development_wells
  • obb.eia.petroleum.crude_reserves_and_production.crude_oil_production
  • obb.eia.petroleum.crude_reserves_and_production.crude_oil_proved_reserves_reserves_changes_and_production
  • obb.eia.petroleum.crude_reserves_and_production.crude_plus_lease_condensate_proved_reserves
  • obb.eia.petroleum.crude_reserves_and_production.footage_drilled_for_crude_oil_and_natural_gas_wells
  • obb.eia.petroleum.crude_reserves_and_production.gulf_of_america_federal_offshore_production
  • obb.eia.petroleum.crude_reserves_and_production.maximum_us_active_seismic_crew_counts
  • obb.eia.petroleum.crude_reserves_and_production.proved_nonproducing_reserves
  • obb.eia.petroleum.imports_exports_and_movements.exports
  • obb.eia.petroleum.imports_exports_and_movements.exports_by_destination
  • obb.eia.petroleum.imports_exports_and_movements.imports_by_area_of_entry
  • obb.eia.petroleum.imports_exports_and_movements.imports_by_processing_area
  • obb.eia.petroleum.imports_exports_and_movements.imports_of_residual_fuel
  • obb.eia.petroleum.imports_exports_and_movements.movements_between_pad_districts
  • obb.eia.petroleum.imports_exports_and_movements.movements_by_pipeline_between_pad_districts
  • obb.eia.petroleum.imports_exports_and_movements.movements_by_rail_between_pad_districts
  • obb.eia.petroleum.imports_exports_and_movements.movements_by_tanker_and_barge_between_pad_districts
  • obb.eia.petroleum.imports_exports_and_movements.movements_of_crude_oil_and_selected_products_by_rail
  • obb.eia.petroleum.imports_exports_and_movements.net_receipts_between_pad_districts
  • obb.eia.petroleum.imports_exports_and_movements.pad_district_exports_by_destination
  • obb.eia.petroleum.imports_exports_and_movements.pad_district_imports_by_country_of_origin
  • obb.eia.petroleum.imports_exports_and_movements.us_imports_by_country_of_origin
  • obb.eia.petroleum.imports_exports_and_movements.us_net_imports_by_country
  • obb.eia.petroleum.imports_exports_and_movements.weekly_crude_imports_by_top_10_origins
  • obb.eia.petroleum.imports_exports_and_movements.weekly_imports_exports
  • obb.eia.petroleum.prices.crude_first_purchase_prices_selected_streams
  • obb.eia.petroleum.prices.domestic_crude_oil_first_purchase_prices_by_api_gravity
  • obb.eia.petroleum.prices.domestic_crude_oil_first_purchase_prices_by_area
  • obb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_by_api_gravity
  • obb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_by_area
  • obb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_for_selected_crude_streams
  • obb.eia.petroleum.prices.gasoline_prices_by_formulation_grade_sales_type
  • obb.eia.petroleum.prices.landed_costs_of_imported_crude_by_api_gravity
  • obb.eia.petroleum.prices.landed_costs_of_imported_crude_by_area
  • obb.eia.petroleum.prices.landed_costs_of_imported_crude_for_selected_crude_streams
  • obb.eia.petroleum.prices.no2_distillate_prices_by_sales_type
  • obb.eia.petroleum.prices.nymex_futures_prices
  • obb.eia.petroleum.prices.percentages_of_total_imported_crude_oil_by_api_gravity
  • obb.eia.petroleum.prices.propane_prices_by_sales_type
  • obb.eia.petroleum.prices.refiner_acquisition_cost_of_crude_oil
  • obb.eia.petroleum.prices.refiner_gasoline_prices_by_grade_and_sales_type
  • obb.eia.petroleum.prices.refiner_petroleum_product_prices_by_sales_type
  • obb.eia.petroleum.prices.residual_fuel_oil_prices_by_sales_type
  • obb.eia.petroleum.prices.spot_prices
  • obb.eia.petroleum.prices.us_refiner_gasoline_prices_by_formulation_grade_sales_type
  • obb.eia.petroleum.prices.weekly_heating_oil_and_propane_prices
  • obb.eia.petroleum.prices.weekly_retail_gasoline_and_diesel_prices
  • obb.eia.petroleum.refining_and_processing.biofuels_operable_production_capacity
  • obb.eia.petroleum.refining_and_processing.blender_net_input
  • obb.eia.petroleum.refining_and_processing.blender_net_production
  • obb.eia.petroleum.refining_and_processing.crude_oil_input_qualities
  • obb.eia.petroleum.refining_and_processing.downstream_charge_capacity_of_operable_petroleum_refineries
  • obb.eia.petroleum.refining_and_processing.downstream_processing_of_fresh_feed_input
  • obb.eia.petroleum.refining_and_processing.feedstocks_consumed_for_production_of_biofuels
  • obb.eia.petroleum.refining_and_processing.fuel_consumed_at_biofuels_plants
  • obb.eia.petroleum.refining_and_processing.fuel_consumed_at_refineries
  • obb.eia.petroleum.refining_and_processing.natural_gas_feedstock_for_hydrogen
  • obb.eia.petroleum.refining_and_processing.natural_gas_plant_field_production
  • obb.eia.petroleum.refining_and_processing.number_and_capacity_of_petroleum_refineries
  • obb.eia.petroleum.refining_and_processing.oxygenate_production
  • obb.eia.petroleum.refining_and_processing.production_capacity_of_operable_petroleum_refineries
  • obb.eia.petroleum.refining_and_processing.refinery_blender_net_input
  • obb.eia.petroleum.refining_and_processing.refinery_blender_net_production
  • obb.eia.petroleum.refining_and_processing.refinery_net_input
  • obb.eia.petroleum.refining_and_processing.refinery_net_production
  • obb.eia.petroleum.refining_and_processing.refinery_receipts_of_crude_oil_by_method_of_transportation
  • obb.eia.petroleum.refining_and_processing.refinery_utilization_and_capacity
  • obb.eia.petroleum.refining_and_processing.refinery_yield
  • obb.eia.petroleum.refining_and_processing.shell_storage_capacity_at_operable_refineries
  • obb.eia.petroleum.refining_and_processing.weekly_blender_net_production
  • obb.eia.petroleum.refining_and_processing.weekly_ethanol_plant_production
  • obb.eia.petroleum.refining_and_processing.weekly_inputs_utilization
  • obb.eia.petroleum.refining_and_processing.weekly_refiner_blender_net_production
  • obb.eia.petroleum.refining_and_processing.weekly_refiner_net_production
  • obb.eia.petroleum.refining_and_processing.working_storage_capacity_at_operable_refineries
  • obb.eia.petroleum.stocks.crude_oil_stocks_at_tank_farms_pipelines
  • obb.eia.petroleum.stocks.natural_gas_plant_stocks
  • obb.eia.petroleum.stocks.refinery_bulk_terminal_and_natural_gas_plant_stocks_by_state
  • obb.eia.petroleum.stocks.refinery_stocks
  • obb.eia.petroleum.stocks.stocks_by_type
  • obb.eia.petroleum.stocks.stocks_of_selected_products
  • obb.eia.petroleum.stocks.weekly_stocks
  • obb.eia.petroleum.summary.prices_sales_volumes_stocks_by_state
  • obb.eia.petroleum.summary.supply_and_disposition
  • obb.eia.petroleum.summary.us_biodiesel_production_capacity_sales_and_stocks
  • obb.eia.petroleum.summary.us_crude_oil_supply_disposition
  • obb.eia.petroleum.summary.weekly_supply_estimates
  • obb.eia.natural_gas.consumption_end_use.heat_content_of_natural_gas_consumed
  • obb.eia.natural_gas.consumption_end_use.natural_gas_consumption_by_end_use
  • obb.eia.natural_gas.consumption_end_use.natural_gas_delivered_for_the_account_of_others
  • obb.eia.natural_gas.consumption_end_use.number_of_natural_gas_consumers
  • obb.eia.natural_gas.consumption_end_use.share_of_total_us_natural_gas_delivered_to_consumers
  • obb.eia.natural_gas.exploration_and_reserves.associated_dissolved_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.average_depth_of_crude_oil_and_natural_gas_wells
  • obb.eia.natural_gas.exploration_and_reserves.coalbed_methane
  • obb.eia.natural_gas.exploration_and_reserves.costs_of_crude_oil_and_natural_gas_wells_drilled
  • obb.eia.natural_gas.exploration_and_reserves.crude_oil_and_natural_gas_drilling_activity
  • obb.eia.natural_gas.exploration_and_reserves.crude_oil_and_natural_gas_exploratory_and_development_wells
  • obb.eia.natural_gas.exploration_and_reserves.crude_oil_plus_lease_condensate
  • obb.eia.natural_gas.exploration_and_reserves.dry_natural_gas_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.federal_offshore_gulf_of_america_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.footage_drilled_for_crude_oil_and_natural_gas_wells
  • obb.eia.natural_gas.exploration_and_reserves.lease_condensate
  • obb.eia.natural_gas.exploration_and_reserves.maximum_us_active_seismic_crew_counts
  • obb.eia.natural_gas.exploration_and_reserves.natural_gas_liquids_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.natural_gas_proved_reserves_wet_after_lease_separation
  • obb.eia.natural_gas.exploration_and_reserves.natural_gas_reserves_summary_as_of_dec_31
  • obb.eia.natural_gas.exploration_and_reserves.nonassociated_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.plant_liquids_in_proved_reserves
  • obb.eia.natural_gas.exploration_and_reserves.proved_nonproducing_reserves
  • obb.eia.natural_gas.exploration_and_reserves.shale_gas
  • obb.eia.natural_gas.imports_and_exports_pipelines.international_interstate_movements_of_natural_gas_by_state
  • obb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_exports_and_re_exports_by_country
  • obb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_exports_and_re_exports_by_point_of_exit
  • obb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_by_country
  • obb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_by_point_of_entry
  • obb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_exports_by_state
  • obb.eia.natural_gas.prices.natural_gas_prices
  • obb.eia.natural_gas.prices.natural_gas_spot_and_futures_prices
  • obb.eia.natural_gas.prices.residential_and_commercial_prices_selected_states
  • obb.eia.natural_gas.production.coalbed_methane_production
  • obb.eia.natural_gas.production.gulf_of_america_federal_offshore_production
  • obb.eia.natural_gas.production.lease_condensate_production
  • obb.eia.natural_gas.production.natural_gas_gross_withdrawals_and_production
  • obb.eia.natural_gas.production.natural_gas_plant_liquids_production
  • obb.eia.natural_gas.production.natural_gas_plant_processing
  • obb.eia.natural_gas.production.natural_gas_wellhead_value_and_marketed_production
  • obb.eia.natural_gas.production.number_of_gas_producing_oil_wells
  • obb.eia.natural_gas.production.number_of_producing_gas_wells
  • obb.eia.natural_gas.production.offshore_gross_withdrawals_of_natural_gas
  • obb.eia.natural_gas.production.shale_gas_production
  • obb.eia.natural_gas.production.supplemental_gas_supplies
  • obb.eia.natural_gas.storage.lng_storage_additions_and_withdrawals
  • obb.eia.natural_gas.storage.underground_natural_gas_storage_by_all_operators
  • obb.eia.natural_gas.storage.underground_natural_gas_storage_capacity
  • obb.eia.natural_gas.storage.us_underground_natural_gas_storage_by_storage_type
  • obb.eia.natural_gas.storage.weekly_working_gas_in_underground_storage
  • obb.eia.natural_gas.summary.natural_gas_annual_supply_disposition_by_state
  • obb.eia.natural_gas.summary.natural_gas_summary
  • obb.eia.natural_gas.summary.us_natural_gas_monthly_supply_and_disposition_balance
  • obb.eia.electricity.electric_power_operations
  • obb.eia.electricity.electric_power_operations_for_individual_power_plants
  • obb.eia.electricity.electricity_sales_to_ultimate_customers
  • obb.eia.electricity.inventory_of_operable_generators
  • obb.eia.electricity_grid.demand
  • obb.eia.electricity_grid.demand_by_subregion
  • obb.eia.electricity_grid.generation_by_fuel
  • obb.eia.electricity_grid.interchange
  • obb.eia.state_electricity_profiles.advanced_metering_infrastructure
  • obb.eia.state_electricity_profiles.costs_and_savings_from_energy_efficiency_programs
  • obb.eia.state_electricity_profiles.electricity_net_metering_customers_and_capacity
  • obb.eia.state_electricity_profiles.emissions_by_state_by_fuel
  • obb.eia.state_electricity_profiles.generating_capacity
  • obb.eia.state_electricity_profiles.state_rankings_for_key_statistics
  • obb.eia.state_electricity_profiles.supply_and_disposition_of_electricity
  • obb.eia.densified_biomass.capacity_by_region
  • obb.eia.densified_biomass.characteristics_by_region
  • obb.eia.densified_biomass.export_sales_and_price
  • obb.eia.densified_biomass.feedstocks_and_costs
  • obb.eia.densified_biomass.inventories_by_region
  • obb.eia.densified_biomass.production_by_region
  • obb.eia.densified_biomass.sales_and_price_by_region
  • obb.eia.densified_biomass.wood_pellet_plant_capacity
  • obb.eia.nuclear_outages.facility_level_nuclear_outages
  • obb.eia.nuclear_outages.generator_level_nuclear_outages
  • obb.eia.nuclear_outages.us_nuclear_outages
  • obb.eia.crude_oil_imports
  • obb.eia.international
  • obb.eia.seds
  • obb.eia.total_energy
  • obb.eia.aeo
  • obb.eia.ieo
  • obb.eia.data_browser
  • obb.eia.petroleum_status_report
  • obb.eia.short_term_energy_outlook

Comment thread openbb_platform/providers/eia/openbb_us_eia/utils/rss.py Fixed
Comment thread openbb_platform/providers/eia/openbb_us_eia/browsers.py Fixed
@deeleeramone
deeleeramone marked this pull request as ready for review July 15, 2026 17:00
@deeleeramone deeleeramone added refactor Refactor code platform OpenBB Platform extensions Extension-related V5 PRs and issues for ODP V5 labels Jul 22, 2026
@deeleeramone
deeleeramone requested a review from piiq July 22, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

extensions Extension-related platform OpenBB Platform refactor Refactor code V5 PRs and issues for ODP V5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants