diff --git a/openbb_platform/README.md b/openbb_platform/README.md index e88b6e639f7..a0e4eac00c9 100644 --- a/openbb_platform/README.md +++ b/openbb_platform/README.md @@ -18,18 +18,39 @@ The command below provides access to the core functionalities behind the OpenBB ```bash pip install openbb -pip install openbb ``` +This will install the following data providers: + +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +|----------------|-------------|----------------------|------------------------------------| +| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | +| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free | +| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | None | +| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | None / Free | +| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | +| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | +| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | +| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | +| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | +| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | None | +| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | +| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| openbb-ultima | [Ultima Insights](https://ultimainsights.ai/openbb) data connector | pip install openbb-ultima | Paid | + + To install extensions that expand the core functionalities specify the extension name or use `all` to install all. ```bash -# Install single extension, e.g. openbb-charting +# Install single extension, e.g. openbb-charting and yahoo finance pip install openbb[charting] +pip install openbb-yfinance +``` -# Install all available extensions -pip install openbb[all] --pre -`````` +Alternatively, you can install all extensions at once. +```bash +pip install openbb[all] +``` > Note: These instruction are specific to v4. For installation instructions and documentation for v3 go to our [website](https://docs.openbb.co/sdk). diff --git a/website/content/platform/extensions/data_extensions.md b/website/content/platform/extensions/data_extensions.md index b2bae989003..fc8effaf654 100644 --- a/website/content/platform/extensions/data_extensions.md +++ b/website/content/platform/extensions/data_extensions.md @@ -56,29 +56,42 @@ pip uninstall openbb-yfinance ## Available Data Extensions -| Extension Name | Description | Installation Command | Core/Community | Minimum Subscription Type Required | -|:-----------------|:-----------:|:-------------------:|:-----------------:|--------------------------------------:| -| openbb-alpha-vantage | [Alpha Vantage](https://www.alphavantage.co/) data connector. | pip install openbb-alpha-vantage | Community | Free | -| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector. | pip install openbb-benzinga | Core | Paid | -| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector. | pip install openbb-biztoc | Community | Free | -| openbb-cboe | [Cboe](https://www.cboe.com/delayed_quotes/) data connector. | pip install openbb-cboe | Community | None | -| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector. | pip install openbb-ecb | Community | None | -| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector. | pip install openbb-finra | Community | None / Free | -| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector. | pip install openbb-fmp | Core | Free | -| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector. | pip install openbb-fred | Core | Free | -| openbb-government-us | [US Government](https://data.gov) data connector. | pip install openbb-us-government | Core | None | -| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector. | pip install openbb-intrinio | Core | Paid | -| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector. | pip install openbb-nasdaq | Community | None / Free | -| openbb-oecd | [OECD](https://data.oecd.org/) data connector. | pip install openbb-oecd | Core | Free | -| openbb-polygon | [Polygon](https://polygon.io/) data connector. | pip install openbb-polygon | Core | Free | -| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector. | pip install openbb-sec | Core | None | -| openbb-seeking-alpha | [Seeking Alpha](https://seekingalpha.com/) data connector. | pip install openbb-seeking-alpha | Community | None | -| openbb-stockgrid | [Stockgrid](https://stockgrid.io) data connector. | pip install openbb-stockgrid | Community | None | -| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector. | pip install openbb-tiingo | Core | Free | -| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector. | pip install openbb-tradingeconomics | Core | Paid | -| openbb-ultima | [Ultima Insights](https://ultimainsights.ai/openbb) data connector. | pip install openbb-ultima | Community | Paid | -| openbb-wsj | [Wall Street Journal](https://www.wsj.com/) data connector. | pip install openbb-wsj | Community | None | -| openbb-yfinance | [Yahoo Finance](https://finance.yahoo.com/) data connector. | pip install openbb-yfinance | Community | None | +### 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](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | +| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free | +| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | None | +| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | None / Free | +| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | +| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | +| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | +| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | +| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | +| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | None | +| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | +| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| openbb-ultima | [Ultima Insights](https://ultimainsights.ai/openbb) data connector | pip install openbb-ultima | Paid | + + +### 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](https://www.alphavantage.co/) data connector | pip install openbb-alpha-vantage | Free | +| openbb-cboe | [Cboe](https://www.cboe.com/delayed_quotes/) data connector | pip install openbb-cboe | None | +| openbb-government-us | [US Government](https://data.gov) data connector | pip install openbb-us-government | None | +| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector | pip install openbb-nasdaq | None / Free | +| openbb-seeking-alpha | [Seeking Alpha](https://seekingalpha.com/) data connector | pip install openbb-seeking-alpha | None | +| openbb-stockgrid | [Stockgrid](https://stockgrid.io) data connector | pip install openbb-stockgrid | None | +| openbb-wsj | [Wall Street Journal](https://www.wsj.com/) data connector | pip install openbb-wsj | None | +| openbb-yfinance | [Yahoo Finance](https://finance.yahoo.com/) data connector | pip install openbb-yfinance | 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](https://github.com/OpenBB-finance/OpenBBTerminal/) to submit an extension for inclusion. Code contributions, for new and existing, data providers are always welcome.