Files
OpenBB/website/content/terminal/quickstart/keys.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

6.0 KiB
Vendored

sidebar_position, title
sidebar_position title
7 API keys

Accessing other sources of data via API keys

Within this menu you can define your, often free, API key from various platforms like Alpha Vantage, FRED, IEX, Twitter, DeGiro, Binance and Coinglass. API keys are in essence a set of random characters that is unique to you.

You can access this menu from the homepage with keys which will open the menu as shown below:

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 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'.

Command Name URL
av AlphaVantage https://www.alphavantage.co/support/#api-key
fmp Financial Modelling Prep https://site.financialmodelingprep.com/developer/docs/
quandl Quandl https://www.quandl.com
polygon Polygon https://polygon.io
fred Federal Reserve Economic Database (FRED) https://fred.stlouisfed.org
news News API https://newsapi.org/
tradier Tradier https://developer.tradier.com
cmc CoinMarketCap https://coinmarketcap.com/
finnhub Finnhub https://finnhub.io/
iex IEX Cloud https://iexcloud.io/
reddit Reddit https://www.reddit.com/wiki/api
twitter Twitter https://developer.twitter.com
rh Robinhood https://robinhood.com/us/en/
degiro DeGiro https://www.degiro.com/
oanda Oanda https://developer.oanda.com
binance Binance https://binance.com
bitquery Bitquery https://bitquery.io/
si Sentiment Investor https://sentimentinvestor.com
cb Coinbase https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key
walert Whale Alert https://docs.whale-alert.io/
glassnode Glassnode https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/
coinglass Coinglass https://coinglass.github.io/API-Reference/#api-key
ethplorer Ethplorer https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API
smartstake Smartstake https://www.smartstake.io
github GitHub https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api
messari Messari https://messari.io/api/docs
cpanic Crypto Panic https://cryptopanic.com/developers/api/
eodhd EODHD https://eodhistoricaldata.com/
santiment Santiment https://app.santiment.net/
shroom ShroomDK https://sdk.flipsidecrypto.xyz/shroomdk
tokenterminal Token Terminal https://tokenterminal.com/