unicorn-binance-trailing-stop-loss 1.1.0

Description:

unicornbinancetrailingstoploss 1.1.0

UNICORN Binance Trailing Stop Loss
Description | Smart Entry | Installation |
Documentation | Examples | Change Log | Wiki | Social |
Notifications | Bugs |
Contributing | Disclaimer | Commercial Support
A Python library with a command line interface for a trailing stop loss and
smart entry on the Binance exchange.
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'.
Get a UNICORN Binance Suite License
To run modules of the UNICORN Binance Suite you need a valid license!
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="[email protected]",
send_from_email_address="[email protected]",
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()

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
binance.com




Binance Testnet
binance.com-testnet




Binance Futures
binance.com-futures




Binance Isolated Margin
binance.com-isolated_margin

(experimental)


Binance Margin
binance.com-margin






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 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, as it depends on Pythons latest asyncio features for asynchronous/concurrent
processing.
For the PyPy interpreter we offer packages only from Python version 3.9 and higher.
Anaconda packages are available from Python version 3.8 and higher.
The current dependencies are listed here.
If you run into errors during the installation take a look here.
A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI
Our Cython and PyPy Wheels are available on PyPI,
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
A Conda Package of the latest version with conda from Anaconda
The unicorn-binance-trailing-stop-loss package is also available as a Cython version for the linux-64, osx-64
and win-64 architectures with Conda through the lucit channel.
For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
conda-forge channel.
Installation
conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-trailing-stop-loss

Update
conda update -c lucit 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 1.1.0) you determined
here:
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/archive/1.1.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
./pyproject.toml
./requirements.txt
./setup.py

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

General
Modules
CLI

Examples

example_logging.py

Howto

How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice

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

Discussions
https://t.me/unicorndevs
https://dev.binance.vision
https://community.binance.org

Receive Notifications
To receive notifications on available updates you can

the repository on GitHub, write your
own script
with using
is_update_available()
or you use the
monitoring API service.
Follow us on LinkedIn,
X or Facebook!
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_english
https://t.me/Binance_USA
https://t.me/TRBinanceTR
https://t.me/BinanceExchange

How to report Bugs or suggest Improvements?
List of planned features -
click 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

We 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.
Commercial Support

Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!