Files
OpenBB/website/content/platform/extensions/data_extensions.md
2024-01-23 12:02:22 +00:00

5.4 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Data Extensions 1 Learn about the OpenBB Platform and its extension framework that allows seamless integration of modules like 'openbb-yfinance'. Discover how installations and removals automatically update the router when the Python interpreter is refreshed. This page lists the data provider extensions available.
OpenBB Platform
extension framework
yFinance
install openbb-yfinance
Python interpreter
PyPI
openbb-qa
data
vendors
providers
install
free
subscription

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Data extensions will expand the breadth and coverage of the data available in the OpenBB Platform. Each source (provider) is its own independent extension, even if there is only one endpoint accessible. This allows every data source to be inserted or removed, at any time, without disturbing the operation of the Core components.

Functions will appear in the Python Interface and Fast API only if a supported provider, for that specific endpoint, is installed. Additional Python libraries will be installed, where required, by the extension.

Provider Coverage

The total installed coverage can be determined through the Python interface, as a dictionary.

from openbb import obb
obb.coverage.providers

Installation

All data extensions are installed with similar syntax. Published data extensions will have names beginning with openbb. For example, yFinance.

pip install openbb-yfinance

Additions and removals update the router automatically to reflect the changes when the Python interpreter is refreshed. Below is a list of data provider extensions.

Uninstall any extension with pip uninstall.

pip uninstall openbb-yfinance

Available Data Extensions

Core openbb Providers

These packages are what will be installed when pip install openbb is run

Extension Name Description Installation Command Minimum Subscription Type Required
openbb-benzinga Benzinga data connector pip install openbb-benzinga Paid
openbb-fmp FMP data connector pip install openbb-fmp Free
openbb-fred FRED data connector pip install openbb-fred Free
openbb-intrinio Intrinio data connector pip install openbb-intrinio Paid
openbb-oecd OECD data connector pip install openbb-oecd Free
openbb-polygon Polygon data connector pip install openbb-polygon Free
openbb-sec SEC data connector pip install openbb-sec None
openbb-tiingo Tiingo data connector pip install openbb-tiingo Free
openbb-tradingeconomics TradingEconomics data connector pip install openbb-tradingeconomics Paid
openbb-ultima Ultima Insights data connector pip install openbb-ultima Paid
openbb-yfinance Yahoo Finance data connector pip install openbb-yfinance None

Community Providers

These packages are not installed when pip install openbb is run. They are available for installation separately or by running pip install openbb[all]

Extension Name Description Installation Command Minimum Subscription Type Required
openbb-alpha-vantage Alpha Vantage data connector pip install openbb-alpha-vantage Free
openbb-biztoc Biztoc News data connector pip install openbb-biztoc Free
openbb-cboe Cboe data connector pip install openbb-cboe None
openbb-ecb ECB data connector pip install openbb-ecb None
openbb-finra FINRA data connector pip install openbb-finra None / Free
openbb-finviz Finviz data connector pip install openbb-finviz None
openbb-government-us US Government data connector pip install openbb-us-government None
openbb-nasdaq Nasdaq Data Link connector pip install openbb-nasdaq None / Free
openbb-seeking-alpha Seeking Alpha data connector pip install openbb-seeking-alpha None
openbb-stockgrid Stockgrid data connector pip install openbb-stockgrid None
openbb-wsj Wall Street Journal data connector pip install openbb-wsj None

Have you published a data provider extension and want it featured on this list? Tell us about it! Open a pull request on GitHub to submit an extension for inclusion. Code contributions, for new and existing, data providers are always welcome.

Search PyPI to find more extensions.