> ⚠️ Security Warning: There are currently fraudulent repositories (e.g., under the user gesine1541ro7) impersonating `unicorn-binance-websocket-api` to distribute malware. Please ensure you are only using the official source: oliver-zehentleitner/unicorn-binance-websocket-api. [Read the full technical analysis and campaign details here!](https://blog.technopathy.club/security-warning-fraudulent-github-repository-impersonating-unicorn-binance-websocket-api) [![GitHub Release](https://img.shields.io/github/release/oliver-zehentleitner/unicorn-binance-trailing-stop-loss.svg?label=github)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/releases) [![GitHub Downloads](https://img.shields.io/github/downloads/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/total?color=blue)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/releases) [![PyPi Release](https://img.shields.io/pypi/v/unicorn-binance-trailing-stop-loss?color=blue)](https://pypi.org/project/unicorn-binance-trailing-stop-loss/) [![PyPi Downloads](https://pepy.tech/badge/unicorn-binance-trailing-stop-loss)](https://pepy.tech/project/unicorn-binance-trailing-stop-loss) [![Conda-Forge Version](https://img.shields.io/conda/v/conda-forge/unicorn-binance-trailing-stop-loss?color=blue&label=conda)](https://anaconda.org/conda-forge/unicorn-binance-trailing-stop-loss) [![Conda-Forge Downloads](https://img.shields.io/conda/dn/conda-forge/unicorn-binance-trailing-stop-loss?color=blue&label=downloads)](https://anaconda.org/conda-forge/unicorn-binance-trailing-stop-loss) [![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/blob/master/LICENSE) [![Supported Python Version](https://img.shields.io/pypi/pyversions/unicorn_binance_trailing_stop_loss.svg)](https://www.python.org/downloads/) [![PyPI - Status](https://img.shields.io/pypi/status/unicorn_binance_trailing_stop_loss.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/issues) [![codecov](https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/branch/master/graph/badge.svg?token=5I03AZ3F5S)](https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) [![CodeQL](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/codeql-analysis.yml) [![Unit Tests](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/unit-tests.yml) [![Build and Publish GH+PyPi](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/build_wheels.yml) [![Conda-Forge Build](https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/unicorn-binance-trailing-stop-loss-feedstock?branchName=main)](https://github.com/conda-forge/unicorn-binance-trailing-stop-loss-feedstock) [![Read the Docs](https://img.shields.io/badge/read-%20docs-yellow)](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/) [![Read How To`s](https://img.shields.io/badge/read-%20howto-yellow)](https://blog.technopathy.club/series/unicorn-binance-suite) [![Github](https://img.shields.io/badge/source-github-cbc2c8)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) [![Telegram](https://img.shields.io/badge/community-telegram-41ab8c)](https://t.me/unicorndevs) [![UBS-Banner](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-suite/master/images/logo/UBS-Banner-Readme.png)](https://github.com/oliver-zehentleitner/unicorn-binance-suite) # UNICORN Binance Trailing Stop Loss [Description](#description) | [Smart Entry](#smart-entry) | [Installation](#installation-and-upgrade) | [Documentation](#documentation) | [Examples](#examples) | [Change Log](#change-log) | [Wiki](#wiki) | [Social](#social) | [Bugs](#how-to-report-bugs-or-suggest-improvements) | [Contributing](#contributing) | [Disclaimer](#disclaimer) A Python library with a [command line interface](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/cli.html) for a trailing stop loss and smart entry on the Binance exchange. Please read carefully all provided [documentation](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/), our [disclaimer](#disclaimer) and look in the [issues](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/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](https://github.com/oliver-zehentleitner/unicorn-binance-suite)'. ## How to start the trailing stop loss engine: ```python from unicorn_binance_trailing_stop_loss 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: ```python ubtsl.stop_manager() ``` [Discover more possibilities](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/unicorn_binance_trailing_stop_loss.html). ## Start the engine on the command line (Windows, Linux and Mac): ```sh $ ubtsl --profile BTCUSDT_SELL --stoplosslimit 0.5% ``` Read about the [CLI usage](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/cli.html). ## Description The Python package [UNICORN Binance Trailing Stop Loss](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) provides a reuseable library and [CLI interface](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/cli.html). 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 afterward. 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](https://www.binance.com) | `binance.com` | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) | ![no](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/x-icon.png) | | [Binance Testnet](https://testnet.binance.vision/) | `binance.com-testnet` | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) | ![no](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/x-icon.png) | | [Binance Futures](https://www.binance.com) | `binance.com-futures` | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/x-icon.png) | | [Binance Isolated Margin](https://www.binance.com) | `binance.com-isolated_margin` | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) (experimental) | | [Binance Margin](https://www.binance.com) | `binance.com-margin` | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/ok-icon.png) | ![yes](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/x-icon.png) | - 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](https://github.com/oliver-zehentleitner/unicorn-binance-rest-api) and [UNICORN Binance WebSocket API](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api). - Available as a package via `pip` and `conda` as precompiled C extension with stub files for improved Intellisense functions and source code for easier debugging of the source code. [To the installation.](#installation-and-upgrade) - Well tested on Linux, Mac and Windows. If you like the project, please [![star](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/star.png)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/stargazers) it on [GitHub](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss)! ### 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.9 and runs smoothly up to and including Python 3.14. PyPy wheels are available for all supported Python versions. **conda-forge note:** Conda packages are provided for Python 3.10 – 3.14. Python 3.9 is not available on conda-forge — it was dropped from the global pinning after reaching end-of-life in October 2025. For Python 3.9, use `pip install`. The current dependencies are listed [here](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/blob/master/requirements.txt). If you run into errors during the installation take a look [here](https://github.com/oliver-zehentleitner/unicorn-binance-suite/wiki/Installation). ### Packages are created automatically with GitHub Actions When a new release is created, the [Build and Publish GH+PyPi](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/actions/workflows/build_wheels.yml) workflow spins up virtual Windows/Linux/Mac runners, compiles the Cython extensions, builds the wheels and publishes them on GitHub and PyPI. The conda-forge feedstock [conda-forge/unicorn-binance-trailing-stop-loss-feedstock](https://github.com/conda-forge/unicorn-binance-trailing-stop-loss-feedstock) picks up the new PyPI release automatically and builds the Conda packages on its own infrastructure. This is a transparent method that makes it possible to trace the source code behind a compilation. ### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/) Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/), these wheels offer significant advantages for Python developers: - ***Performance Boost with Cython Wheels:*** Cython is a programming language that supplements Python with static typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package. - ***PyPy Wheels for Enhanced Efficiency:*** PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly. Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that you get the optimized version of our package with minimal setup, allowing you to focus on development rather than configuration. #### Installation `pip install unicorn-binance-trailing-stop-loss` #### Update `pip install unicorn-binance-trailing-stop-loss --upgrade` ### conda ``` conda install -c conda-forge unicorn-binance-trailing-stop-loss ``` ### From source of the latest release with PIP from [GitHub](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) #### Linux, macOS, ... Run in bash: `pip install https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/archive/$(curl -s https://api.github.com/repos/oliver-zehentleitner/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 1.3.1) you determined [here](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/releases/latest): `pip install https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/archive/1.3.1.tar.gz --upgrade` ### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) This is not a release version and can not be considered to be stable! `pip install https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/tarball/master --upgrade` ### [Conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), [Virtualenv](https://virtualenv.pypa.io/en/latest/) or plain [Python](https://www.python.org) Download the [latest release](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/releases/latest) or the [current master branch](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/archive/master.zip) and use: - ./environment.yml - ./pyproject.toml - ./requirements.txt - ./setup.py ## Change Log [https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/CHANGELOG.html](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/CHANGELOG.html) ## Documentation - [General](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss) - [Modules](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/modules.html) - [CLI](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/cli.html) ## Examples - [example_logging.py](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/blob/master/example_logging.py) ## Related Articles - [How to create a Binance API Key and API Secret?](https://blog.technopathy.club/how-to-create-a-binance-api-key-and-api-secret) - [UNICORN Binance Suite Article Series](https://blog.technopathy.club/series/unicorn-binance-suite) ## Project Homepage [https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss) ## Wiki [https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/wiki](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/wiki) ## Social - [Discussions](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/discussions) - [https://t.me/unicorndevs](https://t.me/unicorndevs) - [https://dev.binance.vision](https://dev.binance.vision) ## Receive Notifications To receive notifications on available updates you can [![watch](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/watch.png)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/watchers) the repository on [GitHub](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss), write your [own script](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/blob/master/example_version_of_this_package.py) with using [`is_update_available()`](https://oliver-zehentleitner.github.io/unicorn-binance-trailing-stop-loss/unicorn_binance_trailing_stop_loss.html#unicorn_binance_trailing_stop_loss.manager.BinanceWebSocketApiManager.is_update_availabe). To receive news (like inspection windows/maintenance) about the Binance API`s subscribe to their telegram groups: - [https://t.me/binance_api_announcements](https://t.me/binance_api_announcements) - [https://t.me/binance_api_english](https://t.me/binance_api_english) - [https://t.me/Binance_USA](https://t.me/Binance_USA) - [https://t.me/TRBinanceTR](https://t.me/TRBinanceTR) - [https://t.me/BinanceExchange](https://t.me/BinanceExchange) ## How to report Bugs or suggest Improvements? [List of planned features](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) - click ![thumbs-up](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/thumbup.png) if you need one of them or suggest a new feature! Before you report a bug, [try the latest release](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss#installation-and-upgrade). 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 don't find an issue related to your topic, please open a new [issue](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/issues)! [Report a security bug!](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/security/policy) ## Contributing [UNICORN Binance Trailing Stop Loss](https://github.com/oliver-zehentleitner/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](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/blob/master/CONTRIBUTING.md). ### Contributors [![Contributors](https://contributors-img.web.app/image?repo=oliver-zehentleitner/unicorn-binance-trailing-stop-loss)](https://github.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/graphs/contributors) We ![love](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/master/images/misc/heart.png) open source! --- ## AI Integration This project provides a [`llms.txt`](https://raw.githubusercontent.com/oliver-zehentleitner/unicorn-binance-trailing-stop-loss/refs/heads/master/llms.txt) file for AI tools (ChatGPT, Claude, Copilot, etc.) with structured usage instructions, code examples and module routing. --- ## 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.