Skip to main content

Sugra data provider extension for the OpenBB Platform - one key across markets, fundamentals, macro, rates, crypto, currencies, news, ETFs, indices, and maritime data.

Project description

Sugra for OpenBB - 138 OpenBB data models from one Sugra key

openbb-sugra

Sugra data provider extension for the OpenBB Platform.

PyPI Python License OpenBB

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


One Sugra API key. 138 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, 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 138 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.


Sugra Systems, Inc.  ·  sugra.ai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbb_sugra-0.2.0.tar.gz (133.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openbb_sugra-0.2.0-py3-none-any.whl (249.8 kB view details)

Uploaded Python 3

File details

Details for the file openbb_sugra-0.2.0.tar.gz.

File metadata

  • Download URL: openbb_sugra-0.2.0.tar.gz
  • Upload date:
  • Size: 133.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openbb_sugra-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8596f3fb572e92affdb7747d2d51d589624f1effb6b0bd9291f5f12d3308a829
MD5 dba0078133c5d98987b0024b4e36bf81
BLAKE2b-256 aca51a7e8edc225985ab0cec70354ec0af7b042fd599f3fa520be40e6609858c

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbb_sugra-0.2.0.tar.gz:

Publisher: publish-pypi.yml on Sugra-Systems/openbb-sugra

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbb_sugra-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: openbb_sugra-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 249.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openbb_sugra-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5069c07e3b6c34cce9204ed278d2de31f649c916c463d912b14b3a3348ce864e
MD5 3748280144155d02a336d9a7ecbeb1d6
BLAKE2b-256 16cb2d988746850f67922bb23467844e645bba46e3c84f11c4cc10e27ba9c53d

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbb_sugra-0.2.0-py3-none-any.whl:

Publisher: publish-pypi.yml on Sugra-Systems/openbb-sugra

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page