UNICORN Binance Suite

Description | Installation | How To | Change Log | Documentation | Social | Notifications | Bugs | Contributing | Disclaimer

Description

LUCIT's UNICORN Binance Suite is a comprehensive collection of open-source Python packages designed for building sophisticated automated trading systems. Tailored for Python developers, this suite offers seamless integration with the Binance API, enabling the creation of advanced and professional trading bots for streamlined and efficient cryptocurrency trading.

The suite is the most stable, powerful and convenient way to interact with various Binance API endpoints via REST and Websocket and to manage local order books and trailing stop losses.

All libraries in the suite are coordinated with each other, interlock perfectly, are fully documented and offer standardized interfaces and tools for the programmer. LUCIT continuously develops the modules, fixes bugs, tests the libraries extensively and offers fast, direct and free support.

All modules are delivered optimized as PyPy and as Python C Extension (Cython) via PyPi and Anaconda. The package creation runs completely transparently directly from the respective GitHub repository through GitHub Actions and is deployed directly to PyPi and Anaconda in a traceable manner. This process makes it tamper-proof for you to understand which code is contained in which package and can therefore easily install optimized builds for the platform, architecture and Python version used.

Get help with the integration of the UNICORN Binance Suite modules!

Modules of the UNICORN Binance Suite

• UNICORN Binance Local Depth Cache: A Python SDK from LUCIT to access and manage multiple local Binance DepthCaches with Python in a simple, fast, flexible, robust and fully-featured way.
• UNICORN Binance REST API: A Python SDK by LUCIT to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr) in a simple, fast, flexible, robust and fully-featured way.
• UNICORN Binance Trailing Stop Loss: A Python SDK and Command Line Tool from LUCIT with a trailing stop loss engine for the Binance Exchanges.
• UNICORN Binance WebSocket API: A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a simple, fast, flexible, robust and fully-featured way.
• UnicornFy: A Python SDK by LUCIT to convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

If you like our projects, please them on GitHub!

Get a UNICORN Binance Suite License

To run modules of the UNICORN Binance Suite you need a valid license!

Installation and Upgrade

The modules require Python 3.7 or above, as they depend 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.

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

Packages are created automatically with GitHub Actions

When a new release is to be created, we start two GitHubActions:

• Build and Publish Anaconda
• Build and Publish GH+PyPi

Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on GitHub, PYPI and Anaconda. 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

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-suite

Update

pip install unicorn-binance-suite --upgrade

A Conda Package of the latest version with conda from Anaconda

The unicorn-binance-suite 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-suite

Update

conda update -c lucit unicorn-binance-suite

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-suite/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

Windows

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

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/2.0.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-suite/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-suite.docs.lucit.tech/changelog.html

Please look for the information in the README.md of the responsible subrepository.

Documentation

• General

Please look for the information in the README.md of the responsible subrepository.

Howto

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

Project Homepage

https://www.lucit.tech/unicorn-binance-suite.html

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki

Social

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

Receive Notifications

Follow us on LinkedIn, X or Facebook!

Please look for the information in the README.md of the responsible subrepository for spezific notifications.

How to report Bugs or suggest Improvements?

Please look for the information in the README.md of the responsible subrepository.

Contributing

Please look for the information in the README.md of the responsible subrepository.

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.

SOCKS5 Proxy / Geoblocking

We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US and that this restriction must not be circumvented!

The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to use US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run on servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and companies from the US analyze binance.com market data - as long as they do not trade there.