OilPriceAPI Docs
GitHub
GitHub
  • Interactive Explorer

    • Interactive API Explorer
  • Price Data

    • API Reference
    • Get Latest Prices
    • Historical Prices
    • Batch Prices
    • Excel Latest Price Gateway
    • Price Widget Endpoints
    • Price Utility Endpoints
    • Natural Gas Intelligence
  • Commodities

    • List Commodities
    • Get Commodity Details
  • AI Agents (MCP)

    • Get Market Brief
    • Subscriptions / Watches
    • Agent Subscriptions with MCP
  • Marine Fuels

    • Marine Fuel API
    • List Marine Fuel Ports
    • Get Port Details with Prices
    • Bunker Fuels
    • Maritime Fuels
  • Premium Endpoints

    • All Prices API - One Call, All Commodities
    • Cushing Oil Storage Intelligence API
    • Drilling Intelligence API
    • Marine Fuels API
    • ICE Brent Futures API
    • Benchmark Close
    • Aviation Fuel Pilot
  • Spreads & Margins

    • Spreads & Margins
    • Crack Spreads
    • Basis Spreads
    • Refining Margins
    • Curve Structure
    • Physical Premiums
  • Market Indicators

    • Market Indicators
    • Fuel Switching
    • Price Context
    • Storage Analytics
    • CFTC Positioning
    • Congressional Trades
    • Market Annotations
  • Futures

    • Futures API
    • ICE Brent Futures
    • ICE WTI Futures
    • ICE Gas Oil Futures
    • NYMEX Natural Gas Futures
    • ICE EUA Carbon Futures
    • EU Carbon Futures
    • TTF Gas Futures
    • LNG JKM Futures
    • UK Carbon Futures
  • Dark Data (Premium)

    • Energy Intelligence API
    • Rig Counts
    • Well Permits
    • Well Production Beta
    • Oil Inventories
    • OPEC Production
    • Drilling Productivity
    • Forecasts (STEO)
  • Well Production (Beta)

    • Well Production Data
    • Well Production API Reference
  • Analytics

    • Analytics API
  • Webhooks API

    • Webhooks API Reference
    • Webhook Endpoint Reference
  • Alerts

    • Price Alerts API
  • Account & Billing

    • Account API
    • API Keys
    • Subscriptions
    • Organizations

Price Widget Endpoints

Widget endpoints support lightweight dashboard and embeddable display workflows.

Endpoints

MethodEndpointPurpose
GET/v1/prices/widgetGeneral widget payload
GET/v1/prices/widget/dieselDiesel-focused widget payload
GET/v1/prices/widget/pingWidget health check

General Widget

curl "https://api.oilpriceapi.com/v1/prices/widget?by_code=WTI_USD" \
  -H "Authorization: Token YOUR_API_KEY"
{
  "status": "success",
  "data": {
    "code": "WTI_USD",
    "label": "WTI Crude Oil",
    "price": 74.52,
    "formatted": "$74.52",
    "created_at": "2026-07-15T14:30:00.000Z"
  }
}

Diesel Widget

curl "https://api.oilpriceapi.com/v1/prices/widget/diesel" \
  -H "Authorization: Token YOUR_API_KEY"

Use this for fleet, logistics, and fuel-surcharge widgets that need diesel-specific labeling.

Widget Ping

curl "https://api.oilpriceapi.com/v1/prices/widget/ping" \
  -H "Authorization: Token YOUR_API_KEY"

Use ping for lightweight monitoring of the widget service path. Do not use it as a substitute for the public API status page.

Data Rights

Widgets that display prices publicly can trigger display or redistribution review. Check Data Usage Policy before embedding price data in public pages, customer portals, or downstream products.

Error Cases

StatusWhen
400Invalid widget parameter
401Missing or invalid API key
402Quota exhausted or plan not enabled
429Rate limit exceeded
Last Updated: 7/16/26, 1:53 PM
Prev
Excel Latest Price Gateway
Next
Price Utility Endpoints