diff options
| author | Miguel Mota <hello@miguelmota.com> | 2024-04-07 15:34:11 -0700 |
|---|---|---|
| committer | Miguel Mota <hello@miguelmota.com> | 2024-04-07 15:45:52 -0700 |
| commit | cbe355701546a181e77ff536371813161ad5b5ac (patch) | |
| tree | 52153b37d8d53007af0c943021309c04e073f31f /docs/content | |
| parent | 409479636d26b88a57c1265e584c07ff4debb5af (diff) | |
Diffstat (limited to 'docs/content')
| -rw-r--r-- | docs/content/config.md | 3 | ||||
| -rw-r--r-- | docs/content/faq.md | 27 |
2 files changed, 27 insertions, 3 deletions
diff --git a/docs/content/config.md b/docs/content/config.md index 8570449..3466bf9 100644 --- a/docs/content/config.md +++ b/docs/content/config.md @@ -123,6 +123,9 @@ refresh_rate = 60 [coinmarketcap] pro_api_key = "" + +[coingecko] + pro_api_key = "" ``` ## List of actions diff --git a/docs/content/faq.md b/docs/content/faq.md index f835ec6..dc253f7 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -97,7 +97,7 @@ draft: false Run cointop with the `--clean` flag to delete the cache. If you're still not seeing any data, then please [submit an issue](https://github.com/cointop-sh/cointop/issues/new). -## How do I get a CoinMarketCap Pro API key? +## How do I get a CoinMarketCap Pro (Paid) API key? Create an account on [CoinMarketCap](https://pro.coinmarketcap.com/signup) and visit the [Account](https://pro.coinmarketcap.com/account) page to copy your Pro API key. @@ -122,7 +122,28 @@ draft: false cointop --coinmarketcap-api-key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` -## How do I add my CoinGecko Pro API key? +## How do I add my CoinGecko Demo (Free) API key? + + Add the API key in the cointop config file: + + ```toml + [coingecko] + api_key = "CG-xxxxxxxxxxxxxxxxxxxxxxxx" + ``` + + Alternatively, you can export the environment variable `COINGECKO_API_KEY` containing the API key in your `~/.bashrc` + + ```bash + export COINGECKO_API_KEY=CG-xxxxxxxxxxxxxxxxxxxxxxxx + ``` + + You may also set the API key on start: + + ```bash + cointop --coingecko-api-key=CG-xxxxxxxxxxxxxxxxxxxxxxxx + ``` + +## How do I add my CoinGecko Pro (Paid) API key? Add the API key in the cointop config file: @@ -140,7 +161,7 @@ draft: false You may also set the API key on start: ```bash - cointop --coingecko-api-key=CG-xxxxxxxxxxxxxxxxxxxxxxxx + cointop --coingecko-pro-api-key=CG-xxxxxxxxxxxxxxxxxxxxxxxx ``` ## I can I add my own API to cointop? |