orfino

This Python program is a notification service for filled orders on crypto exchanges.

If you want to benefit while trading and additionally support the development of this tool, consider to use my referral links to the exchanges I use the most:

• Binance: Referral ID 80028974
• Kucoin: Referral Code r3L3UJ8

⚠️ Disclaimer

Please note that this tool comes without any kind of warranty.

🔌 Installation

Assuming pip being available on your system, just use

pip install https://github.com/maximilianwank/orfino/archive/refs/heads/main.zip

It is recommended to use some virtual environment like venv or others.

⚙️ Configuration

A config sample would be the following:

[binance]
key = foo
secret = bar

[kucoin]
key = foo
secret = bar
password = baz

[notifymydevice]
key = foo

[timedrotatingfile]
filename = orfino.log
count = 14
when = midnight

With ; you can comment sections.

💱 Exchanges

Exchanges can be added by a section with the name of the exchange and different keys like key (for an API key), secret (for the API secret) and an optional password. Using ccxt for the API calls, in theory many exchanges are supported. However, only Binance and Kucoin have been tested. Please feel free to reach out if you want exchanges to be added.

🔔 Notify My Device

Notifications on filled orders can be sent via Notify My Device. You just have to register and install the app on your respective device.

🗃️ Timed Rotating File Logger

You can use a timed rotating file logger to save a log of various messages. Have a glance on the official Python docs. The supported keys are filename, count (for backupCount) and when.

🏃 Run the program

▶️ Manual start

One can start the program with the command line using its module name. Note that you must pass the path to your config file as argument:

python3 -m orfino /path/to/your/config.ini

Make sure the Python interpreter is the one from your virtual environment.

😈 As daemon with systemd

It is convenient to run orfino as daemon. This can be achieved for example with systemd, which is part of many Linux distributions anyway. To do so, save

[Unit]
Description=Notification service for filled orders on crypto exchanges
Wants=network-online.target
After=network-online.target

[Service]
Type=simple
ExecStart=/path/to/your/venv/bin/python3 -m orfino /path/to/your/config.ini
Restart=on-failure
RestartSec=60s

[Install]
WantedBy=multi-user.target

to /etc/systemd/system/orfino.service. After that, enter

systemctl daemon-reload
systemctl enable orfino
systemctl start orfino

to actually run orfino as daemon.