openbb-sugra

Sugra data provider extension for the OpenBB Platform.

One Sugra API key. 141 OpenBB data models. One provider.

One Sugra API key. 141 OpenBB data models. One provider.

Wire in one credential and pull equities and fundamentals, estimates, ownership, calendars, options, crypto, currencies, news, macro and rates, treasuries, ETFs and indices, commodities, futures, and maritime data - the breadth that otherwise needs many separate provider keys. Every model is live-verified against the Sugra API and through the OpenBB obb.* layer.

1. Install

pip install openbb-sugra

The provider auto-registers with OpenBB through the openbb_provider_extension entry point. After install, import openbb rebuilds the static package and the sugra provider becomes available.

2. Get a key

Get a Sugra API key at sugra.ai, then set it once:

export OPENBB_SUGRA_API_KEY="your_key"

or add it to ~/.openbb_platform/user_settings.json:

{ "credentials": { "sugra_api_key": "your_key" } }

The key is sent as the x-api-key request header. Volume-only pricing, commercial use permitted on every tier.

3. Use

from openbb import obb

obb.equity.price.historical("AAPL", provider="sugra")
obb.economy.fred_series("GDP", provider="sugra")
obb.crypto.price.historical("BITCOIN", provider="sugra")

4. Coverage

A single Sugra key fulfils 141 OpenBB standard data models across fourteen command groups - equity, economy, Fama-French, ETF, currency, fixed income, index, CFTC, commodity, crypto, news, US Congress, regulators, and derivatives. The full matrix is generated from the shipped fetchers - see COVERAGE.md.

5. License

AGPL-3.0-only. This package links the AGPL-3.0 openbb-core library. The Sugra API itself is a separate hosted service reached over HTTPS. See LICENSE.