Skip to main content

A Python API 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 easy, fast, flexible, robust and fully-featured way.

Project description

Get a UNICORN Binance Suite License

GitHub Release GitHub Downloads Anaconda Release Anaconda Downloads PyPi Release PyPi Downloads License Supported Python Version PyPI - Status codecov CodeQL Unit Tests Build and Publish GH+PyPi Build and Publish Anaconda Read the Docs Read How To`s Github Telegram Gitter Get Free Professional Support ChatGPT UNICORN Binance Suite Assistant


UNICORN Binance WebSocket API

Description | Live Demo | Installation | How To | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Disclaimer | Commercial Support

A Python API 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 easy, fast, flexible, robust and fully-featured way.

Part of 'UNICORN Binance Suite'.

Get help with the integration of the UNICORN Binance Suite modules from the UNICORN Binance Suite Assistant GPT or a real human LUCIT employee.

Get a UNICORN Binance Suite License

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

Receive Data from Binance WebSockets

Create a multiplex websocket connection to Binance with a stream_buffer with just 3 lines of code:

from unicorn_binance_websocket_api import BinanceWebSocketApiManager

ubwa = BinanceWebSocketApiManager(exchange="")
ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])

And 4 more lines to print the receives:

while True:
    oldest_data_from_stream_buffer = ubwa.pop_stream_data_from_stream_buffer()
    if oldest_data_from_stream_buffer:

Or with a callback function just do:

from unicorn_binance_websocket_api import BinanceWebSocketApiManager

def process_new_receives(stream_data):

ubwa = BinanceWebSocketApiManager(exchange="")
ubwa.create_stream(channels=['trade', 'kline_1m'], 
                   markets=['btcusdt', 'bnbbtc', 'ethbtc'], 

Basically that's it, but there are more options.

Convert received raw webstream data into well-formed Python dictionaries with UnicornFy:

unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_data_from_stream_buffer)


ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")

Subscribe / unsubscribe new markets and channels:

markets = ['engbtc', 'zileth']
channels = ['kline_5m', 'kline_15m', 'kline_30m', 'kline_1h', 'kline_12h', 'depth5']

ubwa.subscribe_to_stream(stream_id=stream_id, channels=channels, markets=markets)

ubwa.unsubscribe_from_stream(stream_id=stream_id, markets=markets)

ubwa.unsubscribe_from_stream(stream_id=stream_id, channels=channels)

Send Requests to Binance WebSocket API

Place orders, cancel orders or send other requests via WebSocket:

from unicorn_binance_websocket_api import BinanceWebSocketApiManager

def process_api_responses(stream_data):


ubwa = BinanceWebSocketApiManager(exchange="")
api_stream = ubwa.create_stream(api=True, 
orig_client_order_id = ubwa.api.create_order(order_type="LIMIT", 
ubwa.api.cancel_order(orig_client_order_id=orig_client_order_id, symbol="BUSDUSDT")                                             

Here you can find a complete guide on how to process requests via the Binance WebSocket API!

Stop ubwa after usage to avoid memory leaks


Discover even more possibilities or use this script to stream everything from "".

This should be known by everyone using this lib:


The Python package UNICORN Binance WebSocket API provides an API to the Binance Websocket API`s of Binance (+Testnet), Binance Margin (+Testnet), Binance Isolated Margin (+Testnet), Binance Futures (+Testnet), Binance COIN-M Futures, Binance US, Binance TR, Binance DEX and Binance DEX Testnet and supports sending requests to the Binance Websocket API and the streaming of all public streams like trade, kline, ticker, depth, bookTicker, forceOrder, compositeIndex, blockheight etc. and also all private userData streams which needs to be used with a valid api_key and api_secret from the Binance Exchange, or - for the DEX you need a user address from or and you can get funds for the testnet.

Use the UNICORN Binance REST API in combination.

What are the benefits of the UNICORN Binance WebSocket API?

Exchange Exchange string WS WS API
Binance yes yes
Binance Testnet yes yes
Binance Margin yes no
Binance Margin Testnet yes no
Binance Isolated Margin yes no
Binance Isolated Margin Testnet yes no
Binance USD-M Futures yes no
Binance USD-M Futures Testnet yes no
Binance Coin-M Futures yes no
Binance US yes no
Binance TR yes no
Binance DEX yes no
Binance DEX Testnet yes no

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

Live Demo

This live demo script is streaming from and runs on a cx31 virtual machine of HETZNER CLOUD - get 20 EUR starting credit!

Open live monitor!


(Refresh update once a minute!)

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.


pip install unicorn-binance-websocket-api


pip install unicorn-binance-websocket-api --upgrade

A Conda Package of the latest version with conda from Anaconda

The unicorn-binance-websocket-api 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.


conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-websocket-api


conda update -c lucit unicorn-binance-websocket-api

From source of the latest release with PIP from GitHub

Linux, macOS, ...

Run in bash:

pip install$(curl -s | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade


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

pip install --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 --upgrade

Conda environment, Virtualenv or plain Python

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

  • ./environment.yml
  • ./pyproject.toml
  • ./requirements.txt
  • ./

Change Log




Project Homepage



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 LinkedIn, X or Facebook!

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 don't find an issue related to your topic, please open a new issue!

Report a security bug!


UNICORN Binance WebSocket API 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.



We love open source!


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 Moreover, it also seems justified that traders, data scientists and companies from the US analyze market data - as long as they do not trade there.

Commercial Support

Get professional and fast support

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unicorn-binance-websocket-api-2.1.4.tar.gz (1.2 MB view hashes)

Uploaded source

Built Distributions

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page