openbb-commodity

library1.5.2pypypiunverified

Commodity extension for the OpenBB Platform, providing tools for analyzing and fetching commodity data (e.g., metals, energy, agriculture). Current version 1.5.2, requires Python 3.10+. Part of the OpenBB v4 ecosystem; release cadence follows OpenBB's major/minor releases.

finance

pip install openbb-commodity

INSTALL

IMPORT

SIG · OPENBB-COMMODITY

openbb-commodity

financepythonv1.5.2

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.

obbject

✓ from openbb_commodity import obbject

✗ from openbb import obbject

Quickstart: Use the OpenBB obbject to access commodity endpoints. The extension registers providers like 'fred' for commodity data.

from openbb import obbject # Fetch crude oil prices using the default provider result = obbject.commodity.crude_oil() print(result) # If you need to specify a provider (e.g., fred) # result = obbject.commodity.crude_oil(provider='fred')

Debug

Known issues

gotchaDo not import 'openbb-commodity' directly. The extension is loaded automatically when you import openbb and have the package installed. Attempting 'from openbb_commodity import ...' may fail or bypass the main OpenBB interface.

fix

Use 'from openbb import obbject' and then access commodity via 'obbject.commodity'.

affects: all

gotchaThe 'commodity' module may have limited methods depending on installed providers. Not all commodity types (e.g., copper, gold) may be available without a specific provider like 'fred' or 'yfinance'.

fix

Check available endpoints by running 'dir(obbject.commodity)' after installation, and ensure you have the required provider packages installed (e.g., 'pip install openbb-fred').

affects: all

breakingOpenBB v4 introduced a provider-based architecture. Methods like 'crude_oil()' may require a 'provider' parameter. Omitting it may raise 'ProviderError'.

fix

Always specify 'provider' if the default provider is not set. Example: 'obbject.commodity.crude_oil(provider='fred')'.

affects: >=4.0.0

Upgrade

Version history

1.5.2latest on PyPI · released May 26, 2026

Audit

Dependencies

openbb-corerequiredCore OpenBB platform required for all extensions

Agent activity

33 hits · last 30 days

node

Amazon

Resources

No resource links recorded.