openbb-oilpriceapi

OpenBB provider for OilPriceAPI - Real-time oil and commodity prices.

Installation

pip install openbb-oilpriceapi

Quick Start

from openbb import obb

# Configure your API key (get free key at https://www.oilpriceapi.com/signup?utm_source=openbb&utm_medium=integration&utm_campaign=readme)
obb.user.credentials.oilpriceapi_api_key = "your_api_key"

# Get all commodity prices
prices = obb.commodity.oil.price(provider="oilpriceapi")
df = prices.to_dataframe()
print(df)

# Get specific commodity (WTI crude)
wti = obb.commodity.oil.price(symbol="WTI", provider="oilpriceapi")
print(f"WTI Price: ${wti.results[0].price}/barrel")

Supported Commodities

Configuration

Set Credentials

You can set your API key in multiple ways:

Option 1: In Python

obb.user.credentials.oilpriceapi_api_key = "your_key"

Option 2: Via settings file Add to ~/.openbb_platform/user_settings.json:

{
  "credentials": {
    "oilpriceapi_api_key": "your_key"
  }
}

Option 3: Environment variable

export OPENBB_OILPRICEAPI_API_KEY="your_key"

Examples

Get Price History

# Get WTI prices for the past week
history = obb.commodity.oil.historical(
    symbol="WTI",
    period="past_week",
    provider="oilpriceapi"
)
df = history.to_dataframe()

Compare Commodities

import pandas as pd

# Get all prices and compare
prices = obb.commodity.oil.price(provider="oilpriceapi")
df = prices.to_dataframe()

# Filter for crude oils
crude = df[df['symbol'].isin(['WTI', 'BRENT', 'URALS'])]
print(crude[['symbol', 'price', 'change_percent']])

Visualize Prices

import matplotlib.pyplot as plt

history = obb.commodity.oil.historical(
    symbol="BRENT",
    period="past_month",
    provider="oilpriceapi"
)
df = history.to_dataframe()

plt.figure(figsize=(10, 6))
plt.plot(df['date'], df['price'])
plt.title('Brent Crude - Past Month')
plt.ylabel('Price (USD/barrel)')
plt.show()

API Reference

OilPrice

Fetch latest commodity prices.

Parameters:

• symbol (str, optional): Commodity symbol. If not provided, returns all commodities.
• provider (str): Must be "oilpriceapi"

Returns:

• symbol: Commodity symbol
• name: Commodity name
• price: Current price
• currency: Price currency
• unit: Unit of measurement
• updated_at: Last update timestamp
• change: Price change (absolute)
• change_percent: Price change (percentage)

OilHistorical

Fetch historical price data.

Parameters:

• symbol (str, required): Commodity symbol
• period (str): Historical period - past_day (24h hourly), past_week (7d daily), past_month (30d daily). Default: past_week
• provider (str): Must be "oilpriceapi"

Returns:

• date: Price timestamp
• symbol: Commodity symbol
• price: Price at timestamp
• currency: Price currency
• unit: Unit of measurement

Development

# Clone the repository
git clone https://github.com/OilpriceAPI/openbb-oilpriceapi.git
cd openbb-oilpriceapi

# Install dependencies
poetry install

# Run tests
poetry run pytest

# Run tests with coverage
poetry run pytest --cov=openbb_oilpriceapi

Links

• OilPriceAPI Website
• Sign Up
• OilPriceAPI Documentation
• Pricing
• OpenBB Platform
• GitHub Repository

Also Available As

• Python SDK - Standalone Python client with Pandas integration
• MCP Server - Model Context Protocol server for Claude and Cursor
• Google Sheets Add-on - Custom functions for spreadsheets

License

MIT License - see LICENSE for details.