openbb-us-eia

library1.3.1pypypi✓ verified 79d ago

An OpenBB provider extension for accessing U.S. Energy Information Administration (EIA) data via the EIA API. Version 1.3.1 supports Python 3.10+. Release cadence is irregular, typically aligned with OpenBB Platform updates.

analytics database

pip install openbb-us-eia

INSTALL

IMPORT

SIG · OPENBB-US-EIA

openbb-us-eia

analyticspythonv1.3.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

EiaPetroleumStatusReportFetcher

✓ from openbb_us_eia import EiaPetroleumStatusReportFetcher

✗ from openbb_us_eia import EIAProvider

EiaShortTermEnergyOutlookFetcher

✓ from openbb_us_eia import EiaShortTermEnergyOutlookFetcher

Provider

✓ from openbb_us_eia import Provider

Initializes OpenBB with the EIA provider and fetches petroleum consumption data. Requires EIA API key set as environment variable EIA_API_KEY.

from openbb import obb import os # Register provider (usually auto-discovered) obb.providers.add_provider('us_eia', api_key=os.environ.get('EIA_API_KEY', '')) # Example: get petroleum consumption data df = obb.energy.eia.petroleum_consumption(start='2024-01-01', end='2024-12-31').to_dataframe() print(df.head())

Debug

Known issues

breakingVersion 1.3.x changed the command structure. Previously methods like `obb.eia.petroleum_consumption` must now be accessed under `obb.energy.eia.*`. Update all calls.

fix

Prefix EIA calls with 'energy' submodule: e.g., `obb.energy.eia.petroleum_consumption`.

affects: >=1.3.0

deprecatedThe `obb.eia.*` namespace is deprecated since v1.3.0 and will be removed in a future release. Use `obb.energy.eia.*` instead.

fix

Replace `obb.eia.` with `obb.energy.eia.` in all calls.

affects: >=1.3.0

gotchaEIA API keys are free but rate-limited (default 200 requests per hour). Exceeding the limit results in HTTP 429 errors. The provider does not handle retries automatically.

fix

Implement your own retry logic or use a caching layer. Request a higher limit from EIA if needed.

affects: all

gotchaSome EIA series IDs require specific facets (e.g., region, fuel type) that must be passed as keyword arguments. Omitting required facets returns an error.

fix

Check the EIA API documentation for required parameters of each series and pass them as kwargs to the OpenBB command.

affects: all

Upgrade

Version history

1.3.1latest on PyPI · released May 26, 2026

Audit

Dependencies

openbb-corerequiredRequired for provider framework and data models

openbb-eiaoptionalBase EIA provider (if separate)

Agent activity

39 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

No resource links recorded.