/crypto-heat

A simple tool to track cryptocurrency price change on 24 hour rolling window

Primary LanguageShellMIT LicenseMIT

Crypto Heat

Version License: MIT

Welcome to Crypto Heat! 🚀 A simple tool to track cryptocurrency price change on 24 hour rolling window


Features

📈 Displays top cryptocurrencies in gain or loss. 🔍 Option to limit the number of displayed results. 🌐 Supports English and French languages.


Usage

To use Crypto Heatmap, follow these simple steps:

  1. Clone the repository:

    git clone https://github.com/dofbi/crypto-heat.git
    cd crypto-heat
    
  2. Set the BINANCE_API environment variable:

    export BINANCE_API="https://www.binance.com/fapi/v1/ticker/24hr"
    chmod +x ./bin/cryptoheat
    
  3. Run the script specifying options as needed:

    ./bin/cryptoheat -n 20 -u
    
    

Data Source

The data displayed is retrieved from the Binance API.

Contributions

We welcome contributions! 🙌 Feel free to improve the script, fix bugs, or add features. Check the CONTRIBUTING file for how to contribute.

License

This project is licensed under the MIT License - see the LICENSE file for details.