chadsr / waybar-crypto

A Waybar module for displaying cryptocurrency market information

waybar-crypto

A Waybar module for displaying cryptocurrency market information, utilising the CoinMarketCap API.

Requirements

• python >=3.8
• python-requests

Installation

Clone to the Waybar modules directory

cd ~/.config/waybar/modules
git clone https://github.com/chadsr/waybar-crypto.git crypto && cd crypto/
git submodule update --init --recursive --remote --progress

# **only** If you for some reason don't want to install python-requests with a package manager, or setup a venv
pip install --user --requirement <(poetry export --without=dev --format requirements.txt)

Install the needed fonts

 # Use ~/.local/share/fonts/TTF (user scope, recommended) or /usr/share/fonts/TTF (system scope)
mkdir -p ~/.local/share/fonts/TTF
ln -s ./.submodules/cryptofont/fonts/cryptofont.ttf ~/.local/share/fonts/TTF

# Rebuild font cache
fc-cache -f

Update Waybar configuration

Found at ~/.config/waybar/config by default

"custom/crypto": {
    "format": "{}",
    "interval": 600,
    "return-type": "json",
    "exec": "~/.config/waybar/modules/crypto/waybar_crypto.py",
    "exec-if": "ping pro-api.coinmarketcap.com -c1"
}

Style the module

Found at ~/.config/waybar/style.css by default

#custom-crypto {
    font-family: cryptofont, monospace;
}

Configuration

Copy the example configuration file config.ini.example to config.ini.

The information displayed can then be customised by editing the config.ini configuration file. (e.g. ~/.config/waybar/modules/crypto/config.ini if you followed the instructions above)

[general]
currency = eur
currency_symbol = €
display = price,percent_change_24h,percent_change_7d
api_key = your_coinmarketcap_api_key

[btc]
icon = 
price_precision = 2
change_precision = 2
volume_precision = 2

[eth]
icon = 
price_precision = 2
change_precision = 2
volume_precision = 2

• currency: Any valid currency code should be accepted
• currency_symbol: A corresponding symbol of the currency you wish to display
• api_key: CoinmarketCap API key obtained from their API Dashboard.
• display: A list of metrics you wish to display for each crypto currency. No spaces. Valid options are:
  • price: Displays the current price.
  • percent_change_1h: Price change over the past hour.
  • percent_change_24h: Price change over the past 24 hours.
  • percent_change_7d: Price change over the past week.
  • percent_change_30d: Price change over the past thirty days.
  • percent_change_60d: Price change over the past sixty days.
  • percent_change_90d: Price change over the past ninety days.
  • volume_24h: Market volume in your chosen currency, over the past 24 hours.
  • volume_change_24h: Market volume change in your chosen currency, over the past 24 hours.

Alternatively, the CoinMarketCap API key can be set through the environment variable COINMARKETCAP_API_KEY, if you do not wish to save it to the config.ini configuration file.

Adding Cryptocurrencies

For each cryptocurrency you wish to display, add a section as shown in the example above, where the section name is the short cryptocurrency name as found on CoinMarketCap.

Valid options:

• icon: A character symbol to display next to this cryptocurrency's metrics.
• in_tooltip: Whether to display the data in the tooltip instead of the bar (defaults to false).
• price_precision The decimal precision at which to display the price value of the cryptocurrency.
• change_precision The decimal precision at which to display the change value(s) of the cryptocurrency.
• volume_precision The decimal precision at which to display the volume value of the cryptocurrency.