openbb-us-eia

What it is and what it does

This package extends the OpenBB Platform with a provider for U.S. Energy Information Administration data, enabling programmatic access to two main datasets: the Weekly Petroleum Status Report (WPSR) and the Short Term Energy Outlook (STEO). The WPSR covers 13 high-level petroleum categories including production, stocks, imports, and prices, sourced from EIA's static Excel files. The STEO provides forecasted energy market data across multiple tables covering oil, natural gas, coal, electricity, and macroeconomic indicators.

The package requires registration with EIA to obtain a free API key, which can be configured via the OpenBB Hub, a JSON settings file, or programmatically in the current session. Data is returned in a flat, tabular format suitable for pivot tables and SQL storage. The petroleum status report does not require an API key, while most STEO endpoints do.

Use it for:

• Retrieve weekly petroleum supply and inventory data for energy market analysis and reporting.
• Access short-term energy forecasts across oil, gas, coal, and electricity sectors for investment or policy decisions.
• Build automated dashboards or reports that pull the latest EIA data into OpenBB-based applications.
• Query historical petroleum prices and regional energy data for quantitative energy market research.
• Integrate U.S. energy market data into financial models or trading systems via the OpenBB Platform.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Integrates U.S. Energy Information Administration (EIA) data into the OpenBB Platform, providing access to petroleum status reports and energy outlook data via API.

Yes, if you are already using the OpenBB Platform and need access to official U.S. energy data. The package is actively maintained, has low install friction, and provides access to authoritative EIA datasets. However, the AGPL-3.0 license restricts use in proprietary closed-source projects, and you must obtain a free EIA API key to use most endpoints. Not suitable as a standalone library—it is a provider extension for OpenBB.

Install

openbb-us-eia on PyPI

pip install openbb-us-eia

uv add openbb-us-eia

poetry add openbb-us-eia

Installing openbb-us-eia

Before you install

Low install friction with a pure Python wheel and four runtime dependencies. Active maintenance with a release within the last 80 days. Supports current Python versions (3.10–3.14).

License in practice

Licensed under AGPL-3.0-only, which requires derivative works and modifications to be distributed under the same license and made available to users. Suitable for internal or open-source projects but not for proprietary closed-source applications.

Quickstart

pip install openbb-us-eia

from openbb import obb
obb.user.credentials.eia_api_key = "YOUR_API_KEY"
data = obb.commodity.petroleum_status_report(table="balance_sheet")

Requires a free EIA API key from https://www.eia.gov/opendata/register.php; most endpoints require this credential to function.

Verify before relying

• Whether the package works as a standalone tool or only within the full OpenBB Platform ecosystem.
• Performance characteristics and data freshness guarantees for real-time or near-real-time energy market queries.
• Whether all 13 WPSR categories and 10b STEO tables are fully implemented or if some remain in development.

Package facts

Evidence: openbb_us_eia-1.3.1-py3-none-any.whl

Tags

More Information Analysis packages