-
-
-Once you enter the type of investor you are, the organization you work at and your email address pressing "GET FREE API KEY" gets you the key that you can submit into the OpenBB SDK with `openbb.keys.av`
-
-
-AlphaVantage
- -Go to https://www.alphavantage.co/support/#api-key. You will be greeted with the following screen: - -
-
-Once you enter the type of investor you are, the organization you work at and your email address pressing "GET FREE API KEY" gets you the key that you can submit into the OpenBB SDK with `openbb.keys.av`
-
-
-
-These instructions should provide clear guidance how to set up an API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.binance`.
-
-
-Binance
-Go to https://www.binance.com/en/support/faq/how-to-create-api-360002502072. You will be greeted with the following screen: - -
-
-These instructions should provide clear guidance how to set up an API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.binance`.
-
-
-
-Click "Try GraphQL API". This opens the following screen:
-
-
-
-After creating an account and verifying your email address, you will be able to access your API Key by clicking "Api Key". Enter this API key into the OpenBB SDK by typing `openbb.keys.bitquery`.
-
-
-
-
-Bitquery
- -Go to https://bitquery.io/. You will be greeted with the following screen: - -
-
-Click "Try GraphQL API". This opens the following screen:
-
-
-
-After creating an account and verifying your email address, you will be able to access your API Key by clicking "Api Key". Enter this API key into the OpenBB SDK by typing `openbb.keys.bitquery`.
-
-
-
-
-
-From here, click "Get Your Free API Key Now". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB SDK by typing `openbb.keys.cmc`
-
-
-
-
-CoinMarketCap
- -Go to https://coinmarketcap.com/api. You will be greeted with the following screen: - -
-
-From here, click "Get Your Free API Key Now". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB SDK by typing `openbb.keys.cmc`
-
-
-
-
-
-By following these instructions you should be able to set-up an API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.coinbase`.
-
-
-CoinBase
- -Go to https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key. You will be greeted with the following screen: - -
-
-By following these instructions you should be able to set-up an API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.coinbase`.
-
-
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you created your account, you will be able to find the API Key on your profile. Enter this API key into the OpenBB SDK by typing `openbb.keys.coinglass`.
-
-
-Coinglass
- -Go to https://www.coinglass.com/. You will be greeted with the following screen: - -
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you created your account, you will be able to find the API Key on your profile. Enter this API key into the OpenBB SDK by typing `openbb.keys.coinglass`.
-
-
-
-Click "Sign up" under "Your free API auth token". This opens up the following screen:
-
-
-
-Once you have created your account, your API Key will be displayed under "Your free API auth token". Enter this API key into the OpenBB SDK by typing `openbb.keys.cpanic`.
-
-
-
-
-Crypto Panic
- -Go to https://cryptopanic.com/developers/api/. You will be greeted with the following screen: - -
-
-Click "Sign up" under "Your free API auth token". This opens up the following screen:
-
-
-
-Once you have created your account, your API Key will be displayed under "Your free API auth token". Enter this API key into the OpenBB SDK by typing `openbb.keys.cpanic`.
-
-
-
-
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.degiro`. We also support 2FA, you can find more information about that [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-).
-
-
-DeGiro
- -Go to https://www.degiro.com/. You will be greeted with the following screen: - -
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.degiro`. We also support 2FA, you can find more information about that [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-).
-
-
-
-Click "Registration". This opens up the following screen:
-
-
-
-Once you have registered, you can find the API Key next to "API TOKEN". Enter this API key into the OpenBB SDK by typing `openbb.keys.cpanic`.
-
-
-
-
-EODHD
- -Go to https://eodhistoricaldata.com/r/?ref=869U7F4J. You will be greeted with the following screen: - -
-
-Click "Registration". This opens up the following screen:
-
-
-
-Once you have registered, you can find the API Key next to "API TOKEN". Enter this API key into the OpenBB SDK by typing `openbb.keys.cpanic`.
-
-
-
-
-
-Press "Get free api key". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB SDK by typing `openbb.keys.finnhub`
-
-
-
-
-Finnhub
- -Go to https://finnhub.io/. You will be greeted with the following screen: - -
-
-Press "Get free api key". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB SDK by typing `openbb.keys.finnhub`
-
-
-
-
-
-From here, press "Get my API KEY here". This opens up the following screen:
-
-
-
-If you already have an account, you can sign-in directly and obtain the API key, otherwise click "Sign Up". Once you have created an account you can access your API Key by pressing the "Dashboard" button which will show the API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.fmp`
-
-
-
-
-Financial Modelling Prep
- -Go to https://site.financialmodelingprep.com/developer/docs/. You will be greeted with the following screen: - -
-
-From here, press "Get my API KEY here". This opens up the following screen:
-
-
-
-If you already have an account, you can sign-in directly and obtain the API key, otherwise click "Sign Up". Once you have created an account you can access your API Key by pressing the "Dashboard" button which will show the API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.fmp`
-
-
-
-
-
-Click on "My Account". This opens up the following screen:
-
-
-
-Once you have signed up, go to "My Account" and select "API Keys". This will get you to the following screen:
-
-
-
-Click on "Request API Key" and fill in information about why you wish to use FRED. Then, by pressing "Request API key" you will be able to obtain the API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.fred`
-
-
-
-
-FRED
- -Go to https://fred.stlouisfed.org. You will be greeted with the following screen: - -
-
-Click on "My Account". This opens up the following screen:
-
-
-
-Once you have signed up, go to "My Account" and select "API Keys". This will get you to the following screen:
-
-
-
-Click on "Request API Key" and fill in information about why you wish to use FRED. Then, by pressing "Request API key" you will be able to obtain the API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.fred`
-
-
-
-
-
-Click "Sign up" and create an account with GitHub. Once you have done so go to as depicted below: https://github.com/settings/apps
-
-
-
-Press "New GitHub App". This opens up the following screen:
-
-
-
-Once the app is created you are able to obtain the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.github`.
-
-
-GitHub
- -Go to https://github.com/. You will be greeted with the following screen: - -
-
-Click "Sign up" and create an account with GitHub. Once you have done so go to as depicted below: https://github.com/settings/apps
-
-
-
-Press "New GitHub App". This opens up the following screen:
-
-
-
-Once the app is created you are able to obtain the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.github`.
-
-
-
-Click on "Sign up". This opens up the following screen:
-
-
-
-After you have created your account, go to https://studio.glassnode.com/settings/api where you can create your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.glassnode`.
-
-
-
-
-Glassnode
- -Go to https://studio.glassnode.com/. You will be greeted with the following screen: - -
-
-Click on "Sign up". This opens up the following screen:
-
-
-
-After you have created your account, go to https://studio.glassnode.com/settings/api where you can create your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.glassnode`.
-
-
-
-
-
-Press "Sign up". This opens up the following screen:
-
-
-
-Once you have signed up, go to https://messari.io/account/api where you will be able to find your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.messari`.
-
-
-
-
-Messari
- -Go to https://messari.io/. You will be greeted with the following screen: - -
-
-Press "Sign up". This opens up the following screen:
-
-
-
-Once you have signed up, go to https://messari.io/account/api where you will be able to find your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.messari`.
-
-
-
-
-
-Press "Get API Key". This opens up the following screen:
-
-
-
-Register for an account. The next screen will provide you with the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.news`
-
-
-
-
-News API
- -Go to https://newsapi.org/. You will be greeted with the following screen: - -
-
-Press "Get API Key". This opens up the following screen:
-
-
-
-Register for an account. The next screen will provide you with the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.news`
-
-
-
-
-
-After you have created an account with Oanda, you will be able to find the API key by following the steps below. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.oanda`.
-
-
-
-
-Oanda
- -Go to https://developer.oanda.com. You will be greeted with the following screen: - -
-
-After you have created an account with Oanda, you will be able to find the API key by following the steps below. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.oanda`.
-
-
-
-
-
-Press the button "Get your Free API Key". This opens up the following screen:
-
-
-
-Once signed up you will find the API Key at the bottom. Enter this API key into the OpenBB SDK by typing `openbb.keys.polygon`
-
-
-
-
-Polygon
- -Go to https://polygon.io. You will be greeted with the following screen: - -
-
-Press the button "Get your Free API Key". This opens up the following screen:
-
-
-
-Once signed up you will find the API Key at the bottom. Enter this API key into the OpenBB SDK by typing `openbb.keys.polygon`
-
-
-
-
-
-From here, click "Sign Up" at the top. This opens up the following screen:
-
-
-
-Follow the sign-up instructions and once you have signed up you will be able to retrieve your API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.quandl`
-
-
-
-
-Quandl
- -Go to https://www.quandl.com. You will be greeted with the following screen: - -
-
-From here, click "Sign Up" at the top. This opens up the following screen:
-
-
-
-Follow the sign-up instructions and once you have signed up you will be able to retrieve your API key. Enter this API key into the OpenBB SDK by typing `openbb.keys.quandl`
-
-
-
-Reddit
- -Go to https://www.reddit.com/wiki/api. You will be greeted with the following screen: - -
-
-Press "Read the full API terms and sign up for usage" and start the sign-up process. This opens up the following screen:
-
-
-
-Once you have filled out everything, you will receive an email when your application is approved. Once this is approved you will receive the necessary information that needs to be entered in the OpenBB SDK. Enter these into the OpenBB SDK by typing `openbb.keys.reddit`.
-
-
-
-
-Press "Read the full API terms and sign up for usage" and start the sign-up process. This opens up the following screen:
-
-
-
-Once you have filled out everything, you will receive an email when your application is approved. Once this is approved you will receive the necessary information that needs to be entered in the OpenBB SDK. Enter these into the OpenBB SDK by typing `openbb.keys.reddit`.
-
-
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.rh`.
-
-
-Robinhood
- -Go to https://robinhood.com/us/en/. You will be greeted with the following screen: - -
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB SDK as follows `openbb.keys.rh`.
-
-
-
-Click "Sign up". This opens up the following screen:
-
-
-
-After creating an account go to https://app.santiment.net/account#api-keys and generate a key. Enter this API key into the OpenBB SDK by typing `openbb.keys.santiment`.
-
-
-
-
-Santiment
- -Go to https://app.santiment.net/. You will be greeted with the following screen: - -
-
-Click "Sign up". This opens up the following screen:
-
-
-
-After creating an account go to https://app.santiment.net/account#api-keys and generate a key. Enter this API key into the OpenBB SDK by typing `openbb.keys.santiment`.
-
-
-
-
-
-Click "Mint Your ShroomDK API Key" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have your account created, connect a wallet and access the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.shroom`.
-
-
-
-
-ShroomDK
- -Go to https://app.santiment.net/. You will be greeted with the following screen: - -
-
-Click "Mint Your ShroomDK API Key" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have your account created, connect a wallet and access the API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.shroom`.
-
-
-
-
-
-Click "Log in" and create an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "Developers" to access your API Key. Enter this API key into the OpenBB SDK by typing `/openbb.keys.stocksera`.
-
-
-
-
-Stocksera
- -Go to https://stocksera.pythonanywhere.com/. You will be greeted with the following screen: - -
-
-Click "Log in" and create an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "Developers" to access your API Key. Enter this API key into the OpenBB SDK by typing `/openbb.keys.stocksera`.
-
-
-
-
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "API" to access your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.tokenterminal`.
-
-
-
-
-Token Terminal
- -Go to https://tokenterminal.com/. You will be greeted with the following screen: - -
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "API" to access your API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.tokenterminal`.
-
-
-
-
-
-Click the button "Open Account" and start the sign-up process. Once you have gone through the whole process you will be able to find your API key within your account. Enter this API key into the OpenBB SDK by typing `openbb.keys.tradier`
-
-
-Tradier
- -Go to https://documentation.tradier.com/. You will be greeted with the following screen: - -
-
-Click the button "Open Account" and start the sign-up process. Once you have gone through the whole process you will be able to find your API key within your account. Enter this API key into the OpenBB SDK by typing `openbb.keys.tradier`
-
-Twitter
- -Go to https://developer.twitter.com. You will be greeted with the following screen: - -
-
-Click "Sign Up". Note that you are required to have a Twitter account and that you have verified your phone number. This opens up the following screen:
-
-
-
-Create an account and verify your email. Then, you will be able to create an app to obtain your API Key.
-
-
-
-This will give you the following keys. Enter these into the OpenBB SDK by typing `openbb.keys.twitter`.
-
-
-
-
-
-
-Click "Sign Up". Note that you are required to have a Twitter account and that you have verified your phone number. This opens up the following screen:
-
-
-
-Create an account and verify your email. Then, you will be able to create an app to obtain your API Key.
-
-
-
-This will give you the following keys. Enter these into the OpenBB SDK by typing `openbb.keys.twitter`.
-
-
-
-
-
-Click "sign up here". This opens up the following screen:
-
-
-
-Once you have created your account, click "Create" to create your own API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.walert`.
-
-
-
diff --git a/website/content/sdk/guides/intros/stocks/fundamental-analysis.md b/website/content/sdk/guides/intros/stocks/fundamental-analysis.md
index df5d206e115..4bc61b64506 100644
--- a/website/content/sdk/guides/intros/stocks/fundamental-analysis.md
+++ b/website/content/sdk/guides/intros/stocks/fundamental-analysis.md
@@ -11,7 +11,7 @@ The FA module provides programmatic access to the commands from within the OpenB
- Financial Modeling Prep
- Polygon
-View [this page](https://docs.openbb.co/terminal/guides/advanced/api-keys) for a list of all API sources used across the platform.
+View [this page](https://docs.openbb.co/terminal/quickstart/api-keys) for a list of all API sources used across the platform.
## How to Use
diff --git a/website/content/sdk/quickstart/api-keys.md b/website/content/sdk/quickstart/api-keys.md
new file mode 100644
index 00000000000..e9623d12af7
--- /dev/null
+++ b/website/content/sdk/quickstart/api-keys.md
@@ -0,0 +1,846 @@
+---
+title: Setting API Keys
+sidebar_position: 3
+description: API (Application Programming Interface) keys are access credentials for accessing data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address. Each key is entered into the OpenBB SDk from the `openbb.keys` module, using the syntax described below. The docstrings for each source will also display the expected inputs.
+keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, sdk]
+---
+## The Keys Module
+
+API (Application Programming Interface) keys are access credentials for obtaining data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer). Each source is entered into the SDK with the `openbb.keys` module, using the syntax described in the sections below. Wrapping the command with `help()` will print the docstrings to the screen. For example:
+
+```console
+help(openbb.keys.reddit)
+```
+
+Which prints:
+
+```console
+ Set Reddit key
+
+ Parameters
+ ----------
+ client_id: str
+ Client ID
+ client_secret: str
+ Client secret
+ password: str
+ User password
+ username: str
+ User username
+ useragent: str
+ User useragent
+ persist: bool, optional
+ If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
+ If True, api key change will be global, i.e. it will affect terminal environment variables.
+ By default, False.
+ show_output: bool, optional
+
+ Returns
+ -------
+ str
+ Status of key set
+
+ Examples
+ --------
+ >>> from openbb_terminal.sdk import openbb
+ >>> openbb.keys.reddit(
+ client_id="example_id",
+ client_secret="example_secret",
+ password="example_password",
+ username="example_username",
+ useragent="example_useragent"
+ )
+```
+
+A message similar to the one below will be printed when a function requesting data from an API is called but the key has not yet been entered.
+
+```console
+openbb.stocks.quote("AAPL")
+API_KEY_FINANCIALMODELINGPREP not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu.
+```
+
+The menu also provides a method for testing the validity of a key upon entry. It can be easy to copy & paste the string with a missing character; so, if the test fails, check that the values were correctly recorded with the command:
+
+```console
+openbb.keys.mykeys(show = True)
+```
+
+**We recommend gradually obtaining keys, when the use of a specific function requires it.**
+
+## Summary List
+
+Whale Alert
- -Go to https://docs.whale-alert.io/. You will be greeted with the following screen: - -
-
-Click "sign up here". This opens up the following screen:
-
-
-
-Once you have created your account, click "Create" to create your own API Key. Enter this API key into the OpenBB SDK by typing `openbb.keys.walert`.
-
-
-
+
+
+## Instructions by Source
+
+This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. Include, `persist = True` in the syntax to permanently store the key on the machine.
+
+### AlphaVantage
+
+Click to expand the list of data providers
+ +| Command | Name | URL | +| :------------ | :--------------------------------------- | :--------------------------------------------------------------------------------- | +| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | +| binance | Binance | https://binance.com | +| bitquery | Bitquery | https://bitquery.io/ | +| cmc | CoinMarketCap | https://coinmarketcap.com/api/ | +| coinbase | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | +| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | +| cpanic | Crypto Panic | https://cryptopanic.com/developers/api/ | +| databento | Databento | https://docs.databento.com/getting-started | +| degiro | DeGiro | https://www.degiro.com/ | +| eodhd | EODHD | https://eodhistoricaldata.com/r/?ref=869U7F4J | +| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | +| finnhub | Finnhub | https://finnhub.io/ | +| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | +| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | +| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | +| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | +| iex | IEX Cloud | https://iexcloud.io/ | +| intrinio | Intrinio | https://intrinio.com/ | +| messari | Messari | https://messari.io/api/docs | +| news | News API | https://newsapi.org/ | +| oanda | Oanda | https://developer.oanda.com | +| polygon | Polygon | https://polygon.io | +| quandl | Quandl | https://www.quandl.com | +| reddit | Reddit | https://www.reddit.com/wiki/api | +| rh | Robinhood | https://robinhood.com/us/en/ | +| santiment | Santiment | https://app.santiment.net/ | +| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk | +| smartstake | Smartstake | https://www.smartstake.io | +| stocksera | Stocksera | https://stocksera.pythonanywhere.com/ | +| tokenterminal | Token Terminal | https://tokenterminal.com/ | +| tradier | Tradier | https://documentation.tradier.com/ | +| twitter | Twitter | https://developer.twitter.com | +| walert | Whale Alert | https://docs.whale-alert.io/ | + +
+
+
+### Binance
+
+Go to: https://www.alphavantage.co/support/#api-key
+ +[AlphaVantage](https://www.alphavantage.co/support/#api-key) + + + +Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued key can be entered into the OpenBB SDK with: + +```console +openbb.keys.av(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Bitquery
+
+Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072
+ +[Binance](https://www.binance.com/en/support/faq/how-to-create-api-360002502072) + + + +These instructions should provide clear guidance for obtaining an API Key. Enter the issued credentials into the OpenBB SDK with: + +```console +openbb.keys.binance( + key = 'REPLACE_WITH_KEY', + secret = 'REPLACE_WITH_SECRET', + persist = True +) +``` + +
+
+
+### CoinMarketCap
+
+Go to: https://bitquery.io/
+ +[Bitquery](https://bitquery.io/) + + + +Click "Try GraphQL API", which opens the following screen: + + + +After creating an account and verifying the email address, get the value for the key by clicking on the "API Key" tab. + + + +Enter this API key into the OpenBB SDK with: + +```console +openbb.keys.bitquery(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Coinbase
+
+Go to: https://coinmarketcap.com/api
+ +[CoinMarketCap](https://coinmarketcap.com/api) + + + +Click on, "Get Your Free API Key Now", which opens to the page: + + + +Once the account has been created, copy the API key displayed within the dashboard. + + + +Enter the API key into the OpenBB SDK with: + +```console +openbb.keys.cmc(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Coinglass
+
+Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key
+ +[Coinbase](https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key) + + + +Follow the instructions to obtain the credentials for the specific account. Enter the three values into the OpenBB SDK with: + +```console +openbb.keys.coinbase( + key = 'REPLACE_WITH_KEY', + secret = 'REPLACE_WITH_SECRET', + passphrase = 'REPLACE_WITH_PASSPHRASE', + persist = True +) +``` + +
+
+
+### Crypto Panic
+
+Go to: https://www.coinglass.com/
+ +[Coinglass](https://www.coinglass.com/) + + + +Click, "Log in", and then sign up for an account. This opens the page: + + + +With the account created, find the assigned API key within the account profile page. Enter this value into the OpenBB SDK with: + +```console +openbb.keys.coinglass(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Databento
+
+Go to: https://cryptopanic.com/developers/api/
+ +[Crypto Panic](https://cryptopanic.com/developers/api/) + + + +Click on, ["Sign up"](https://cryptopanic.com/accounts/signup/?next=/developers/api/), and after creating, the API Key will be displayed on the documentation page, "Your free API auth token". + + + +Enter that value in the OpenBB SDK with: + +```console +openbb.keys.cpanic(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Degiro
+
+Go to: https://docs.databento.com/getting-started
+ +[Databento](https://docs.databento.com/getting-started) + + + +Click on, [Sign up](https://databento.com/signup), and after creating an account, the API key is found in the [account portal](https://databento.com/portal/keys). + + + +Enter this into the terminal with: + +```console +openbb.keys.databento(key = 'REPLACE_WITH_KEY') +``` + +
+
+
+### EODHD
+
+Go to: https://www.degiro.com/
+ +[Degiro](https://www.degiro.com/) + + + +Click on, "Open an account", and then go through the registration process. After setting up the account, the login credentials can be entered in the OpenBB SDK with: + +```console +openbb.keys.degiro( + username = 'USERNAME', + password = 'PASSWORD', + persist = True +) +``` + +Instructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-). + +
+
+
+### Finnhub
+
+Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J
+ +[EODHD](https://eodhistoricaldata.com/r/?ref=869U7F4J) + + + +Clicking on, "Registration", opens the page: + + + +Once registered, the API Key will be next to "API TOKEN". + + + +Enter this string into the OpenBB SDK with: + +```console +openbb.keys.eodhd(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Financial Modeling Prep
+
+Go to: https://finnhub.io/
+ +[Finnhub](https://finnhub.io/) + + + +Click on, "Get free api key", to open the page: + + + +Once the account has been created, find the API key in the account dashboard. + + + +Add this key to the OpenBB SDK with: + +```console +openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### FRED
+
+Go to: https://site.financialmodelingprep.com/developer/docs
+ +[FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) + + + +Click on, "Get my API KEY here", and sign up for a free account. + + + +With an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key. + + + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.fmp(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### GitHub
+
+Go to: https://fred.stlouisfed.org
+ +[FRED](https://fred.stlouisfed.org) + + + +Click on, "My Account", create a new account or sign in with Google: + + + +After completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key". + + + +Fill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued. + + + +Enter the API key into the OpenBB SDK with: + +```console +openbb.keys.fred(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Glassnode
+
+Go to: https://github.com
+ +[GitHub](https://github.com) + + + +Sign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings. + + + +Select, "New GitHub App": + + + +After creating the app, the key will be issued. Enter this token into the OpenBB SDK with: + +```console +openbb.keys.github(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### IEX Cloud
+
+Go to: https://studio.glassnode.com
+ +[Glassnode](https://studio.glassnode.com) + + + +Click on, "Sign up", and create an account: + + + +After creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key. + + + +Enter this key in the OpenBB SDK with: + +```console +openbb.keys.glassnode(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Intrinio
+
+Go to: https://iexcloud.io
+ +[IEX Cloud](https://iexcloud.io) + + + +Click on, "Sign in", and then create a new account. + + + +After signing up, select a plan. There is a choice for a free plan at the bottom. + + + +After completing the sign-up process, the API Keyis found under the, "Access & Security", tab. + + + +Add this API key to the OpenBB SDK with: + +```console +openbb.keys.iex(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Messari
+
+Go to: https://intrinio.com/starter-plan
+ +[Intrinio](https://intrinio.com/starter-plan) + + + +An API key will be issued with a subscription. Find the token value within the account dashboard, and enter it into the OpenBB SDK with: + +```console +openbb.keys.intrinio(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### News API
+
+Go to: https://messari.io
+ +[Messari](https://messari.io) + + + +Click on, "Sign up", and create an account. + + + +After creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access. + + + +Copy the API key and add it to the OpenBB SDK with: + +```console +openbb.keys.messari(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Oanda
+
+Go to: https://newsapi.org
+ +[News API](https://newsapi.org) + + + +Click on, "Get API Key", and fill out the form. + + + +Register for an account and the next screen will provide the API Key. + + + +Add this API key into the OpenBB SDK with: + +```console +openbb.keys.news(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Polygon
+
+Go to: https://developer.oanda.com
+ +[Oanda](https://developer.oanda.com) + + + +After creating an account, follow the steps below. + + + +Upon completion of the account setup, enter the credentials into the OpenBB SDK with: + +```console +openbb.keys.oanda( + account = 'REPLACE_WITH_ACCOUNT', + access_token = 'REPLACE_WITH_TOKEN', + account_type = 'REPLACE_WITH_LIVE_OR_PRACTICE', + persist = True +) +``` + +
+
+
+### Quandl
+
+Go to: https://polygon.io
+ +[Polygon](https://polygon.io) + + + +Click on, "Get your Free API Key". + + + +After signing up, the API Key is found at the bottom of the account dashboard page. + + + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.polygon(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Reddit
+
+Go to: https://www.quandl.com
+ +[Quandl](https://www.quandl.com) + + + +Click on, "Sign Up", and register a new account. + + + +Follow the sign-up instructions, and upon completion the API key will be assigned. + + + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.quandl(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Robinhood
+
+Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/
+ +[Reddit](https://old.reddit.com/prefs/apps/) + + + +Scroll down and click on "create application", selecting "script". + + + +Once the application is created, you must register it [here](https://old.reddit.com/wiki/api) + + + +Click on, "Read the full API terms and sign up for usage", and fill out the form. + + + +After submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/), add them to the OpenBB SDK with: + +```console +openbb.keys.reddit( + client_id = 'REPLACE_WITH_CLIENT_ID', + client_secret = 'REPLACE_WITH_CLIENT_SECRET', + username = 'REPLACE_WITH_REDDIT_USERNAME', + password = 'REPLACE_WITH_REDDIT_PASSWORD', + useragent = 'REPLACE_WITH_USER_AGENT', + persist = True +) +``` + +
+
+
+### Santiment
+
+Go to: https://robinhood.com/us/en
+ +[Robinhood](https://robinhood.com/us/en) + + + +After registering for an account, it can be added to the OpenBB SDK with: + +```console +openbb.keys.rb( + username = 'REPLACE_WITH_USERNAME', + password = 'REPLACE_WITH_PASSWORD', + persist = True +``` + +The first login will request 2FA authorization from the device connected to the account. + +
+
+
+### ShroomDK
+
+Go to: https://app.santiment.net
+ +[Santiment](https://app.santiment.net) + + + +Click on, "Sign up", and register for an account. + + + +Navigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key. + + + +Add it to the OpenBB SDK with: + +```console +openbb.keys.santiment(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Stocksera
+
+Go to: https://sdk.flipsidecrypto.xyz/shroomdk
+ +[ShroomDK](https://sdk.flipsidecrypto.xyz/shroomdk) + + + +Click "Mint Your ShroomDK API Key", and sign up for an account. + + + +Once created, connect a wallet to complete minting the NFT license. The API key will be displayed under the account. + + + +Enter it into the OpenBB SDK with: + +```console +openbb.keys.shroom(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Token Terminal
+
+Go to: https://stocksera.pythonanywhere.com
+ +[Stocksera](https://stocksera.pythonanywhere.com) + + + +Click on, "Log in", and create an account. + + + +Once logged in, navigate to the "Developers" tab and copy the API key. + + + +Add the key to the OpenBB SDK with: + +```console +openbb.keys.stocksera(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Tradier
+
+Go to: https://tokenterminal.com
+ +[Token Terminal](https://tokenterminal.com) + + + +Click on, "Log in" and sign up for an account. + + + +Verify the email address, and then navigate go to the "API" tab and copy the API key to the clipboard. + + + +Add the key to the OpenBB SDK with: + +```console +openbb.keys.tokenterminal(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Twitter
+
+Go to: https://documentation.tradier.com
+ +[Tradier](https://documentation.tradier.com) + + + +Click on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token, and enter this key into the OpenBB SDK with: + +```console +openbb.keys.tradier(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+
+
+### Whale Alert
+
+Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the features will continue to work.
+ + + +
+
diff --git a/website/content/sdk/quickstart/faq.md b/website/content/sdk/quickstart/faq.md
deleted file mode 100644
index fa1b184db0d..00000000000
--- a/website/content/sdk/quickstart/faq.md
+++ /dev/null
@@ -1,166 +0,0 @@
----
-title: FAQ
-sidebar_position: 3
-keywords: [faq, frequently asked questions, openbb sdk]
----
-
-## General
-
-Go to: https://docs.whale-alert.io
+ +[Whale Alert](https://docs.whale-alert.io) + + + +Click on, "sign up here". + + + +After creating the account, click on, "Create", to issue the API Key. + + + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.walert(key = 'REPLACE_WITH_KEY', persist = True) +``` + +How do I update the OpenBB SDK?
-- -With new releases of the OpenBB SDK, it would suffice to use `pip install openbb`. If this doesn't update to the latest version you can include the version number as follows `pip install openbb==2.0.0`. Please find the latest version [here](https://pypi.org/project/openbb/). - -
-Where does the data from the OpenBB SDK come from?
-- -The OpenBB platform does not provide any data itself as the platform is a data aggregator that connects to almost a hundred different data providers and APIs to access the data. - -
-What programs need to be allowed for Windows Firewall?
-- -When issues arise regarding Windows Firewall, please allow the following applications through (if not already): - -- BranchCache -- Hyper-V -- VcXsrv -- Windows Terminal - -From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. - -
-On what Operating Systems can I run OpenBB SDK?
-- -The OpenBB Terminal is compatible with Windows, Mac Os and Linux. Check the -[installation guide](/sdk/quickstart/installation) and [requirements outline](/sdk/quickstart/requirements) for more details. - -
-How much hard drive space is required?
-- -An installation will use approximately 4GB of space. - -
-How do I launch Jupyter Lab or Jupyter Notebook for use with the OpenBB SDK?
-- -Once the installation is finished via `pip` and you have activated the conda environment, as explained in the [installation guide](/sdk/quickstart/installation) you are able to activate a Jupyter Notebook by running `jupyter notebook` or Jupyter Lab with `jupyter lab`. Then, you should be able to use the OpenBB SDK by following along with the [How to use the SDK](/sdk/guides/basics#how-to-use-the-sdk) guide. - -
-How can I contribute to the OpenBB SDK
-- -There are three main ways of contributing to this project. - -**BECOME A CONTRIBUTOR** - -1. Fork the [Project](https://github.com/OpenBB-finance/OpenBBTerminal) -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Install the pre-commit hooks by running: `pre-commit install` - Any time you commit a change, linters will be run automatically. On changes, you will have to re-commit -4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -5. Push to your Branch (`git push origin feature/AmazingFeature`) -6. Open a Pull Request - -You can read more details about adding a feature in our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). - -**RAISE AN ISSUE OR REQUEST A FEATURE** - -- Raise an issue by opening a [bug ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues). -- Request a new feature through a [feature request ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues). - -
-How do I report a bug?
-- -First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) - -
-How can I get help with OpenBB SDK?
-- -You can get help with OpenBB SDK by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). - -
-How can I give feedback about the OpenBB SDK?
-- -Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model. - -You can contact us via the following routes: - -- If you notice that a feature is missing inside the terminal, please fill in the Request a Feature form. -- If you wish to report a bug, have a question/suggestion or anything else, please fill in the Support form. -- If you wish to speak to us directly, please contact us via Discord. - -
-What kind of architectural pattern does the OpenBB SDK use?
-- -Throughout the entire OpenBB Platform, the [Model-view-controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) architectural pattern is used for creating functionality in the terminal. - -This is visible in the OpenBB SDK with the addition of `_chart` within functions relating to the `view` portfion of the pattern. - -For example the model is displayed with: - -``` -openbb.economy.ycrv() -``` - -| | Maturity | Rate | -| --: | --------: | ---: | -| 0 | 0.0833333 | 3.93 | -| 1 | 0.25 | 4.34 | -| 2 | 0.5 | 4.61 | -| ... | ... | ... | -| 8 | 10 | 3.82 | -| 9 | 20 | 4.13 | -| 10 | 30 | 3.92 | - -And the view with: - -``` -openbb.economy.ycrv_chart() -``` - - - -
-Why is data from today missing when I use the load function?
-- -By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. - -
-Follow along with the instructions of the video or use the steps below to use the OpenBB SDK:
+## 1. System Preparation - +Prepare the system by installing the following items: -### 1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)** +### 1.1 Install Miniconda - Download the `x86_64` Miniconda for your respective system and follow along - with it's installation instructions. The Miniconda architecture MUST be - `x86_64` in order to use certain features. +[Install Miniconda](https://docs.conda.io/en/latest/miniconda.html) -### 2. **Create the virtual environment** +Miniconda is a Python environment and package manager. It is required for installing certain dependencies. + +- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: + + - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) + - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) + - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) + - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) + - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) + + **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` + + **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + +### 1.2 Install CMake + +**CMake is required by several Python modules.** + +**For Windows:** + +CMake is installed as a part of Microsoft C++ Build Tools. Skip ahead to the next step. + +**For MacOS:** + +Check if homebrew is installed by running `brew --version` + +If Homebrew is not installed, run: ```bash -conda create -n obb python=3.9.6 -y +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +brew install cmake +brew install gcc ``` -### 3. **Activate the virtual environment** +If Homebrew is already installed: ```bash +brew install cmake +brew install gcc +``` + +**For Linux:** + +```bash +sudo apt update && sudo apt upgrade +sudo apt install -y gcc cmake +``` + +## 2. Create Python Environment + +The first step is to create the virtual Python environment. + +### 2.1 Confirm Conda Base + +When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: + +```console +conda env list +``` + +Copy the path which corresponds with `base`, and activate it with: + +```console +conda activate REPLACE_WITH_PATH +``` + +Check which `conda` version is installed by entering: + +```console +conda -V +``` + +As of writing, the most recent version of `Conda` is, `23.1.0`. If required, update from a lower version with: + +```console +conda install -c conda-forge -n base conda=23.1.0 +``` + +### 2.2 Create the Environment + +Create the environment by copying the code below into the command line: + +```console +conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry +``` + +### 2.3 Activate the Environment + +After the packages from Step 2 install, activate the newly created environment by entering: + +```console conda activate obb ``` -### 4. **Install OpenBB SDK Core package** +## 3. Install the OpenBB SDK + +### 3A. Install From PyPi ```bash -pip install openbb +pip install openbb[all] ``` -### 5. **(Optional) Install the Toolkits** +Done! The OpenBB SDK can now be imported to any Python session with the line of code below. -#### 5.1 **If you would like to use the Portfolio Optimization features** - -:::note NOTE -If on Apple Silicon Macs (M1/M2) you will need to install dependency from conda-forge first -```bash -conda install -c conda-forge cvxpy=1.2.2 -y +```console +from openbb_terminal.sdk import openbb ``` -::: +The [OpenBB Terminal](https://docs.openbb.co/terminal) is part of the installation, and the application can be launched from the command line by entering: -Install the Portfolio Optimization Toolkit +```console +openbb +``` + +### 3B. Install via Git Clone + +#### 3B.1 Clone the Project + +Cloning the GitHub repo will download the source code to the current working directory. + +```console +git clone https://github.com/OpenBB-finance/OpenBBTerminal.git +``` + +#### 3B.2 CD into OpenBBTerminal + +```console +cd OpenBBTerminal +``` + +#### 3B.3 Install Remaining Packages ```bash -pip install "openbb[optimization]" +pip install qdldl==0.1.5.post3 +poetry install -E all ``` -#### 5.2 **If you would like ML Forecasting features** +Done! The OpenBB SDK can now be imported to any Python session with the line of code below. -:::note NOTE -If on Apple Silicon Macs (M1/M2) you will need to install the dependency from conda-forge first -```bash -conda install -c conda-forge lightgbm=3.3.3 -y -``` -::: - -Install the Forecasting Toolkit - -```bash -pip install "openbb[forecast]" +```console +from openbb_terminal.sdk import openbb ``` -#### 5.3 **If you would like to use both Portfolio Optimization and ML forecast features** +The Terminal application is also installed, and it can be launched from the command line at the root `OpenBBTerminal` folder with: -:::note NOTE -If on Apple Silicon Macs (M1/M2) you will need to install the dependencies from conda-forge first -```bash -conda install -c conda-forge lightgbm=3.3.3 cvxpy=1.2.2 -y -``` -::: - -Install all Toolkits - -```bash -pip install "openbb[all]" +```console +python terminal.py ``` -Congratulations! You have successfully installed `openbb` on an environment and are now able to begin using it. However, it is important to note that if you close out of your CLI you must re-activate your environment in order begin using it again. This can be done with the following: +## Updating the OpenBB SDK Version -```bash -conda activate obb +Use the code below to check the version number of the OpenBB SDK. + +```python +from openbb_terminal.sdk import openbb +openbb.__version__ ``` -The OpenBB SDK can be imported to a Jupyter Notebook or any code editor with, `from openbb_terminal.sdk import openbb` as explained in the [How to use the SDK](https://docs.openbb.co/sdk/guides/basics) guides. By following the above process, the [OpenBB Terminal](https://docs.openbb.co/terminal) is automatically included as well which can be ran by typing `openbb`. +Which prints a string similar to: `'2.4.1'` +### A. Updating a PyPi Installation + +To upgrade the OpenBB SDK to the latest version, with the `obb` Python environment active, enter: + +```console +pip install -U openbb[all] +``` + +### B. Updating a Git Clone Installation + +#### B.1 Fetch changes to the code + +With the `obb` Python environment activated, navigate into the root folder of the cloned project. Then, pull the changes from GitHub: + +```console +git fetch +git pull +``` + +**Note:** If working from a forked repo, the `git pull` command will need to be adjusted to pull from the desired branch, like `origin` or `upstream`. For example, `git pull origin main`; `git pull origin develop` + +#### B.2 Run Poetry Install + +Update any changes to the dependencies by running: + +```console +poetry install -E all +``` diff --git a/website/content/sdk/quickstart/requirements.md b/website/content/sdk/quickstart/requirements.md index d3de45ef443..501fa4f1154 100644 --- a/website/content/sdk/quickstart/requirements.md +++ b/website/content/sdk/quickstart/requirements.md @@ -1,69 +1,30 @@ --- title: Requirements sidebar_position: 1 -description: The OpenBB SDK can be directly installed on your computer via our installation instructions, these are the requirements. -keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, requirements, openbb sdk] +description: General system requirements for installing the OpenBB SDK. +keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, requirements, openbb, sdk, system] --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The OpenBB SDK is a set of tools for financial and data analysis. The purpose of this page is to outline some of the background information required to get the most out of the software. +Installation of the OpenBB Terminal requires downloading around 4GB of data. Querying data (by running commands) does not require a lot of bandwidth but you will certainly have a more pleasant experience if you are on a fast internet connection. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services. -### Minimum System Requirements +## Minimum System Requirements +- A modern CPU compatible with the Intel Math Kernel Library, supporting SSE3 & SSE4.2 instructions. +- Windows 10 or higher. +- MacOS Monterey or higher, with Rosetta installed. +- Check the Ubuntu hardware certified hardware page [here](https://ubuntu.com/certified?q=&limit=20&category=Desktop&category=Laptop). - 4GB RAM or more - 5GB free storage -- A code editor or Jupyter Notebook - Internet connection -Note that installation of the SDK with all the toolkits would require downloading around 4GB of data. Querying data does not require a lot of bandwidth but you will certainly have a more pleasant experience if you will be on a fast internet line. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services. - -:::info OS Specific Requirements - -
-
-
The OpenBB platform requires MacOS Catalina or higher. The oldest Mac configuration known to work is a MacPro 3,1 (OS Catalina) and functions relying on the Intel Math Kernel (Forecast models like RNN) are not compatible with the CPU.
-Portfolio Optimization Toolkit and Forecasting Toolkit on Apple Silicon: To install the Forecasting toolkit on M1/M2 macs you need to use the x86_64 version of conda and install certain dependencies from conda-forge. Further Instructions can be found in the Installation section
-
-
-
-
-
-
-
Windows 10 or higher is required. - -
-
-
-
-
-
-
The OpenBB platform can be installed on a variety of Linux distributions. Due to the large number of system configuration variables, we are unable to verify compatibility across all distributions. It is known to work with up-do-date versions of Ubuntu, Debian and Raspberry Pi. Any 32-bit distributions are incompatible. Generally, if the system installs Miniconda3 then the OpenBB Terminal should also be installable. -
-
-
-
-Do I have to use Miniconda?
+ +There are certain dependencies which are sourced exclusively from the `conda-forge` directory. Other virtual environment managers, such a `venv`, may not solve the environment properly, resulting in failed package installations or incorrect builds. We highly recommend using Miniconda as the Python virtual environment manager for installing the OpenBB SDK. + +How do I update my installation to the latest version?
+ +The code is constantly being updated with new features and bug fixes. The process for updating will vary by the installation type: + +- For a `pip` installation, when a new version is published: `pip install -U openbb[all]` +- Upgrade a cloned version of the GitHub repo with: + +```console +git fetch +git pull +poetry install -E all +``` + +**Notes:** If the cloned repository is a fork, pull from: `git pull origin main`, or, `git pull origin develop`. If there are changes locally to the files that conflict with the incoming changes from GitHub, stash them before pulling from main with `git stash`. + +"Microsoft Visual C++ 14.0 or greater is required"
+ +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. + +Error: failed building wheel for bt
+ +There may be an additional message that is printed from this error, stating: "Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools". + +Download and install it. [https://visualstudio.microsoft.com/visual-cpp-build-tools/](https://visualstudio.microsoft.com/visual-cpp-build-tools/) + +Mac and Linux users may also encounter a similar error because a C++ compiler is not installed. Install Homebrew: + +```console +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` + +Then run: + +```console +brew install gcc +brew install cmake +``` + +Additionally, Mac users should install Rosetta: + +```console +softwareupdate --install-rosetta +``` + +Miniconda3 will not install on ARM/Linux Raspberry Pi machines.
+ +Refer to this issue on the Conda [GitHub](https://github.com/conda/conda/issues/10723) page. + +ModuleNotFoundError: No module named '______'
+ +Before troubleshooting please verify that the recommended installation instructions were followed. These errors often can occur when the virtual environment has not been activated, or the `poetry install` command was skipped. Activate the OpenBB virtual environment created during the installation process prior to launching or importing the SDK. + +**Terminal**: + +```console +conda activate obb +python terminal.py +``` + +**SDK**: + +```console +conda activate obb +ipython +from openbb_terminal.sdk import openbb +``` + +**Jupyter**: + +Check that the kernel selected for the session is the OpenBB virtual environment created during the installation process and then re-run the cell. + +```console +from openbb_terminal.sdk import openbb +``` + +There is also a possibility that a new dependency has been added to the code and it has not yet been installed in the environment. This may happen after updating the code from GitHub, but before running the `poetry install` install command. + +```console +poetry install -E all +``` + +SSL certificates fail to authorize
+ +```console +SSL: CERTIFICATE_VERIFY_FAILED +``` + +An error message, similar to above, is usually encountered while attempting to use the OpenBB Platform from behind a firewall. A workplace environment is typically the most common occurrence. Try connecting to the internet directly through a home network to test the connection. If using a work computer and/or network, we recommend speaking with the company's IT department prior to installing or running any software. + +A potential solution is to try: + +```console +pip install pip-system-certs +``` + +Cannot connect due to proxy connection.
+ +Find the `.env` file (located at the root of the user account folder: (`~/.openbb_terminal/.env`), and add a line at the bottom of the file with: + +```console +HTTP_PROXY="" or HTTPS_PROXY="” +``` + +## General Operation + +What is the correct format for entering dates to function variables?
+ +Dates should be entered as a string variable, inside of quotation marks, formatted as `%Y-%m-%d` - YYYY-MM-DD. + +Does the portfolio menu allow for dividends, interest, or other distributions?
+ +Currently, this is only possible by manually updating the portfolio file. + +Why does my Portfolio file fail to load?
+ +This can be the result of a formatting error, check the file in a simple text editor to observe any abnormalities in the formatting; or, it could be a bug - check the [GitHub issues page](https://github.com/OpenBB-finance/OpenBBTerminal/issues) for similar errors. + +- Check that all the necessary column titles are present. +- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values. +- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu. +- Format ticker symbols according to yFinance naming convention. +- All dates must be entered as YYYY-MM-DD. +- Transactions dated for today will fail to load historical data. +- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving. + +Files can be formatted as either `.csv` or `.xlsx` files, and the required column headers are: + +`[Date,Type,Ticker,Side,Price,Quantity,Fees,Investment,Currency,Sector,Industry,Country,Region]` + +See the guide [here](https://docs.openbb.co/sdk/guides/intros/portfolio) for more information. + +How do I change the chart styles?
+ +Place style sheets in this folder: `OpenBBUserData/styles/user` + +To select the light themes: + +```python +from openbb_terminal.sdk import TerminalStyle +theme = TerminalStyle("light", "light", "light") +``` + +To select the dark themes: + +```python +from openbb_terminal.sdk import TerminalStyle +theme = TerminalStyle("dark", "dark", "dark") +``` + +Where are the included stock screener presets located?
+ +The files are located in the folder with the code, under: + +`~/openbb_terminal/miscellaneous/stocks/screener` + +Alternatively, the source code on GitHub is [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/stocks/screener) + +Data from today is missing.
+ +By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. + +```console +df = openbb.stocks.load(SPY, interval = 60) +``` + +Can I stream live prices and news feeds?
+ +It is not currently possible to stream live feeds with the OpenBB SDK. + +"Pair BTC/USDT not found in binance"
+ +US-based users are currently unable to access the Binance API. Please try loading the pair from a different source, for example: + +`load btc --source CCXT --exchange kraken` + +Why does a specific menu or command not exist?
+ +It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release. + +Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support). + +How often are patches for bugs released?
+ +The installer versions are packaged approximately every two-weeks. Those working with a cloned GitHub version can checkout the Develop branch to get the latest fixes and releases before they are pushed to the main branch. + +```console +git checkout develop +``` + +How do I report a bug?
+ +First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) + +How can I get help with OpenBB Terminal?
+ +You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). + +How can I give feedback about the OpenBB Terminal, or request specific functionality?
+ +Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model. + +You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`). + +Alternatively, you can contact us via the following routes: + +- If you notice that a feature is missing inside the terminal, please fill in the [Request a Feature](https://openbb.co/request-a-feature) form. +- If you wish to report a bug, have a question/suggestion or anything else, please fill in the [Support](https://openbb.co/support) form. +- If you wish to speak to us directly, please contact us on [Discord](https://openbb.co/discord). + +Error: "git pull" fails because of a hot fix: cannot lock ref
+ +If the error message looks something like: + +```console +cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create +``` + +Try: + +```console +git remote prune origin +git pull +``` + +What does it mean if it says wheel is missing?
+ +If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing. + +`conda install -c conda-forge wheel` or `pip install wheel` + +Why do these .whl files not exist?
+ +If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder. +Just removing the 'artifacts' folder could also be enough: + +| Platform | Location | +| -------- | ------------------------------- | +| Linux | "~/.cache/pypoetry" | +| Mac | "~/Library/Caches/pypoetry" | +| Windows | "%localappdata%/pypoetry/cache" | + +When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the +'artifacts' folder again to reinitialize Poetry. + +If you run into trouble with Poetry, and the advice above did not help, your best bet is to try + +- `poetry update --lock` +- `conda deactivate` -> `conda activate obb`, then try again +- Track down the offensive package and purge it from your anaconda `What does the JSONDecodeError mean during poetry install?
+ +Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process. + +```bash +poetry config experimental.new-installer false +``` + +_Commands that may help you in case of an error:_ + +- `python -m pip install --upgrade pip` +- `poetry update --lock` +- `poetry install` + +How do I deal with errors regarding CRLF?
+ +When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to +CRLF (default for Windows). +This is because the entire package uses LF (default for Linux/Mac), and it is therefore +important that you change this setting to LF _before_ you make any changes to the code. + +It is possible that CRLF automatically turns back on, you can correct this with: + +```bash +git config --global core.autocrlf false +``` + +In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with +the following: + +```bash +git rm --cached -r . +git reset --hard +``` + +Why can't I run OpenBB via the VS Code integrated terminal?
+ +This occurs when VS Code terminal python version/path is different from the terminal version. + +To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)): + +```bash + "terminal.integrated.inheritEnv": false, +``` + +
-
-Within this menu you are able to set your API keys to access the commands that require that key. You can do so by typing the command followed by the API key, for example: `fred a215egade08a8d47cfd49c849658a2be`. When you press `ENTER` (⏎) the terminal will test whether this API key works. If it does, you receive the message `defined, test passed` and if it does not, you receive the message `defined, test failed`.
-
-To figure out where you can obtain the API key, you can enter the command (e.g. `av`) and press `ENTER` (⏎) or use the table below. We also provide an elaborate explanation where to find the API key in the next section. **We recommend that you gradually obtain and set keys whenever you wish to use features that require an API key. For example, if you are interested in viewing recent news about a company, you should set the API key from the 'News API'.**
-
-
-
-
-## How to obtain the API Key from each source
-
-This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided.
-
-Summary of API Key Providers
- -| Command | Name | URL | -| :------------ | :--------------------------------------- | :--------------------------------------------------------------------------------- | -| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | -| binance | Binance | https://binance.com | -| bitquery | Bitquery | https://bitquery.io/ | -| cmc | CoinMarketCap | https://coinmarketcap.com/api/ | -| cb | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | -| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | -| cpanic | Crypto Panic | https://cryptopanic.com/developers/api/ | -| degiro | DeGiro | https://www.degiro.com/ | -| eodhd | EODHD | https://eodhistoricaldata.com/r/?ref=869U7F4J | -| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | -| finnhub | Finnhub | https://finnhub.io/ | -| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | -| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | -| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | -| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | -| messari | Messari | https://messari.io/api/docs | -| news | News API | https://newsapi.org/ | -| oanda | Oanda | https://developer.oanda.com | -| polygon | Polygon | https://polygon.io | -| quandl | Quandl | https://www.quandl.com | -| reddit | Reddit | https://www.reddit.com/wiki/api | -| rh | Robinhood | https://robinhood.com/us/en/ | -| santiment | Santiment | https://app.santiment.net/ | -| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk | -| smartstake | Smartstake | https://www.smartstake.io | -| stocksera | Stocksera | https://stocksera.pythonanywhere.com/ | -| tokenterminal | Token Terminal | https://tokenterminal.com/ | -| tradier | Tradier | https://documentation.tradier.com/ | -| twitter | Twitter | https://developer.twitter.com | -| si | Sentiment Investor | https://sentimentinvestor.com | -| walert | Whale Alert | https://docs.whale-alert.io/ | - -
-
-
-Once you enter the type of investor you are, the organization you work at and your email address pressing "GET FREE API KEY" gets you the key that you can submit into the OpenBB Terminal with `/keys/av KEY`
-
-
-
-AlphaVantage
- -Go to https://www.alphavantage.co/support/#api-key You will be greeted with the following screen: - -
-
-Once you enter the type of investor you are, the organization you work at and your email address pressing "GET FREE API KEY" gets you the key that you can submit into the OpenBB Terminal with `/keys/av KEY`
-
-
-
-
-These instructions should provide clear guidance how to set up an API Key. Enter this API key into the OpenBB Terminal by typing `/keys/binance -k KEY -s SECRET`.
-
-
-
-Binance
- -Go to https://www.binance.com/en/support/faq/how-to-create-api-360002502072 You will be greeted with the following screen: - -
-
-These instructions should provide clear guidance how to set up an API Key. Enter this API key into the OpenBB Terminal by typing `/keys/binance -k KEY -s SECRET`.
-
-
-
-
-Click "Try GraphQL API". This opens the following screen:
-
-
-
-After creating an account and verifying your email address, you will be able to access your API Key by clicking "Api Key". Enter this API key into the OpenBB Terminal by typing `/keys/bitquery KEY`.
-
-
-
-
-
-Bitquery
- -Go to https://bitquery.io/ You will be greeted with the following screen: - -
-
-Click "Try GraphQL API". This opens the following screen:
-
-
-
-After creating an account and verifying your email address, you will be able to access your API Key by clicking "Api Key". Enter this API key into the OpenBB Terminal by typing `/keys/bitquery KEY`.
-
-
-
-
-
-
-From here, click "Get Your Free API Key Now". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB Terminal by typing `/keys/cmc KEY`
-
-
-
-
-
-CoinMarketCap
- -Go to https://coinmarketcap.com/api You will be greeted with the following screen: - -
-
-From here, click "Get Your Free API Key Now". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB Terminal by typing `/keys/cmc KEY`
-
-
-
-
-
-
-By following these instructions you should be able to set-up an API Key. Enter this API key into the OpenBB Terminal by typing `/keys/coinbase -k KEY -s SECRET -p PASSPHRASE`.
-
-
-
-CoinBase
- -Go to https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key You will be greeted with the following screen: - -
-
-By following these instructions you should be able to set-up an API Key. Enter this API key into the OpenBB Terminal by typing `/keys/coinbase -k KEY -s SECRET -p PASSPHRASE`.
-
-
-
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you created your account, you will be able to find the API Key on your profile. Enter this API key into the OpenBB Terminal by typing `/keys/coinglass KEY`.
-
-
-
-Coinglass
- -Go to https://www.coinglass.com/ You will be greeted with the following screen: - -
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you created your account, you will be able to find the API Key on your profile. Enter this API key into the OpenBB Terminal by typing `/keys/coinglass KEY`.
-
-
-
-
-Click "Sign up" under "Your free API auth token". This opens up the following screen:
-
-
-
-Once you have created your account, your API Key will be displayed under "Your free API auth token". Enter this API key into the OpenBB Terminal by typing `/keys/cpanic KEY`.
-
-
-
-
-
-Crypto Panic
- -Go to https://cryptopanic.com/developers/api/ You will be greeted with the following screen: - -
-
-Click "Sign up" under "Your free API auth token". This opens up the following screen:
-
-
-
-Once you have created your account, your API Key will be displayed under "Your free API auth token". Enter this API key into the OpenBB Terminal by typing `/keys/cpanic KEY`.
-
-
-
-
-
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/degiro -u USERNAME -p PASSWORD`. We also support 2FA, you can find more information about that [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-).
-
-
-
-DeGiro
- -Go to https://www.degiro.com/ You will be greeted with the following screen: - -
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/degiro -u USERNAME -p PASSWORD`. We also support 2FA, you can find more information about that [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-).
-
-
-
-
-Click "Registration". This opens up the following screen:
-
-
-
-Once you have registered, you can find the API Key next to "API TOKEN". Enter this API key into the OpenBB Terminal by typing `/keys/eodhd KEY`.
-
-
-
-
-
-EODHD
- -Go to https://eodhistoricaldata.com/r/?ref=869U7F4J You will be greeted with the following screen: - -
-
-Click "Registration". This opens up the following screen:
-
-
-
-Once you have registered, you can find the API Key next to "API TOKEN". Enter this API key into the OpenBB Terminal by typing `/keys/eodhd KEY`.
-
-
-
-
-
-
-Press "Get free api key". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB Terminal by typing `/keys/finnhub KEY`
-
-
-
-
-
-Finnhub
- -Go to https://finnhub.io/ You will be greeted with the following screen: - -
-
-Press "Get free api key". This opens up the following screen:
-
-
-
-Once you have created an account, you will be able to find your API key in the following screen. Enter this API key into the OpenBB Terminal by typing `/keys/finnhub KEY`
-
-
-
-
-
-
-From here, press "Get my API KEY here". This opens up the following screen:
-
-
-
-If you already have an account, you can sign-in directly and obtain the API key, otherwise click "Sign Up". Once you have created an account you can access your API Key by pressing the "Dashboard" button which will show the API key. Enter this API key into the OpenBB Terminal by typing `/keys/fmp KEY`
-
-
-
-
-
-Financial Modelling Prep
- -Go to https://site.financialmodelingprep.com/developer/docs You will be greeted with the following screen: - -
-
-From here, press "Get my API KEY here". This opens up the following screen:
-
-
-
-If you already have an account, you can sign-in directly and obtain the API key, otherwise click "Sign Up". Once you have created an account you can access your API Key by pressing the "Dashboard" button which will show the API key. Enter this API key into the OpenBB Terminal by typing `/keys/fmp KEY`
-
-
-
-
-
-
-Click on "My Account". This opens up the following screen:
-
-
-
-Once you have signed up, go to "My Account" and select "API Keys". This will get you to the following screen:
-
-
-
-Click on "Request API Key" and fill in information about why you wish to use FRED. Then, by pressing "Request API key" you will be able to obtain the API key. Enter this API key into the OpenBB Terminal by typing `/keys/fred KEY`
-
-
-
-
-
-FRED
- -Go to https://fred.stlouisfed.org You will be greeted with the following screen: - -
-
-Click on "My Account". This opens up the following screen:
-
-
-
-Once you have signed up, go to "My Account" and select "API Keys". This will get you to the following screen:
-
-
-
-Click on "Request API Key" and fill in information about why you wish to use FRED. Then, by pressing "Request API key" you will be able to obtain the API key. Enter this API key into the OpenBB Terminal by typing `/keys/fred KEY`
-
-
-
-
-
-
-Click "Sign up" and create an account with GitHub. Once you have done so go to as depicted below: https://github.com/settings/apps
-
-
-
-Press "New GitHub App". This opens up the following screen:
-
-
-
-Once the app is created you are able to obtain the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/github KEY`.
-
-
-
-GitHub
- -Go to https://github.com You will be greeted with the following screen: - -
-
-Click "Sign up" and create an account with GitHub. Once you have done so go to as depicted below: https://github.com/settings/apps
-
-
-
-Press "New GitHub App". This opens up the following screen:
-
-
-
-Once the app is created you are able to obtain the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/github KEY`.
-
-
-
-
-Click on "Sign up". This opens up the following screen:
-
-
-
-After you have created your account, go to https://studio.glassnode.com/settings/api where you can create your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/glassnode KEY`.
-
-
-
-
-
-Glassnode
- -Go to https://studio.glassnode.com You will be greeted with the following screen: - -
-
-Click on "Sign up". This opens up the following screen:
-
-
-
-After you have created your account, go to https://studio.glassnode.com/settings/api where you can create your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/glassnode KEY`.
-
-
-
-
-
-
-Press "Sign up". This opens up the following screen:
-
-
-
-Once you have signed up, go to https://messari.io/account/api where you will be able to find your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/messari KEY`.
-
-
-
-
-
-Messari
- -Go to https://messari.io You will be greeted with the following screen: - -
-
-Press "Sign up". This opens up the following screen:
-
-
-
-Once you have signed up, go to https://messari.io/account/api where you will be able to find your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/messari KEY`.
-
-
-
-
-
-
-Press "Get API Key". This opens up the following screen:
-
-
-
-Register for an account. The next screen will provide you with the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/news KEY`
-
-
-
-
-
-News API
- -Go to https://newsapi.org You will be greeted with the following screen: - -
-
-Press "Get API Key". This opens up the following screen:
-
-
-
-Register for an account. The next screen will provide you with the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/news KEY`
-
-
-
-
-
-
-After you have created an account with Oanda, you will be able to find the API key by following the steps below. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/oanda -a ACCOUNT -t TOKEN`.
-
-
-
-
-
-Oanda
- -Go to https://developer.oanda.com You will be greeted with the following screen: - -
-
-After you have created an account with Oanda, you will be able to find the API key by following the steps below. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/oanda -a ACCOUNT -t TOKEN`.
-
-
-
-
-
-
-Press the button "Get your Free API Key". This opens up the following screen:
-
-
-
-Once signed up you will find the API Key at the bottom. Enter this API key into the OpenBB Terminal by typing `/keys/polygon KEY`
-
-
-
-
-
-Polygon
- -Go to https://polygon.io You will be greeted with the following screen: - -
-
-Press the button "Get your Free API Key". This opens up the following screen:
-
-
-
-Once signed up you will find the API Key at the bottom. Enter this API key into the OpenBB Terminal by typing `/keys/polygon KEY`
-
-
-
-
-
-
-From here, click "Sign Up" at the top. This opens up the following screen:
-
-
-
-Follow the sign-up instructions and once you have signed up you will be able to retrieve your API key. Enter this API key into the OpenBB Terminal by typing `/keys/quandl KEY`
-
-
-
-
-
-Quandl
- -Go to https://www.quandl.com You will be greeted with the following screen: - -
-
-From here, click "Sign Up" at the top. This opens up the following screen:
-
-
-
-Follow the sign-up instructions and once you have signed up you will be able to retrieve your API key. Enter this API key into the OpenBB Terminal by typing `/keys/quandl KEY`
-
-
-
-
-Reddit
- -Go to https://www.reddit.com/wiki/api You will be greeted with the following screen: - -
-
-Press "Read the full API terms and sign up for usage" and start the sign-up process. This opens up the following screen:
-
-
-
-Once you have filled out everything, you will receive an email when your application is approved. Once this is approved you will receive the necessary information that needs to be entered in the OpenBB Terminal. Enter these into the OpenBB Terminal by typing `/keys/reddit -i CLIENT_ID -s CLIENT_SECRET -u USERNAME -p PASSWORD -a USER_AGENT`.
-
-
-
-
-
-Press "Read the full API terms and sign up for usage" and start the sign-up process. This opens up the following screen:
-
-
-
-Once you have filled out everything, you will receive an email when your application is approved. Once this is approved you will receive the necessary information that needs to be entered in the OpenBB Terminal. Enter these into the OpenBB Terminal by typing `/keys/reddit -i CLIENT_ID -s CLIENT_SECRET -u USERNAME -p PASSWORD -a USER_AGENT`.
-
-
-
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/rb -u USERNAME -p PASSWORD`.
-
-
-
-Robinhood
- -Go to https://robinhood.com/us/en You will be greeted with the following screen: - -
-
-Click "Sign up" and go to the registrations process. After setting up your account you will be able to use this broker by entering your username and password in the OpenBB Terminal as follows `/keys/rb -u USERNAME -p PASSWORD`.
-
-
-
-
-Click "Sign up". This opens up the following screen:
-
-
-
-After creating an account go to https://app.santiment.net/account#api-keys and generate a key. Enter this API key into the OpenBB Terminal by typing `/keys/santiment KEY`.
-
-
-
-
-
-Santiment
- -Go to https://app.santiment.net You will be greeted with the following screen: - -
-
-Click "Sign up". This opens up the following screen:
-
-
-
-After creating an account go to https://app.santiment.net/account#api-keys and generate a key. Enter this API key into the OpenBB Terminal by typing `/keys/santiment KEY`.
-
-
-
-
-
-
-Click "Mint Your ShroomDK API Key" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have your account created, connect a wallet and access the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/shroom KEY`.
-
-
-
-
-
-ShroomDK
- -Go to https://sdk.flipsidecrypto.xyz/shroomdk You will be greeted with the following screen: - -
-
-Click "Mint Your ShroomDK API Key" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have your account created, connect a wallet and access the API Key. Enter this API key into the OpenBB Terminal by typing `/keys/shroom KEY`.
-
-
-
-
-
-
-Click "Log in" and create an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "Developers" to access your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/stocksera KEY`.
-
-
-
-
-
-Stocksera
- -Go to https://stocksera.pythonanywhere.com You will be greeted with the following screen: - -
-
-Click "Log in" and create an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "Developers" to access your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/stocksera KEY`.
-
-
-
-
-
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "API" to access your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/tokenterminal KEY`.
-
-
-
-
-
-Token Terminal
- -Go to https://tokenterminal.com You will be greeted with the following screen: - -
-
-Click "Log in" and sign up for an account. This opens up the following screen:
-
-
-
-Once you have created an account, go to "API" to access your API Key. Enter this API key into the OpenBB Terminal by typing `/keys/tokenterminal KEY`.
-
-
-
-
-
-
-Click the button "Open Account" and start the sign-up process. Once you have gone through the whole process you will be able to find your API key within your account. Enter this API key into the OpenBB Terminal by typing `/keys/tradier KEY`
-
-
-
-Tradier
- -Go to https://documentation.tradier.com You will be greeted with the following screen: - -
-
-Click the button "Open Account" and start the sign-up process. Once you have gone through the whole process you will be able to find your API key within your account. Enter this API key into the OpenBB Terminal by typing `/keys/tradier KEY`
-
-
-Twitter
- -Go to https://developer.twitter.com You will be greeted with the following screen: - -
-
-Click "Sign Up". Note that you are required to have a Twitter account and that you have verified your phone number. This opens up the following screen:
-
-
-
-Create an account and verify your email. Then, you will be able to create an app to obtain your API Key.
-
-
-
-This will give you the following keys. Enter these into the OpenBB Terminal by typing `/keys/twitter -k API_KEY -s API_KEY_SECRET -t BEARER_TOKEN`.
-
-
-
-
-
-
-
-Click "Sign Up". Note that you are required to have a Twitter account and that you have verified your phone number. This opens up the following screen:
-
-
-
-Create an account and verify your email. Then, you will be able to create an app to obtain your API Key.
-
-
-
-This will give you the following keys. Enter these into the OpenBB Terminal by typing `/keys/twitter -k API_KEY -s API_KEY_SECRET -t BEARER_TOKEN`.
-
-
-
-
-
-
-Click "sign up here". This opens up the following screen:
-
-
-
-Once you have created your account, click "Create" to create your own API Key. Enter this API key into the OpenBB Terminal by typing `/keys/walert KEY`.
-
-
-
-
diff --git a/website/content/terminal/guides/advanced/data.md b/website/content/terminal/guides/advanced/data.md
index 0e6c06d2cda..de944be9170 100644
--- a/website/content/terminal/guides/advanced/data.md
+++ b/website/content/terminal/guides/advanced/data.md
@@ -1,100 +1,132 @@
---
title: Importing and Exporting Data
sidebar_position: 3
-description: The OpenBBUserData folder's default location is the home of the system user account. By default this will be the following paths. Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in OpenBBUserData/portfolio/holdings.
-keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, where is data exported, market data, financial data, free, openbb terminal]
+description: The `OpenBBUserData` folder is where files are saved when they are created from within the OpenBB Terminal, like exports and generated reports. It is also where user-generated files are stored.
+keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, terminal, user, data, presets, screener, portfolio, styles, themes]
---
-
## The OpenBBUserData Folder
-The `OpenBBUserData` folder's default location is the home of the system user account. By default this will be the following paths:
+The `OpenBBUserData` folder is where files are saved when they are created from within the OpenBB Terminal, like exports and generated reports. It is also where user-generated files are stored, such as:
+
+- Screener presets
+- Portfolio files
+- Exported files
+- Files to be imported by various functions
+- Styles and themes
+
+The folder's location is at the root of user account for the operating system.
+
+- Linux: `~/home/Whale Alert
- -Go to https://docs.whale-alert.io You will be greeted with the following screen: - -
-
-Click "sign up here". This opens up the following screen:
-
-
-
-Once you have created your account, click "Create" to create your own API Key. Enter this API key into the OpenBB Terminal by typing `/keys/walert KEY`.
-
-
-
-
diff --git a/website/content/terminal/quickstart/api-keys.md b/website/content/terminal/quickstart/api-keys.md
new file mode 100644
index 00000000000..6bab5b3bd09
--- /dev/null
+++ b/website/content/terminal/quickstart/api-keys.md
@@ -0,0 +1,798 @@
+---
+title: Settings API Keys
+sidebar_position: 3
+description: API (Application Programming Interface) keys are access credentials for accessing data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address. Each key is entered into the Terminal from the `/keys` menu, using the syntax described below. The `--help` dialogue for each source will also display the expected inputs.
+keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, openbb terminal]
+---
+## The Keys Menu
+
+API (Application Programming Interface) keys are access credentials for obtaining data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer). Each source is entered into the Terminal from the `/keys` menu with the syntax as described in the sections below. Adding the `-h` argument to the command will also display the expected inputs. For example,
+
+```console
+/keys/reddit -h
+```
+
+Displays:
+
+```console
+usage: reddit [-i CLIENT_ID] [-s CLIENT_SECRET] [-u USERNAME] [-p PASSWORD] [-a USER_AGENT [USER_AGENT ...]] [-h]
+
+Set Reddit API key.
+
+options:
+ -i CLIENT_ID, --id CLIENT_ID
+ Client ID (default: None)
+ -s CLIENT_SECRET, --secret CLIENT_SECRET
+ Client Secret (default: None)
+ -u USERNAME, --username USERNAME
+ Username (default: None)
+ -p PASSWORD, --password PASSWORD
+ Password (default: None)
+ -a USER_AGENT [USER_AGENT ...], --agent USER_AGENT [USER_AGENT ...]
+ User agent (default: None)
+ -h, --help show this help message (default: False)
+```
+
+A message similar to the one below will be printed when a function requesting data from an API is called but the key has not yet been entered.
+
+```console
+/stocks/fa/ $ rot
+
+API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu.
+```
+
+The menu also provides a method for testing the validity of a key upon entry. It can be easy to copy & paste the string with a missing character; so, if the test fails, check that the values were correctly recorded with the command:
+
+```console
+mykeys --show
+```
+
+**We recommend gradually obtaining keys, when the use of a specific function requires it.**
+
+## Summary List
+
+
+
+
+## Instructions by Source
+
+This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided.
+
+### AlphaVantage
+
+Click to expand the list of data providers
+ +| Command | Name | URL | +| :------------ | :--------------------------------------- | :--------------------------------------------------------------------------------- | +| av | AlphaVantage | https://www.alphavantage.co/support/#api-key | +| binance | Binance | https://binance.com | +| bitquery | Bitquery | https://bitquery.io/ | +| cmc | CoinMarketCap | https://coinmarketcap.com/api/ | +| coinbase | Coinbase | https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key | +| coinglass | Coinglass | https://coinglass.github.io/API-Reference/#api-key | +| cpanic | Crypto Panic | https://cryptopanic.com/developers/api/ | +| databento | Databento | https://docs.databento.com/getting-started | +| degiro | DeGiro | https://www.degiro.com/ | +| eodhd | EODHD | https://eodhistoricaldata.com/r/?ref=869U7F4J | +| ethplorer | Ethplorer | https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API | +| finnhub | Finnhub | https://finnhub.io/ | +| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ | +| fred | Federal Reserve Economic Database (FRED) | https://fred.stlouisfed.org | +| github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | +| glassnode | Glassnode | https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/ | +| iex | IEX Cloud | https://iexcloud.io/ | +| intrinio | Intrinio | https://intrinio.com/ | +| messari | Messari | https://messari.io/api/docs | +| news | News API | https://newsapi.org/ | +| oanda | Oanda | https://developer.oanda.com | +| polygon | Polygon | https://polygon.io | +| quandl | Quandl | https://www.quandl.com | +| reddit | Reddit | https://www.reddit.com/wiki/api | +| rh | Robinhood | https://robinhood.com/us/en/ | +| santiment | Santiment | https://app.santiment.net/ | +| shroom | ShroomDK | https://sdk.flipsidecrypto.xyz/shroomdk | +| smartstake | Smartstake | https://www.smartstake.io | +| stocksera | Stocksera | https://stocksera.pythonanywhere.com/ | +| tokenterminal | Token Terminal | https://tokenterminal.com/ | +| tradier | Tradier | https://documentation.tradier.com/ | +| twitter | Twitter | https://developer.twitter.com | +| walert | Whale Alert | https://docs.whale-alert.io/ | + +
+
+
+### Binance
+
+Go to: https://www.alphavantage.co/support/#api-key
+ +[AlphaVantage](https://www.alphavantage.co/support/#api-key) + + + +Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued key can be entered into the OpenBB Terminal with: + +```console +/keys/av REPLACE_WITH_KEY +``` + +
+
+
+### Bitquery
+
+Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072
+ +[Binance](https://www.binance.com/en/support/faq/how-to-create-api-360002502072) + + + +These instructions should provide clear guidance for obtaining an API Key. Enter the issued credentials into the OpenBB Terminal with: + +```console +/keys/binance -k REPLACE_WITH_KEY -s REPLACE_WITH_SECRET +``` + +
+
+
+### CoinMarketCap
+
+Go to: https://bitquery.io/
+ +[Bitquery](https://bitquery.io/) + + + +Click "Try GraphQL API", which opens the following screen: + + + +After creating an account and verifying the email address, get the value for the key by clicking on the "API Key" tab. + + + +Enter this API key into the OpenBB Terminal by typing: + +```console +/keys/bitquery REPLACE_WITH_KEY +``` + +
+
+
+### Coinbase
+
+Go to: https://coinmarketcap.com/api
+ +[CoinMarketCap](https://coinmarketcap.com/api) + + + +Click on, "Get Your Free API Key Now", which opens to the page: + + + +Once the account has been created, copy the API key displayed within the dashboard. + + + +Enter the API key into the OpenBB Terminal by typing: + +```console +/keys/cmc REPLACE_WITH_KEY +``` + +
+
+
+### Coinglass
+
+Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key
+ +[Coinbase](https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key) + + + +Follow the instructions to obtain the credentials for the specific account. Enter the three values into the OpenBB Terminal by typing: + +```console +/keys/coinbase -k REPLACE_WITH_KEY -s REPLACE_WITH_SECRET -p REPLACE_WITH_PASSPHRASE +``` + +
+
+
+### Crypto Panic
+
+Go to: https://www.coinglass.com/
+ +[Coinglass](https://www.coinglass.com/) + + + +Click, "Log in", and then sign up for an account. This opens the page: + + + +With the account created, find the assigned API key within the account profile page. Enter this value into the OpenBB Terminal by typing: + +```console +/keys/coinglass REPLACE_WITH_KEY +``` + +
+
+
+### Databento
+
+Go to: https://cryptopanic.com/developers/api/
+ +[Crypto Panic](https://cryptopanic.com/developers/api/) + + + +Click on, [Sign up](https://cryptopanic.com/accounts/signup/?next=/developers/api/), and after creating, the API key will be displayed on the documentation page, "Your free API auth token". + + + +Enter that value in the OpenBB Terminal by typing: + +```console +/keys/cpanic REPLACE_WITH_KEY +``` + +
+
+
+### Degiro
+
+Go to: https://docs.databento.com/getting-started
+ +[Databento](https://docs.databento.com/getting-started) + + + +Click on, [Sign up](https://databento.com/signup), and after creating an account, the API key is found in the [account portal](https://databento.com/portal/keys). + + + +Enter this into the terminal with: + +```console +/keys/databento REPLACE_WITH_KEY +``` + +
+
+
+### EODHD
+
+Go to: https://www.degiro.com/
+ +[Degiro](https://www.degiro.com/) + + + +Click on, "Open an account", and then go through the registration process. After setting up the account, the login credentials can be entered in the OpenBB Terminal with: + +```console +/keys/degiro -u USERNAME -p PASSWORD +``` + +Instructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-). + +
+
+
+### Finnhub
+
+Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J
+ +[EODHD](https://eodhistoricaldata.com/r/?ref=869U7F4J) + + + +Clicking on, "Registration", opens the page: + + + +Once registered, the API Key will be next to "API TOKEN". + + + +Enter this string into the OpenBB Terminal by typing: + +```console +/keys/eodhd REPLACE_WITH_KEY +``` + +
+
+
+### Financial Modeling Prep
+
+Go to: https://finnhub.io/
+ +[Finnhub](https://finnhub.io/) + + + +Click on, "Get free api key", to open the page: + + + +Once the account has been created, find the API key in the account dashboard. + + + +Add this key to the OpenBB Terminal by entering: + +```console +/keys/finnhub REPLACE_WITH_KEY +``` + +
+
+
+### FRED
+
+Go to: https://site.financialmodelingprep.com/developer/docs
+ +[FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) + + + +Click on, "Get my API KEY here", and sign up for a free account. + + + +With an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key. + + + +Enter the key into the OpenBB Terminal with: + +```console +/keys/fmp REPLACE_WITH_KEY +``` + +
+
+
+### GitHub
+
+Go to: https://fred.stlouisfed.org
+ +[FRED](https://fred.stlouisfed.org) + + + +Click on, "My Account", create a new account or sign in with Google: + + + +After completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key". + + + +Fill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued. + + + +Enter the API key into the OpenBB Terminal with: + +```console +/keys/fred REPLACE_WITH_KEY +``` + +
+
+
+### Glassnode
+
+Go to: https://github.com
+ +[GitHub](https://github.com) + + + +Sign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings. + + + +Select, "New GitHub App": + + + +After creating the app, the key will be issued. Enter this token into the OpenBB Terminal with: + +```console +/keys/github REPLACE_WITH_KEY +``` + +
+
+
+### IEX Cloud
+
+Go to: https://studio.glassnode.com
+ +[Glassnode](https://studio.glassnode.com) + + + +Click on, "Sign up", and create an account: + + + +After creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key. + + + +Enter this key in the OpenBB terminal with: + +```console +/keys/glassnode REPLACE_WITH_KEY +``` + +
+
+
+### Intrinio
+
+Go to: https://iexcloud.io
+ +[IEX Cloud](https://iexcloud.io) + + + +Click on, "Sign in", and then create a new account. + + + +After signing up, select a plan. There is a choice for a free plan at the bottom. + + + +After completing the sign-up process, the API Keyis found under the, "Access & Security", tab. + + + +Add this API key to the OpenBB Terminal by entering: + +```console +/keys/iex REPLACE_WITH_KEY +``` + +
+
+
+### Messari
+
+Go to: https://intrinio.com/starter-plan
+ +[Intrinio](https://intrinio.com/starter-plan) + + + +An API key will be issued with a subscription. Find the token value within the account dashboard, and enter it into the OpenBB Terminal with: + +```console +/keys/intrinio REPLACE_WITH_KEY +``` + +
+
+
+### News API
+
+Go to: https://messari.io
+ +[Messari](https://messari.io) + + + +Click on, "Sign up", and create an account. + + + +After creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access. + + + +Copy the API key and add it to the OpenBB Terminal by entering: + +```console +/keys/messari REPLACE_WITH_KEY +``` + +
+
+
+### Oanda
+
+Go to: https://newsapi.org
+ +[News API](https://newsapi.org) + + + +Click on, "Get API Key", and fill out the form. + + + +Register for an account and the next screen will provide the API Key. + + + +Add this API key into the OpenBB Terminal by entering: + +```console +/keys/news REPLACE_WITH_KEY +``` + +
+
+
+### Polygon
+
+Go to: https://developer.oanda.com
+ +[Oanda](https://developer.oanda.com) + + + +After creating an account, follow the steps below. + + + +Upon completion of the account setup, enter the credentials into the OpenBB Terminal using the syntax: + +```console +/keys/oanda -a REPLACE_WITH_ACCOUNT -t REPLACE_WITH_TOKEN --account_type REPLACE_WITH_LIVE_OR_PRACTICE +``` + +
+
+
+### Quandl
+
+Go to: https://polygon.io
+ +[Polygon](https://polygon.io) + + + +Click on, "Get your Free API Key". + + + +After signing up, the API Key is found at the bottom of the account dashboard page. + + + +Enter the key into the OpenBB Terminal by typing: + +```console +/keys/polygon REPLACE_WITH_KEY +``` + +
+
+
+### Reddit
+
+Go to: https://www.quandl.com
+ +[Quandl](https://www.quandl.com) + + + +Click on, "Sign Up", and register a new account. + + + +Follow the sign-up instructions, and upon completion the API key will be assigned. + + + +Enter the key into the OpenBB Terminal with: + +```console +/keys/quandl REPLACE_WITH_KEY +``` + +
+
+
+### Robinhood
+
+Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/
+ +[Reddit](https://old.reddit.com/prefs/apps/) + + + +Scroll down and click on "create application", selecting "script". + + + +Once the application is created, you must register it [here](https://old.reddit.com/wiki/api) + + + +Click on, "Read the full API terms and sign up for usage", and fill out the form. + + + +After submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/), enter them into the OpenBB Terminal in one line: + +```console +/keys/reddit -i REPLACE_WITH_CLIENT_ID -s REPLACE_WITH_CLIENT_SECRET -u REPLACE_WITH_REDDIT_USERNAME -p REPLACE_WITH_REDDIT_PASSWORD -a REPLACE_WITH_USER_AGENT +``` + +
+
+
+### Santiment
+
+Go to: https://robinhood.com/us/en
+ +[Robinhood](https://robinhood.com/us/en) + + + +After registering for an account, it can be added to the OpenBB Terminal with: + +```console +/keys/rb -u REPLACE_WITH_USERNAME -p REPLACE_WITH_PASSWORD +``` + +The first login will request 2FA authorization from the device connected to the account. + +
+
+
+### ShroomDK
+
+Go to: https://app.santiment.net
+ + + +Click on, "Sign up", and register for an account. + + + +Navigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key. + + + +Add it to the OpenBB Terminal by entering: + +```console +/keys/santiment REPLACE_WITH_KEY +``` + +
+
+
+### Stocksera
+
+Go to: https://sdk.flipsidecrypto.xyz/shroomdk
+ +[ShroomDK](https://sdk.flipsidecrypto.xyz/shroomdk) + + + +Click "Mint Your ShroomDK API Key", and sign up for an account. + + + +Once created, connect a wallet to complete minting the NFT license. The API key will be displayed under the account. + + + +Enter it into the OpenBB Terminal by typing: + +```console +/keys/shroom REPLACE_WITH_KEY +``` + +
+
+
+### Token Terminal
+
+Go to: https://stocksera.pythonanywhere.com
+ +[Stocksera](https://stocksera.pythonanywhere.com) + + + +Click on, "Log in", and create an account. + + + +Once logged in, navigate to the "Developers" tab and copy the API key. + + + +Add the key to the OpenBB Terminal by entering: + +```console +/keys/stocksera REPLACE_WITH_KEY +``` + +
+
+
+### Tradier
+
+Go to: https://tokenterminal.com
+ +[Token Terminal](https://tokenterminal.com) + + + +Click on, "Log in" and sign up for an account. + + + +Verify the email address, and then navigate go to the "API" tab and copy the API key to the clipboard. + + + +Add the key to the OpenBB Terminal by typing: + +```console +/keys/tokenterminal REPLACE_WITH_KEY +``` + +
+
+
+### Twitter
+
+Go to: https://documentation.tradier.com
+ +[Tradier](https://documentation.tradier.com) + + + +Click on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token, and enter this key into the OpenBB Terminal with: + +```console +/keys/tradier REPLACE_WITH_KEY +``` + +
+
+
+### Whale Alert
+
+Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the current features will continue to work.
+ + + +
+
diff --git a/website/content/terminal/quickstart/faq.md b/website/content/terminal/quickstart/faq.md
deleted file mode 100644
index aaea140f3a9..00000000000
--- a/website/content/terminal/quickstart/faq.md
+++ /dev/null
@@ -1,350 +0,0 @@
----
-title: FAQ
-sidebar_position: 3
-keywords: [faq, frequently asked questions, openbb terminal]
----
-
-## General
-
-Go to: https://docs.whale-alert.io
+ +[Whale Alert](https://docs.whale-alert.io) + + + +Click on, "sign up here". + + + +After creating the account, click on, "Create", to issue the API Key. + + + +Enter the key into the OpenBB Terminal by typing: + +```console +/keys/walert REPLACE_WITH_KEY +``` + +Where does the data from the OpenBB Terminal come from?
-- -The OpenBB platform does not provide any data itself as the platform is a data aggregator that connects to -almost a hundred different data providers and APIs to access the data. - -
-How do I update my installation to the latest version?
-- -The terminal is constantly being updated with new features and bug fixes. Updating will be different depending on the installation type: - -- For installation packages, uninstall the previous version (uninstall.exe for Windows, delete the Application folder on MacOS); then, download the latest version and reinstall. User settings and data will remain. -- For a `pip` installation, when a new version is published: `pip install openbb --upgrade` -- Upgrade the `pip installation` to the source code installation with: - -```bash -conda install -c conda-forge git -git clone https://github.com/OpenBB-finance/OpenBBTerminal.git -cd OpenBBTerminal -poetry install (for a complete installation - poetry install -E all) -``` - -The Terminal can now be launched with either, `openbb`, or, `python terminal.py` - -
-What programs need to be allowed for Windows Firewall?
-- -When issues arise regarding Windows Firewall, please allow the following applications through (if not already): - -- BranchCache -- Hyper-V -- VcXsrv -- Windows Terminal - -From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. - -
-On what Operating Systems can I run the OpenBB Terminal?
-- -The OpenBB Terminal is compatible with Windows, MacOS and Linux. Check the -[installation guide](/terminal/quickstart/installation) and [requirements outline](/terminal/quickstart/requirements) for more details. - -
-How much hard drive space is required?
-- -An installation will use approximately 2GB of space. - -
-How can I contribute to the OpenBB Terminal
-- -There are two main ways of contributing to this project. - -**BECOME A CONTRIBUTOR** - -1. Fork the [Project](https://github.com/OpenBB-finance/OpenBBTerminal) -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Install the pre-commit hooks by running: `pre-commit install` - Any time you commit a change, linters will be run automatically. On changes, you will have to re-commit -4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -5. Push to your Branch (`git push origin feature/AmazingFeature`) -6. Open a Pull Request - -You can read more details about adding a feature in our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). - -**RAISE AN ISSUE OR REQUEST A FEATURE** - -- Raise an issue by opening a [bug ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues). -- Request a new feature through a [feature request ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues). - -
-How do I report a bug?
-- -First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) - -
-How can I get help with OpenBB Terminal?
-- -You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). - -
-How can I give feedback about the OpenBB Terminal?
-
-
-Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model.
-
-You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`).
-
-
-
-Alternatively, you can contact us via the following routes:
-
-- If you notice that a feature is missing inside the terminal, please fill in the Request a Feature form.
-- If you wish to report a bug, have a question/suggestion or anything else, please fill in the Support form.
-- If you wish to speak to us directly, please contact us via Discord.
-
-
Why is data from today missing when I use the load function?
-- -By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. - -
-Why does a specific menu or command not exist?
-- -It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release. - -Do note that it is also possible that the menu or command is removed. If this is undesirable, please reach out to us [here](https://openbb.co/support). - -
-Why does my Portfolio file fail to load?
-- -This will typically be the result of a formatting error. - -- Check that all the necessary column titles are present. -- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values. -- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu. -- Format ticker symbols according to yFinance naming convention. -- All dates must be entered as YYYY-MM-DD. -- Transactions dated for today will fail to load historical data. -- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving. - -
-How do I update the OpenBB Terminal?
-- -A source code installation can utilize the `update` command from the main menu of the OpenBB Terminal, or, exit and enter: - -```bash -git pull -``` - -If this fails due to the fact that you had modified some python files, and there's a conflict with the updates, you can use: - -```bash -git stash -``` - -Then, re-run `poetry install` to get any new dependencies. Once installation is finished, you're ready to use the OpenBB Terminal again. If you `stashed` your changes previously, you can un-stash them with: - -```bash -git stash pop -``` - -**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate obb` -before you call `openbb` again. - -
-What kind of architectural pattern does the OpenBB SDK use?
-- -Throughout the entire OpenBB Platform, the [Model-view-controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) architectural pattern is used for creating functionality in the OpenBB Terminal. - -The `model` relates to any calculations or data collection done. The `view` is meant for showing tables or graphs and the `controller` makes it possible to execute a command with a set of arguments directly in the OpenBB Terminal. Learn more about this in our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). - -
-Why do I get too many red error lines on Windows?
-- -If you are on Windows and your terminal has too many red error lines, it is likely that this is the issue. Go to this page and install the 2019 Build Tools (not the latest) found [here](https://answers.microsoft.com/en-us/windows/forum/windows_other-windows_install/microsoft-visual-c-140/6f0726e2-6c32-4719-9fe5-aa68b5ad8e6d) - -
-What does it mean if it says wheel is missing?
-- -If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing. - -`conda install -c conda-forge wheel` or `pip install wheel` - -
-Why do these .whl files not exist?
-
-
-If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder.
-Just removing the 'artifacts' folder could also be enough:
-
-| Platform | Location |
-| -------- | ------------------------------- |
-| Linux | "~/.cache/pypoetry" |
-| Mac | "~/Library/Caches/pypoetry" |
-| Windows | "%localappdata%/pypoetry/cache" |
-
-When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the
-'artifacts' folder again to reinitialize Poetry.
-
-If you run into trouble with Poetry, and the advice above did not help, your best bet is to try
-
-1. `poetry update --lock`
-
-2. `conda deactivate` -> `conda activate obb`, then try again
-
-3. Track down the offensive package and purge it from your anaconda `
What does the JSONDecodeError mean during poetry install?
-- -Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process. - -```bash -poetry config experimental.new-installer false -``` - -
-Why do a receive a ModuleNotFoundError?
-- -IF you receive an error like `ModuleNotFoundError: No module named '_______'` - -
Before you start begin troubleshooting please verify that you have followed the recommended installation instructions. -These errors often can occur when you have not activated the virtual environment where you have installed the terminal, or you have not used the `poetry install` command to install the dependencies.
- -If you are still having issues install the missing packages via pip. For example if you get the error that `yfinance` is not found, you would run `pip install yfinance` - - -How do I fix "Cannot convert a symbolic Tensor..."?
-- -If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: - -```bash -poetry install -poetry install -E forecast -``` - -_Commands that may help you in case of an error:_ - -- `python -m pip install --upgrade pip` -- `poetry update --lock` -- `poetry install` - -
-How do I deal with errors regarding CRLF?
-- -When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to -CRLF (default for Windows). -This is because the entire package uses LF (default for Linux/Mac), and it is therefore -important that you change this setting to LF _before_ you make any changes to the code. - -It is possible that CRLF automatically turns back on, you can correct this with: - -```bash -git config --global core.autocrlf false -``` - -In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with -the following: - -```bash -git rm --cached -r . -git reset --hard -``` - -
-Why can't I run OpenBB via the VS Code integrated terminal?
-- -This occurs when VS Code terminal python version/path is different from the terminal version. - -To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)): - -```bash - "terminal.integrated.inheritEnv": false, -``` - -
-
-
This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater).
+### A. Windows Installer -Download the installer from the button below:
+Install the OpenBB Terminal on Windows (10 or greater): + +#### 1. Download + +**Step 1:** Download the file by clicking on the button.Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+#### 2. Run Installer - +**Step 2:** Open the downloaded file by double-clicking on it -
+#### 3. Follow Prompts
-
-
-
+#### 4. Launch
-Step 1: Double-click the .exe file that got downloaded to your Downloads folder
-
+**Note:** The first launch may take up to a few minutes, subsequent launches will be quicker.
-Step 2: Follow the prompts clicking Next > where needed to complete the installation process
-
+Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Apple Silicon (M1) and Intel-based. Apple Silicon users will need to install Rosetta prior to installation. Install Rosetta from the command line:
-Step 3: Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal
-
The first time this takes a bit longer to load, this can take up to a few minutes. If everything was successful you should see a screen like the one below :
-
-
-
-
-If you are using Mac Intel:
-
- -
-If you are using Mac Apple Silicon (M1):
-
-Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
- - - -
-
-
-
-
-
-Step 1: Open the downloaded OpenBB Terminal.dmg and drag the OpenBB Terminal folder into your Applications
A link to the Applications folder is presented on the screen.
-Note that this should take some time as it is extracting the files from the .dmg file.
-
-
-Step 2: Open the OpenBB Terminal app in the folder that you have just copied to your Applications.
During first launch if you get a message saying that the application can’t be launched, do the following:
-Right-Click the app and select Open. You will see a message saying that macOS was not able to check whether the application contains malicious software. Click Open to proceed.
Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. +
+
Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+#### 1. Download - +**Step 1:** Download the DMG file from the links above. -## 1. Windows +#### 2. Mount DMG -### 1.1. Install Docker Desktop +**Step 2:** Mount the downloaded DMG file by double-clicking on it. + +#### 3. Drag Folder + +**Step 3:** Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. + + + +#### 4. Unmount DMG + +**Step 4:** Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. + +#### 5. Launch + +**Step 5:** Launch the application by double-clicking on the `OpenBB Terminal` application. + +**Note:** During the first launch, a warning message may appear. Click, "Open". + + + +## Source Code + +The following instructions are for installing the OpenBB Terminal source code. + +### 1. System Preparation + +Prepare the system by installing the following items: + +#### 1.1 Install Miniconda + +[Install Miniconda](https://docs.conda.io/en/latest/miniconda.html) + +Miniconda is a Python environment and package manager. It is required for installing certain dependencies. + +- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: + + - Apple-Silicon Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.pkg) + - Intel-based Mac Systems: [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) + - Linux and WSL Systems: [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) + - Raspberry PI Systems: [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) + - Windows Systems: [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe) + + **NOTE for Apple Silicon Users:** Install Rosetta from the command line: `softwareupdate --install-rosetta` + + **NOTE for Windows users:** Install/update Microsoft C++ Build Tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/). + +#### 1.2 Install CMake + +**CMake is required by several Python modules.** + +**For Windows:** + +CMake is installed as a part of Microsoft C++ Build Tools. Skip ahead to the next step. + +**For MacOS:** + +Check if homebrew is installed by running `brew --version` + +If Homebrew is not installed, run: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +brew install cmake +brew install gcc +``` + +If Homebrew is already installed: + +```bash +brew install cmake +brew install gcc +``` + +**For Linux:** + +```bash +sudo apt update && sudo apt upgrade +sudo apt install -y gcc cmake +``` + +#### 1.3 Linux and WSL Only + +Since a WSL installation is headless by default (i.e., there is only access to a terminal running a Linux distribution) there are additional steps required to display visualizations. A more detailed tutorial is found, [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a). + +- Dynamically export the DISPLAY environment variable in WSL2: + +```console +# add to the end of ~/.bashrc file +export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 +# source the file +source ~/.bashrc +``` + +- Download and install [VcXsrv](https://sourceforge.net/projects/vcxsrv/) +- When running the program is important to check "Disable access control" + +After this, `VcXsrv` should be running successfully, and the machine is ready to proceed with the terminal installation. + +Alternatives to `VcXsrv` include: + +- [GWSL](https://opticos.github.io/gwsl/) +- [Xming](https://xming.en.softonic.com/) +- [Wayland](https://wayland.freedesktop.org/docs/html/) + +### 2. Create Environment + +The first step is to create the virtual Python environment. + +#### 2.1 Confirm Conda Base + +When a terminal window is opened, if the base Conda environment - look for `(base)` to the left of the cursor on the command line - is not activated automatically, find the path for it by entering: + +```console +conda env list +``` + +Copy the path which corresponds with `base`, and activate it with: + +```console +conda activate REPLACE_WITH_PATH +``` + +Check which `conda` version is installed by entering: + +```console +conda -V +``` + +As of writing, the most recent version of `Conda` is, `23.1.0`. If required, update from a lower version with: + +```console +conda install -c conda-forge -n base conda=23.1.0 +``` + +#### 2.2 Create the Environment + +Create the environment by copying the code below into the command line: + +```console +conda create -n obb -c conda-forge python=3.10.9 pip pybind11 cmake git cvxpy lightgbm poetry +``` + +### 3. Activate Environment + +After the packages from Step 2 install, activate the newly created environment by entering: + +```console +conda activate obb +``` + +### 4. Install OpenBB Terminal + +From the command line, navigate into a folder where the installation should live. Do not continue without completing steps 1-3. + +#### 4.1 Clone the Project + +Cloning the GitHub repo will download the source code to the current working directory. + +```console +git clone https://github.com/OpenBB-finance/OpenBBTerminal.git +``` + +#### 4.2 Navigate to OpenBBTerminal + +```console +cd OpenBBTerminal +``` + +#### 4.3 Install Remaining Packages + +```bash +pip install qdldl==0.1.5.post3 +poetry install -E all +``` + +#### 4.4 Launch OpenBB Terminal + +Start the terminal by running: + +```bash +python terminal.py +``` + +**NOTE:** When a terminal is re-opened, the Python environment will need to be activated again - `conda activate obb` - and the current working directory should be the `OpenBBTerminal` folder where the source code was cloned. + +**TROUBLESHOOTING:** Having difficulty getting through the installation, or encountering errors? Check out the [troubleshooting page](/terminal/quickstart/troubleshooting), or reach out to our [Discord](https://discord.gg/Up2QGbMKHY) community for help. + +## Docker + +Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. + +### 1. Windows + +#### 1.1. Install Docker Desktop You can find `Docker Desktop` for Windows here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) -### 1.2. Start Docker +#### 1.2. Start Docker Execute the following command: -```bash +```console docker info ``` If you have something like this, it means you haven't started Docker: -```bash +```console docker info Server: ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. @@ -139,7 +285,7 @@ Is the docker daemon running? Start Docker, this is how the right output looks like: -```bash +```console docker info Client: Context: default @@ -152,7 +298,7 @@ Server: Stopped: 10 ``` -### 1.3. Install VcXsrv +#### 1.3. Install VcXsrv To display charts with your container, you need : VcXsrv. @@ -160,11 +306,11 @@ You can download VcXsrv here : [Download VcXsrv](https://sourceforge.net/project When running VcXsrv program check the option: `Disable access control` -### 1.4. Pull and run the container +#### 1.4. Pull and run the container Execute this commands: -```bash +```console curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml docker compose run openbb @@ -174,13 +320,13 @@ This will download and run the file: `docker-compose.yaml` This file contents the settings to pull and run OpenBB Terminal Docker image. -## 2. macOS +### 2. MacOS -### 2.1. Install and run Docker Desktop +#### 2.1. Install and run Docker Desktop Install and run Docker Desktop as describe above in this document. -### 2.2. Install XQuartz +#### 2.2. Install XQuartz You can download XQuartz here: [Download XQuartz](https://www.xquartz.org) @@ -196,7 +342,7 @@ Make sure both of these options are enabled: It should look like this:  -### 2.3. Get Docker IP +#### 2.3. Get Docker IP To get Docker IP you can use this command: @@ -204,11 +350,11 @@ To get Docker IP you can use this command: IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}') ``` -### 2.4. Pull and run the container +#### 2.4. Pull and run the container Execute this commands: -```bash +```console curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml xhost +$IP @@ -221,17 +367,17 @@ This file contents the settings to pull and run OpenBB Terminal Docker image. The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. -## 3. Linux +### 3. Linux -### 3.1. Install and run Docker Desktop +#### 3.1. Install and run Docker Desktop Install and run Docker Desktop as describe above in this document. -### 3.2. Pull and run the container +#### 3.2. Pull and run the container Execute this commands: -```bash +```console curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml xhost +local: @@ -240,192 +386,33 @@ docker compose run openbb Note: if you're using remote docker host, you can connect with `ssh -XThis section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS).
- -Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
- - - -**NOTE for Windows users:** For Windows users who prefer to use an environment similar to what Linux and macOS users use, we recommend Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the Installing WSL (Only for Windows users) section before proceeding. - -### Installing the terminal - -These steps are common in all operating systems (Windows with or without WSL, MacOS or Linux). - -This project supports Python 3.8 and 3.9. By default, the newly created virtual environment will use Python 3.9.13 - -Our current recommendation is to use this project with Anaconda's Python distribution - either full [**Anaconda3 Latest**](https://www.anaconda.com/products/distribution) or [**Miniconda3 Latest**](https://docs.conda.io/en/latest/miniconda.html) (recommended). Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional. For MacOS systems, the "Miniconda3 MacOSX 64-bit" version that works on both Intel and M1 macs is recommended. - -**NOTE:** We recommend using `conda` and `poetry` because it just works. You can use other python -distributions and use raw `pip` instead of `poetry` but you will very likely bump into installation -issues. - -#### 1. [Install Miniconda](https://docs.conda.io/en/latest/miniconda.html) - -Miniconda is a python environment and package manager. It is required if you want to -have the dependencies working straight away. - -- Go [here](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) to find the download for your operating system or use the links below: - - - If you are using macOS [Miniconda for MacOS](https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh) - - If you are using WSL or Linux [Miniconda for Linux](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh) - - If you are using a Raspberry PI [Miniconda for Raspberry PI](https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh) - - If you are using Windows [Miniconda for Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe). - - **ONLY REQUIRED ON WINDOWS IF NOT USING WSL**, Install/update Microsoft C++ Build Tools from here: