Files
OpenBB/website/content/platform/extensions/data_extensions.md
Danglewood c047cfeddd docs/new-working-docs: New working docs branch (#5768)
* move old example notebooks to v3 folder, update loadHistoricalPriceData and add findSymbols

* Create README.md

* Update README.md

* Update README.md

* Update README.md

* Vertical diagram instead

* important classes

* core dependencies

* folder structure

* devtools

* swap order

* fix github pages deploy issue

* development index

* delete expectations for developers

* devtools

* obbject stuff

* add

* installation

* hub sync

* idk if i committed already

* add usage page for financial statements

* add link to reference page

* syntax

* numbers

* nearly --> more than

* easier to read code blocks

* codespell

* removing mention to provider

* add 'orientation' for to_dict

* info card for output user preference

* put it in a code block

* correct user_settings.json example

* syntax corrections

* fix sentence

* get rid of floating point mathc

* get rid of other floating point math

* add companion example notebook for financial statements, and new section

* historical prices usage page

* codespell

* add commitment of traders section to usage

* add a note

* codespell

* get rid of equals sign

* Cleanup docs. with @the-praxs

* install

* obbject extend

* spell

* HeadTitle thingies

* Update obbject_extensions.md

* Update obbject_extensions.md

* typo

* Update architectural_considerations.md

* point to the TET pattern

* optional vs required

* reviewing the  patterns. removed the --pre flag under the assumption this will be the final docs for the release cc @deeleeramone

* add a walkthrough

* spelling

* Add more in the introduction

* validator examples

* update Copper-to-Gold notebook example for V4

* Update README.md

* QA Caveats w @the-praxs

* info on class outputs

* merge add data sources and add data points

* disclaimer on cookiecutter

* add missing import to example

* slight syntax change

* missing code block

* missing import

* update intrinio example syntax

* intrinio syntax update

* urls

* core and provider merged

* example syntax

* grammar

* Update API banner link

* quick-fix-docs cc @minhhoang1023

* Update pip install command for v3

* remove --pre note block

* update landing image

---------

Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
Co-authored-by: Luqman <luqazino@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-12-01 01:09:25 +00:00

5.1 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

Extension Name Description Installation Command Core/Community Minimum Subscription Type Required
openbb-alpha-vantage Alpha Vantage data connector. pip install openbb-alpha-vantage Community Free
openbb-benzinga Benzinga data connector. pip install openbb-benzinga Core Paid
openbb-biztoc Biztoc News data connector. pip install openbb-biztoc Community Free
openbb-cboe Cboe data connector. pip install openbb-cboe Community None
openbb-ecb ECB data connector. pip install openbb-ecb Community None
openbb-finra FINRA data connector. pip install openbb-finra Community None / Free
openbb-fmp FMP data connector. pip install openbb-fmp Core Free
openbb-fred FRED data connector. pip install openbb-fred Core Free
openbb-government-us US Government data connector. pip install openbb-us-government Core None
openbb-intrinio Intrinio data connector. pip install openbb-intrinio Core Paid
openbb-nasdaq Nasdaq Data Link connector. pip install openbb-nasdaq Community None / Free
openbb-oecd OECD data connector. pip install openbb-oecd Core Free
openbb-polygon Polygon data connector. pip install openbb-polygon Core Free
openbb-sec SEC data connector. pip install openbb-sec Core None
openbb-seeking-alpha Seeking Alpha data connector. pip install openbb-seeking-alpha Community None
openbb-stockgrid Stockgrid data connector. pip install openbb-stockgrid Community None
openbb-tiingo Tiingo data connector. pip install openbb-tiingo Core Free
openbb-tradingeconomics TradingEconomics data connector. pip install openbb-tradingeconomics Core Paid
openbb-ultima Ultima Insights data connector. pip install openbb-ultima Community Paid
openbb-wsj Wall Street Journal data connector. pip install openbb-wsj Community None
openbb-yfinance Yahoo Finance data connector. pip install openbb-yfinance Community 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.