Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.41 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.41 KB

Crypto Price Alert 🔔

The script uses the Coingecko API to get real-time prices of your configured asset list and send you an email or a telegram message, in case that the 24h change of your asset in percentage gets above/below your configured limit.

Getting started

  1. Prerequisites

    Before you start, you should have Python 3 with Pip installed.

    Then set up a virtual environment and install the required packages inside the project.

    pip install -r requirements.txt
  2. Configuration

    Now you can configure and assets you want to keep an eye on in a .env file. You should also configure a mail server or create a telegram bot (default) via the BotFather and paste the API key into the config. There already is a .env.example file, which you can rename and use. You need to set the time interval in seconds in which the script is getting executed. It is also possible to define a list of assets you are interested in. The script will check if any of the assets is currently trending at the coingecko search chart.

    TIME_INTERVAL=300
    WATCHED_ASSETS=['BTC', 'ETH', '...']
    UPPER_LIMIT=10
  3. Start the script.

    You can start the script by running the main file and follow the instructions in the console. Enjoy experimenting with the script.

    python main.py