From 3fd68b6062f2bfd9ae754b7172578b262a8a2214 Mon Sep 17 00:00:00 2001 From: jose-donato <43375532+jose-donato@users.noreply.github.com> Date: Wed, 11 Jan 2023 17:37:10 +0000 Subject: [PATCH] Hotfix/dots sources (#3928) * fix: wordwrap * Fix plot look when using eval and add query to choices (#3881) * convert index to datetime and update choices * uncomment economy integration test * fix treasury concat bug * fix datasets concat on duplciates * Lock ruff version so that new lints dont break our CI (#3905) * Lock ruff version so that new lints dont break our CI * Bumped pre-commit ruff version * fix: str Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com> --- .../terminal/guides/advanced/api-keys.md | 200 ++++++++++-------- 1 file changed, 116 insertions(+), 84 deletions(-) diff --git a/website/content/terminal/guides/advanced/api-keys.md b/website/content/terminal/guides/advanced/api-keys.md index 43d5afd3444..ba4919252b0 100644 --- a/website/content/terminal/guides/advanced/api-keys.md +++ b/website/content/terminal/guides/advanced/api-keys.md @@ -2,7 +2,9 @@ title: Set API keys sidebar_position: 1 --- + ## Accessing the keys menu + Within the `keys` menu you can define your, often free, API key from various platforms like Alpha Vantage, FRED, IEX, Twitter, DeGiro, Binance and Coinglass. An API key is a set of random characters provided to you by a third party vendor that allows you to access data via their API endpoints. You can access this menu from the homepage with `keys` which will open the menu as shown below: @@ -16,49 +18,51 @@ To figure out where you can obtain the API key, you can enter the command (e.g.
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/ | -| 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/ | -| 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/ | +| 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/ | +| 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/ | +| 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/ | +
## 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.
AlphaVantage -Go to https://www.alphavantage.co/support/#api-key. You will be greeted with the following screen: +Go to https://www.alphavantage.co/support/#api-key You will be greeted with the following screen: image @@ -69,17 +73,18 @@ Once you enter the type of investor you are, the organization you work at and yo
Binance -Go to https://www.binance.com/en/support/faq/how-to-create-api-360002502072. You will be greeted with the following screen: +Go to https://www.binance.com/en/support/faq/how-to-create-api-360002502072 You will be greeted with the following screen: image 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`. +
Bitquery -Go to https://bitquery.io/. You will be greeted with the following screen: +Go to https://bitquery.io/ You will be greeted with the following screen: image @@ -90,12 +95,13 @@ 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`. image +
CoinMarketCap -Go to https://coinmarketcap.com/api. You will be greeted with the following screen: +Go to https://coinmarketcap.com/api You will be greeted with the following screen: image @@ -106,22 +112,24 @@ 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` image +
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: +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: image 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`. -
+ +
Coinglass -Go to https://www.coinglass.com/. You will be greeted with the following screen: +Go to https://www.coinglass.com/ You will be greeted with the following screen: image @@ -130,12 +138,13 @@ Click "Log in" and sign up for an account. This opens up the following screen: image 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`. -
+ +
Crypto Panic -Go to https://cryptopanic.com/developers/api/. You will be greeted with the following screen: +Go to https://cryptopanic.com/developers/api/ You will be greeted with the following screen: image @@ -146,22 +155,24 @@ Click "Sign up" under "Your free API auth token". This opens up the following sc 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`. image +
DeGiro -Go to https://www.degiro.com/. You will be greeted with the following screen: +Go to https://www.degiro.com/ You will be greeted with the following screen: image 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-). -
+ +
EODHD -Go to https://eodhistoricaldata.com/. You will be greeted with the following screen: +Go to https://eodhistoricaldata.com/ You will be greeted with the following screen: image @@ -172,12 +183,13 @@ 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/cpanic KEY`. image +
Finnhub -Go to https://finnhub.io/. You will be greeted with the following screen: +Go to https://finnhub.io/ You will be greeted with the following screen: image @@ -188,12 +200,13 @@ 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` image +
Financial Modelling Prep -Go to https://site.financialmodelingprep.com/developer/docs/. You will be greeted with the following screen: +Go to https://site.financialmodelingprep.com/developer/docs You will be greeted with the following screen: image @@ -204,12 +217,13 @@ 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` image +
-FRED +FRED -Go to https://fred.stlouisfed.org. You will be greeted with the following screen: +Go to https://fred.stlouisfed.org You will be greeted with the following screen: image @@ -224,12 +238,13 @@ Once you have signed up, go to "My Account" and select "API Keys". This will get 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` image +
-GitHub +GitHub -Go to https://github.com/. You will be greeted with the following screen: +Go to https://github.com You will be greeted with the following screen: GitHub @@ -242,12 +257,13 @@ Press "New GitHub App". This opens up the following screen: image 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`. +
-Glassnode +Glassnode -Go to https://studio.glassnode.com/. You will be greeted with the following screen: +Go to https://studio.glassnode.com You will be greeted with the following screen: image @@ -258,12 +274,13 @@ 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`. image +
-IEX Cloud +IEX Cloud -Go to https://iexcloud.io/. You will be greeted with the following screen: +Go to https://iexcloud.io You will be greeted with the following screen: image @@ -278,12 +295,13 @@ Once you have signed up you are asked what kind of plan you would like. You have Once you have confirmed you email address, you can find your API Key under "Access & Security". Enter this API key into the OpenBB Terminal by typing `/keys/iex KEY` image +
-Messari +Messari -Go to https://messari.io/. You will be greeted with the following screen: +Go to https://messari.io You will be greeted with the following screen: image @@ -294,12 +312,13 @@ 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`. image +
-News API +News API -Go to https://newsapi.org/. You will be greeted with the following screen: +Go to https://newsapi.org You will be greeted with the following screen: image @@ -310,24 +329,26 @@ 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` image +
-Oanda +Oanda -Go to https://developer.oanda.com. You will be greeted with the following screen: +Go to https://developer.oanda.com You will be greeted with the following screen: image 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`. image +
-Polygon +Polygon -Go to https://polygon.io. You will be greeted with the following screen: +Go to https://polygon.io You will be greeted with the following screen: image @@ -338,12 +359,13 @@ 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` image +
-Quandl +Quandl -Go to https://www.quandl.com. You will be greeted with the following screen: +Go to https://www.quandl.com You will be greeted with the following screen: image @@ -354,12 +376,13 @@ 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` image +
-Reddit +Reddit -Go to https://www.reddit.com/wiki/api. You will be greeted with the following screen: +Go to https://www.reddit.com/wiki/api You will be greeted with the following screen: image @@ -368,22 +391,24 @@ Press "Read the full API terms and sign up for usage" and start the sign-up proc image 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`. +
-Robinhood +Robinhood -Go to https://robinhood.com/us/en/. You will be greeted with the following screen: +Go to https://robinhood.com/us/en You will be greeted with the following screen: image 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`. +
-Santiment +Santiment -Go to https://app.santiment.net/. You will be greeted with the following screen: +Go to https://app.santiment.net You will be greeted with the following screen: image @@ -394,12 +419,13 @@ 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`. image +
-ShroomDK +ShroomDK -Go to https://app.santiment.net/. You will be greeted with the following screen: +Go to https://app.santiment.net You will be greeted with the following screen: image @@ -410,12 +436,13 @@ Click "Mint Your ShroomDK API Key" and sign up for an account. This opens up the 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`. image +
-Stocksera +Stocksera -Go to https://stocksera.pythonanywhere.com/. You will be greeted with the following screen: +Go to https://stocksera.pythonanywhere.com You will be greeted with the following screen: image @@ -426,12 +453,13 @@ 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`. image +
-Token Terminal +Token Terminal -Go to https://tokenterminal.com/. You will be greeted with the following screen: +Go to https://tokenterminal.com You will be greeted with the following screen: image @@ -442,22 +470,24 @@ 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`. image +
-Tradier +Tradier -Go to https://documentation.tradier.com/. You will be greeted with the following screen: +Go to https://documentation.tradier.com You will be greeted with the following screen: image 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 +Twitter -Go to https://developer.twitter.com. You will be greeted with the following screen: +Go to https://developer.twitter.com You will be greeted with the following screen: image @@ -472,12 +502,13 @@ Create an account and verify your email. Then, you will be able to create an app 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`. image +
-Whale Alert +Whale Alert -Go to https://docs.whale-alert.io/. You will be greeted with the following screen: +Go to https://docs.whale-alert.io You will be greeted with the following screen: image @@ -488,4 +519,5 @@ 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`. image +