UNICORN Binance Trailing Stop Loss

LUCIT-UBTSL-Banner

GitHub Release GitHub Downloads Conda Release Conda Downloads PyPi Release PyPi Downloads License Supported Python Version PyPI - Status Language grade: Python Total alerts Unit Tests Azure Pipelines codecov Read the Docs Github Telegram Gitter

UNICORN Binance Trailing Stop Loss

Description | Smart Entry | Installation | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Disclaimer

A Python library with a command line interface for a trailing stop loss and smart entry on the Binance exchange.

As UNICORN Binance Trailing Stop Loss Bot we also offer a standalone version that does not require an installed Python environment.

Please read carefully all provided documentation, our disclaimer and look in the issues about known problems before using this tool - you use it at your own risk!

If you put this engine on a market, you should stop trading manually on this market yourself!

Part of 'UNICORN Binance Suite'.

How to start the trailing stop loss engine:

from unicorn_binance_trailing_stop_loss.manager import BinanceTrailingStopLossManager

def callback_error(msg):
    print(f"STOP LOSS ERROR - ENGINE IS SHUTTING DOWN! - {msg}")
    ubtsl.stop_manager()

def callback_finished(msg):
    print(f"STOP LOSS FINISHED - ENGINE IS SHUTTING DOWN! - {msg}")
    ubtsl.stop_manager()

def callback_partially_filled(msg):
    print(f"STOP LOSS PARTIALLY_FILLED - ENGINE IS STILL RUNNING! - {msg}")

ubtsl = BinanceTrailingStopLossManager(callback_error=callback_error,
                                       callback_finished=callback_finished,
                                       callback_partially_filled=callback_partially_filled,
                                       binance_public_key="aaa",
                                       binance_private_key="bbb",
                                       borrow_threshold="100%",
                                       exchange="binance.com",
                                       keep_threshold="20%",
                                       market="BTCUSDT",
                                       print_notifications=True,
                                       reset_stop_loss_price=True,
                                       send_to_email_address="blah@example.com",
                                       send_from_email_address="blub@example.com",
                                       send_from_email_password="pass",
                                       send_from_email_server="mail.example.com",
                                       send_from_email_port=25,
                                       stop_loss_limit="1.5%",
                                       stop_loss_order_type="LIMIT",
                                       stop_loss_price=88,
                                       stop_loss_start_limit="0.5%",
                                       telegram_bot_token="telegram_bot_token",
                                       telegram_send_to="telegram_send_to")

Stop the engine:

ubtsl.stop_manager()

Get the right logger:

logging.getLogger("unicorn_binance_trailing_stop_loss")

Discover more possibilities.

Start the engine on the command line (Windows, Linux and Mac):

$ ubtsl --profile BTCUSDT_SELL --stoplosslimit 0.5%

Read about the CLI usage.

Description

The Python package UNICORN Binance Trailing Stop Loss provides a reuseable library and CLI interface.

After starting the engine, a stop/loss order is placed on Binance and trailed until it is completely fulfilled. If desired, a notification can be sent via email and Telegram afterwards. Then it calls the function passed with the callback_finished parameter or on error it calls the function passed to callback_error.

Partially filled orders are currently not handled by the engine. If you want to react individually to this event, you can use the function provided to callback_partially_filled.

In addition, there is a smart entry option called jump-in-and-trail. This offers the possibility to buy spot, future and margin assets with a limit or market order and then to trail a stop/loss order until sold.

What are the benefits of the UNICORN Binance Trailing Stop Loss?

  • Using websockets for push notifications about price updates and order status updates. (Fast data transfer and low used API weight!)
  • Smart entry
  • Supported exchanges:
Exchange Exchange string trail jump-in-and-trail
Binance BinanceTrailingStopLossManager(exchange="binance.com") yes no
Binance Testnet BinanceTrailingStopLossManager(exchange="binance.com-testnet") yes no
Binance Futures BinanceTrailingStopLossManager(exchange="binance.com-futures") yes yes
Binance Isolated Margin BinanceTrailingStopLossManager(exchange="binance.com-isolated_margin") yes yes (experimental)
Binance Margin BinanceTrailingStopLossManager(exchange="binance.com-margin") yes yes
  • All parameters that expect numbers can be configured with fixed numerical values as well as with percentage values.
  • Integrated notification system (e-Mail and Telegram).
  • Test "notification", "binance-connectivity" and "streams" without starting the engine.
  • Powered by UNICORN Binance REST API and UNICORN Binance WebSocket API.
  • Well tested on Linux, Mac and Windows.

If you like the project, please star it on GitHub!

Smart entry

This function is still in an experimental phase and only available for Isolated Margin.

Do a smart entry by using engine = 'jump-in-and-trail' and providing borrow_threshold.

By activating the jump-in-and-trail engine, the engine first buys the predefined asset amount and then trails them automatically.

Installation and Upgrade

The module requires Python 3.7 or above.

The current dependencies are listed here.

If you run into errors during the installation take a look here.

If you just want to install the UNICORN Binance Trailing Stop Loss Bot read this!

A wheel and a source file of the latest release with pip from PyPI

pip install unicorn-binance-trailing-stop-loss --upgrade

A conda package of the latest release with conda from Anaconda via CONDA-FORGE.

conda install -c conda-forge unicorn-binance-trailing-stop-loss

conda update -c conda-forge unicorn-binance-trailing-stop-loss

From source of the latest release with PIP from Github

Linux, macOS, ...

Run in bash:

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

Windows

Use the below command with the version (such as 0.7.0) you determined here:

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/0.7.0.tar.gz --upgrade

From the latest source (dev-stage) with PIP from Github

This is not a release version and can not be considered to be stable!

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/tarball/master --upgrade

Conda environment, Virtualenv or plain Python

Download the latest release or the current master branch and use:

  • ./environment.yml
  • ./requirements.txt
  • ./setup.py

Change Log

https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CHANGELOG.html

Documentation

Examples

Project Homepage

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/wiki

Social

Receive Notifications

To receive notifications on available updates you can watch the repository on GitHub, write your own script with using is_update_available() or you use the monitoring API service.

Follow us on Twitter or on Facebook for general news about the unicorn-binance-suite!

To receive news (like inspection windows/maintenance) about the Binance API`s subscribe to their telegram groups:

How to report Bugs or suggest Improvements?

List of planned features - click thumbs-up if you need one of them or suggest a new feature!

Before you report a bug, try the latest release. If the issue still exists, provide the error trace, OS and Python version and explain how to reproduce the error. A demo script is appreciated.

If you dont find an issue related to your topic, please open a new issue!

Report a security bug!

Contributing

UNICORN Binance Trailing Stop Loss is an open source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To contribute follow this guide.

Contributors

Contributors

We love open source!

Disclaimer

This project is for informational purposes only. You should not construe this information or any other material as legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation, endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such jurisdiction.

If you intend to use real money, use it at your own risk.

Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities of any kind, including but not limited to direct or indirect damages for loss of profits.

Arrange a free & no obligation consultation

Together we will clarify your needs and you will receive a detailed offer

Make an appointment now