diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a09d373655..06564d174ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1212,6 +1212,9 @@ In order to do that, you'll simply need to choose from one the following files: 1. [local_credentials.json](openbb_terminal/miscellaneous/models/local_credentials.json) --> credentials that should only be stored locally and not pushed to the [OpenBB Hub](https://my.openbb.co/) like brokerage keys or other very sensitive or personal to the user. 2. [hub_credentials.json](openbb_terminal/miscellaneous/models/hub_credentials.json) --> credentials that should be stored in the [OpenBB Hub](https://my.openbb.co/) like API keys to access your favorite providers. +Then just update [all_api_keys.json](openbb_terminal/miscellaneous/models/all_api_keys.json) with the instructions to get +the api key from the data source website. + > Note: By differentiating between local and hub credentials, we can ensure that the user's credentials are not pushed to the [OpenBB Hub](https://my.openbb.co/) and are only stored locally. This does not mean that the credentials are not secure in the OpenBB Hub, but rather that the user can choose to store them locally if they wish. ### Setting and checking API key diff --git a/openbb_terminal/miscellaneous/models/all_api_keys.json b/openbb_terminal/miscellaneous/models/all_api_keys.json new file mode 100644 index 00000000000..9356f255b5a --- /dev/null +++ b/openbb_terminal/miscellaneous/models/all_api_keys.json @@ -0,0 +1,278 @@ +[ + { + "name": "API_ULTIMA_KEY", + "source": "Ultima Insights", + "link": "https://www.ultimainsights.ai/", + "markdown": "Go to: https://ultimainsights.ai/\n\n![Ultima Insights](https://user-images.githubusercontent.com/1911913/229215125-e3419788-eef3-4389-a3bd-5c08f3333347.png)\n\nClick on, \"Get Started\", to start the sign-up process. After the account has been setup, navigate to [Generate API Key](https://beta.ultimainsights.ai/my-account/generate-api-key) and click \"Generate Key\"." + }, + { + "name": "API_KEY_ALPHAVANTAGE", + "source": "Alpha Vantage", + "link": "https://www.alphavantage.co/support/#api-key", + "markdown": "Go to: https://www.alphavantage.co/support/#api-key\n\n![AlphaVantage](https://user-images.githubusercontent.com/46355364/207820936-46c2ba00-81ff-4cd3-98a4-4fa44412996f.png)\n\nFill out the form, pass Captcha, and click on, \"GET FREE API KEY\"." + }, + { + "name": "API_MESSARI_KEY", + "source": "Messari", + "link": "https://messari.io/api", + "markdown": "Go to: https://messari.io\n\n![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png)\n\nClick on, \"Sign Up\", and create an account.\n\n![Messari](https://user-images.githubusercontent.com/46355364/207848160-6a962e3c-3007-40a3-9431-cd5ddfe5bb8e.png)\n\nAfter creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access.\n\n![Messari](https://user-images.githubusercontent.com/46355364/207848324-ade5bede-8e6b-4b87-bdec-eade3217c0d8.png)" + }, + { + "name": "API_KEY_FINANCIALMODELINGPREP", + "source": "Financial Modeling Prep", + "link": "https://financialmodelingprep.com/developer", + "markdown": "Go to: https://site.financialmodelingprep.com/developer/docs\n\n![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207821920-64553d05-d461-4984-b0fe-be0368c71186.png)\n\nClick on, \"Get my API KEY here\", and sign up for a free account.\n\n![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207822184-a723092e-ef42-4f87-8c55-db150f09741b.png)\n\nWith 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.\n\n![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207823170-dd8191db-e125-44e5-b4f3-2df0e115c91d.png)" + }, + { + "name": "API_KEY_QUANDL", + "source": "Quandl", + "link": "https://www.quandl.com/tools/api", + "markdown": "Go to: https://www.quandl.com\n\n![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png)\n\nClick on, \"Sign Up\", and register a new account.\n\n![Quandl](https://user-images.githubusercontent.com/46355364/207824214-4b6b2b74-e709-4ed4-adf2-14803e6f3568.png)\n\nFollow the sign-up instructions, and upon completion the API key will be assigned.\n\n![Quandl](https://user-images.githubusercontent.com/46355364/207824664-3c82befb-9c69-42df-8a82-510d85c19a97.png)" + }, + { + "name": "API_REDDIT_CLIENT_ID", + "source": "Reddit client ID", + "link": "https://www.reddit.com/prefs/apps", + "markdown": "Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/\n\n![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15)\n\nScroll down and click on \"create application\", selecting \"script\".\n\n![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e)\n\nOnce the application is created, you must register it [here](https://old.reddit.com/wiki/api)\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png)\n\nClick on, \"Read the full API terms and sign up for usage\", and fill out the form.\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png)\n\nAfter submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/)." + }, + { + "name": "API_REDDIT_CLIENT_SECRET", + "source": "Reddit client secret", + "link": "https://www.reddit.com/prefs/apps", + "markdown": "Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/\n\n![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15)\n\nScroll down and click on \"create application\", selecting \"script\".\n\n![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e)\n\nOnce the application is created, you must register it [here](https://old.reddit.com/wiki/api)\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png)\n\nClick on, \"Read the full API terms and sign up for usage\", and fill out the form.\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png)\n\nAfter submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/)." + }, + { + "name": "API_REDDIT_USERNAME", + "source": "Reddit username", + "link": "https://www.reddit.com/prefs/apps", + "markdown": "Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/\n\n![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15)\n\nScroll down and click on \"create application\", selecting \"script\".\n\n![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e)\n\nOnce the application is created, you must register it [here](https://old.reddit.com/wiki/api)\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png)\n\nClick on, \"Read the full API terms and sign up for usage\", and fill out the form.\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png)\n\nAfter submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/)." + }, + { + "name": "API_REDDIT_USER_AGENT", + "source": "Reddit user agent", + "link": "https://www.reddit.com/prefs/apps", + "markdown": "Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/\n\n![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15)\n\nScroll down and click on \"create application\", selecting \"script\".\n\n![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e)\n\nOnce the application is created, you must register it [here](https://old.reddit.com/wiki/api)\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png)\n\nClick on, \"Read the full API terms and sign up for usage\", and fill out the form.\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png)\n\nAfter submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/)." + }, + { + "name": "API_REDDIT_PASSWORD", + "source": "Reddit password", + "link": "https://www.reddit.com/prefs/apps", + "markdown": "Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/\n\n![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15)\n\nScroll down and click on \"create application\", selecting \"script\".\n\n![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e)\n\nOnce the application is created, you must register it [here](https://old.reddit.com/wiki/api)\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png)\n\nClick on, \"Read the full API terms and sign up for usage\", and fill out the form.\n\n![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png)\n\nAfter submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/)." + }, + { + "name": "API_POLYGON_KEY", + "source": "Polygon", + "link": "https://polygon.io", + "markdown": "Go to: https://polygon.io\n\n![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png)\n\nClick on, \"Get your Free API Key\".\n\n![Polygon](https://user-images.githubusercontent.com/46355364/207825952-ca5540ec-6ed2-4cef-a0ed-bb50b813932c.png)\n\nAfter signing up, the API Key is found at the bottom of the account dashboard page.\n\n![Polygon](https://user-images.githubusercontent.com/46355364/207826258-b1f318fa-fd9c-41d9-bf5c-fe16722e6601.png)" + }, + { + "name": "API_TWITTER_KEY", + "source": "Twitter key", + "link": "https://developer.twitter.com", + "markdown": "![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium)" + }, + { + "name": "API_TWITTER_SECRET_KEY", + "source": "Twitter secret", + "link": "https://developer.twitter.com", + "markdown": "![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium)" + }, + { + "name": "API_TWITTER_BEARER_TOKEN", + "source": "Twitter token", + "link": "https://developer.twitter.com", + "markdown": "![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium)" + }, + { + "name": "API_FRED_KEY", + "source": "FRED", + "link": "https://fred.stlouisfed.org/docs/api/api_key.html", + "markdown": "Go to: https://fred.stlouisfed.org\n\n![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png)\n\nClick on, \"My Account\", create a new account or sign in with Google:\n\n![FRED](https://user-images.githubusercontent.com/46355364/207827011-65cdd501-27e3-436f-bd9d-b0d8381d46a7.png)\n\nAfter completing the sign-up, go to \"My Account\", and select \"API Keys\". Then, click on, \"Request API Key\".\n\n![FRED](https://user-images.githubusercontent.com/46355364/207827577-c869f989-4ef4-4949-ab57-6f3931f2ae9d.png)\n\nFill 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.\n\n![FRED](https://user-images.githubusercontent.com/46355364/207828032-0a32d3b8-1378-4db2-9064-aa1eb2111632.png)" + }, + { + "name": "API_NEWS_TOKEN", + "source": "NewsAPI", + "link": "https://newsapi.org", + "markdown": "Go to: https://newsapi.org\n\n![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png)\n\nClick on, \"Get API Key\", and fill out the form.\n\n![News API](https://user-images.githubusercontent.com/46355364/207828421-76922bc2-cde0-493f-9eed-7f90eb831779.png)\n\nRegister for an account and the next screen will provide the API Key.\n\n![News API](https://user-images.githubusercontent.com/46355364/207828736-f0fce53b-f302-4456-adf9-8d50ac41fbe2.png)" + }, + { + "name": "OPENBB_RH_USERNAME", + "source": "Robinhood username", + "link": "https://robinhood.com/us/en/", + "markdown": "Go to: https://robinhood.com/us/en\n\n![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png)\n\nThe first login will request 2FA authorization from the device connected to the account." + }, + { + "name": "OPENBB_RH_PASSWORD", + "source": "Robinhood password", + "link": "https://robinhood.com/us/en/", + "markdown": "Go to: https://robinhood.com/us/en\n\n![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png)\n\nThe first login will request 2FA authorization from the device connected to the account." + }, + { + "name": "OPENBB_DG_USERNAME", + "source": "Degiro username", + "link": "https://www.degiro.com/", + "markdown": "Go to: https://www.degiro.com/\n\n![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png)\n\nClick on, \"Open an account\", and then go through the registration process.\n\nInstructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-)." + }, + { + "name": "OPENBB_DG_PASSWORD", + "source": "Degiro password", + "link": "https://www.degiro.com/", + "markdown": "Go to: https://www.degiro.com/\n\n![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png)\n\nInstructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-)." + }, + { + "name": "OPENBB_DG_TOTP_SECRET", + "source": "Degiro secret", + "link": "https://www.degiro.com/", + "markdown": "Go to: https://www.degiro.com/\n\n![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png)\n\nClick on, \"Open an account\", and then go through the registration process.\n\nInstructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-)." + }, + { + "name": "OPENBB_OANDA_ACCOUNT_TYPE", + "source": "Oanda account type", + "link": "https://developer.oanda.com", + "markdown": "Go to: https://developer.oanda.com\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png)\n\nAfter creating an account, follow the steps below.\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png)" + }, + { + "name": "OPENBB_OANDA_ACCOUNT", + "source": "Oanda account", + "link": "https://developer.oanda.com", + "markdown": "Go to: https://developer.oanda.com\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png)\n\nAfter creating an account, follow the steps below.\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png)" + }, + { + "name": "OPENBB_OANDA_TOKEN", + "source": "Oanda token", + "link": "https://developer.oanda.com", + "markdown": "Go to: https://developer.oanda.com\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png)\n\nAfter creating an account, follow the steps below.\n\n![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png)" + }, + { + "name": "API_TRADIER_TOKEN", + "source": "Tradier token", + "link": "https://tradier.com/products/market-data-api", + "markdown": "Go to: https://documentation.tradier.com\n\n![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png)\n\nClick 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." + }, + { + "name": "API_CMC_KEY", + "source": "Coinmarketcap key", + "link": "https://coinmarketcap.com/api/", + "markdown": "Go to: https://coinmarketcap.com/api\n\n![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png)\n\nClick on, \"Get Your Free API Key Now\", which opens to the page:\n\n![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831345-06a48efe-63b2-4804-bcf9-52fa4a73f7db.png)\n\nOnce the account has been created, copy the API key displayed within the dashboard.\n\n![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831705-e9f95018-bba7-49a9-b057-3443bc839861.png)" + }, + { + "name": "API_BINANCE_KEY", + "source": "Binance key", + "link": "https://www.binance.com/en/", + "markdown": "Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072\n\n![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png)\n\nThese instructions should provide clear guidance for obtaining an API Key." + }, + { + "name": "API_BINANCE_SECRET", + "source": "Binance secret", + "link": "https://www.binance.com/en/", + "markdown": "Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072\n\n![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png)\n\nThese instructions should provide clear guidance for obtaining an API Key." + }, + { + "name": "API_FINNHUB_KEY", + "source": "Finnhub key", + "link": "https://finnhub.io", + "markdown": "Go to: https://finnhub.io/\n\n![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png)\n\nClick on, \"Get free api key\", to open the page:\n\n![Finnhub](https://user-images.githubusercontent.com/46355364/207832185-f4c8406a-3b75-4acc-b3e8-3c4b3272d4da.png)\n\nOnce the account has been created, find the API key in the account dashboard.\n\n![Finnhub](https://user-images.githubusercontent.com/46355364/207832601-62007d95-410c-4d03-a5a3-b177d1894a4c.png)" + }, + { + "name": "API_BITQUERY_KEY", + "source": "Bitquery Key", + "link": "https://graphql.bitquery.io", + "markdown": "Go to: https://bitquery.io/\n\n![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png)\n\nClick \"Try GraphQL API\", which opens the following screen:\n\n![Try GraphQL API](https://user-images.githubusercontent.com/46355364/207840576-2c51a538-dd9b-484d-b11d-40e3e424df62.png)\n\nAfter creating an account and verifying the email address, get the value for the key by clicking on the \"API Key\" tab.\n\n![Get Bitquery API Key](https://user-images.githubusercontent.com/46355364/207840833-35c1b12c-9b4b-43fe-a33e-f7b92c43a011.png)" + }, + { + "name": "API_COINBASE_KEY", + "source": "Coinbase key", + "link": "https://www.coinbase.com/", + "markdown": "Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key\n\n![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png)\n\nFollow the instructions to obtain the credentials for the specific account." + }, + { + "name": "API_COINBASE_SECRET", + "source": "Coinbase secret", + "link": "https://www.coinbase.com/", + "markdown": "Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key\n\n![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png)\n\nFollow the instructions to obtain the credentials for the specific account." + }, + { + "name": "API_COINBASE_PASS_PHRASE", + "source": "Coinbase passphrase", + "link": "https://www.coinbase.com/", + "markdown": "Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key\n\n![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png)\n\nFollow the instructions to obtain the credentials for the specific account." + }, + { + "name": "API_COINGLASS_KEY", + "source": "Coinglass key", + "link": "https://www.coinglass.com/", + "markdown": "Go to: https://www.coinglass.com/\n\n![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png)\n\nClick, \"Log in\", and then sign up for an account. This opens the page:\n\n![Coinglass](https://user-images.githubusercontent.com/46355364/207844637-a9321889-c4d8-4d44-95fe-a6288a17ad19.png)" + }, + { + "name": "API_CRYPTO_PANIC_KEY", + "source": "Crypto Panic", + "link": "https://cryptopanic.com/developers/", + "markdown": "Go to: https://cryptopanic.com/developers/api/\n\n![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png)\n\nClick 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\".\n\n![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848971-3e4771b7-1faa-45fe-955f-81bd736b16b7.png)" + }, + { + "name": "API_EODHD_KEY", + "source": "EODHD", + "link": "https://eodhistoricaldata.com/", + "markdown": "Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J\n\n![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png)\n\nClicking on, \"Registration\", opens the page:\n\n![EODHD](https://user-images.githubusercontent.com/46355364/207849324-00d4a916-8260-45c0-9714-289e0a0574c0.png)\n\nOnce registered, the API Key will be next to \"API TOKEN\".\n\n![EODHD](https://user-images.githubusercontent.com/46355364/207849462-37471270-929a-45c5-a164-a84249b19231.png)" + }, + { + "name": "API_GITHUB_KEY", + "source": "GitHub", + "link": "https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api", + "markdown": "Go to: https://github.com\n\n![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png)\n\nSign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings.\n\n![GitHub](https://user-images.githubusercontent.com/46355364/207847215-3c04003f-26ea-4e62-9c13-ea35176bb5e3.png)\n\nSelect, \"New GitHub App\":\n\n![GitHub](https://user-images.githubusercontent.com/46355364/207847383-d24416c6-18be-43f2-ae7c-455e8372a6ed.png)\n\nAfter creating the app, the key will be issued." + }, + { + "name": "API_GLASSNODE_KEY", + "source": "Glassnode key", + "link": "https://docs.glassnode.com/basic-api/api-key#how-to-get-an-api-key/", + "markdown": "Go to: https://studio.glassnode.com\n\n![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png)\n\nClick on, \"Sign Up\", and create an account:\n\n![Glassnode](https://user-images.githubusercontent.com/46355364/207843795-dd2cdbdb-45eb-4c7d-b967-ae9857d4ea5d.png)\n\nAfter creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key.\n\n![Glassnode](https://user-images.githubusercontent.com/46355364/207843950-5f33f37d-0203-4302-a67f-198808f18e06.png)" + }, + { + "name": "API_SANTIMENT_KEY", + "source": "Santiment", + "link": "https://app.santiment.net/", + "markdown": "Go to: https://app.santiment.net\n\nClick on, \"Sign Up\", and register for an account.\n\n![Santiment](https://user-images.githubusercontent.com/46355364/207849732-4bae61de-2f62-4919-b85d-f418f1bbd0c4.png)\n\nNavigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key.\n\n![Santiment](https://user-images.githubusercontent.com/46355364/207849839-31d1d0a7-6936-4ebd-a7f8-1292f6317b07.png)" + }, + { + "name": "API_SHROOM_KEY", + "source": "ShroomDK", + "link": "https://sdk.flipsidecrypto.xyz/shroomdk", + "markdown": "Go to: https://sdk.flipsidecrypto.xyz/shroomdk\n\n![ShroomDK](https://user-images.githubusercontent.com/46355364/207850122-b8cd225e-0a65-4ea8-8069-0b40fff1600e.png)\n\nClick \"Mint Your ShroomDK API Key\", and sign up for an account.\n\n![ShroomDK](https://user-images.githubusercontent.com/46355364/207850176-f29cc73b-2b55-46e8-bce3-62c9342b6599.png)\n\nOnce created, connect a wallet to complete minting the NFT license. The API key will be displayed under the account.\n\n![ShroomDK](https://user-images.githubusercontent.com/46355364/207850380-b59554af-1e65-4616-921d-e02c9ecf1aad.png)" + }, + { + "name": "API_STOCKSERA_KEY", + "source": "Stocksera", + "link": "https://stocksera.pythonanywhere.com/", + "markdown": "Go to: https://stocksera.pythonanywhere.com\n\n![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png)\n\nClick on, \"Log in\", and create an account.\n\n![Stocksera](https://user-images.githubusercontent.com/46355364/207853985-46a7a17f-b6b2-442b-886d-f68b3ba2ad5a.png)\n\nOnce logged in, navigate to the \"Developers\" tab and copy the API key.\n\n![Stocksera](https://user-images.githubusercontent.com/46355364/207854224-e5ddace0-15d1-491c-b616-263cca0bef02.png)" + }, + { + "name": "API_TOKEN_TERMINAL_KEY", + "source": "Token Terminal", + "link": "https://tokenterminal.com/", + "markdown": "Go to: https://tokenterminal.com\n\n![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png)\n\nClick on, \"Log in\" and sign up for an account.\n\n![Token Terminal](https://user-images.githubusercontent.com/46355364/207850774-2071df78-3289-4c8e-9d64-156b9ec8ad81.png)\n\nVerify the email address, and then navigate go to the \"API\" tab and copy the API key to the clipboard.\n\n![Token Terminal](https://user-images.githubusercontent.com/46355364/207851035-71ea3eff-a11f-4835-8592-c07b3aa3f800.png)" + }, + { + "name": "API_WHALE_ALERT_KEY", + "source": "Whale Alert", + "link": "https://docs.whale-alert.io/", + "markdown": "Go to: https://docs.whale-alert.io\n\n![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png)\n\nClick on, \"sign up here\".\n\n![Whale Alert](https://user-images.githubusercontent.com/46355364/207842992-427f1d2c-b34e-41c9-85fd-18511805fd16.png)\n\nAfter creating the account, click on, \"Create\", to issue the API Key.\n\n![Whale Alert](https://user-images.githubusercontent.com/46355364/207843214-20232465-9a52-4b66-b01a-0b8cecbdd612.png)" + }, + { + "name": "API_DATABENTO_KEY", + "source": "Databento", + "link": "https://databento.com/", + "markdown": "Go to: https://docs.databento.com/getting-started\n\n![Databento](https://user-images.githubusercontent.com/85772166/221943074-7a5e55c1-6193-42d8-a04c-431603a69a05.png)\n\nClick 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).\n\n![Databento](https://user-images.githubusercontent.com/85772166/221943270-e0ada7bf-c7fb-46f2-bd7a-49afb3bc7bd8.png)" + }, + { + "name": "API_INTRINIO_KEY", + "source": "Intrinio", + "link": "https://intrinio.com/", + "markdown": "Go to: https://intrinio.com/starter-plan\n\n![Intrinio](https://user-images.githubusercontent.com/85772166/219207556-fcfee614-59f1-46ae-bff4-c63dd2f6991d.png)\n\nAn API key will be issued with a subscription. Find the token value within the account dashboard." + }, + { + "name": "API_BIZTOC_TOKEN", + "source": "BizToc", + "link": "https://biztoc.com", + "markdown": "The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc.\n\n![biztoc0](https://github.com/marban/OpenBBTerminal/assets/18151143/04cdd423-f65e-4ad8-ad5a-4a59b0f5ddda)\n\nIn the top right, select 'Sign Up'. After answering some questions, you will be prompted to select one of their plans.\n\n![biztoc1](https://github.com/marban/OpenBBTerminal/assets/18151143/9f3b72ea-ded7-48c5-aa33-bec5c0de8422)\n\nAfter signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key.\n\n![biztoc2](https://github.com/marban/OpenBBTerminal/assets/18151143/0f3b6c91-07e0-447a-90cd-a9e23522929f)", + }, +]