UNICORN Binance WebSocket API

Get professional and fast support

Github GitHub Release GitHub Downloads Conda Release Conda Downloads PyPi Release PyPi Downloads License Supported Python Version PyPI - Status CodeQL Unit Tests Azure Pipelines codecov Read the Docs Read How To`s Telegram Gitter


UNICORN Binance WebSocket API

Description | Live Demo | Installation | How To | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Leave a review | Disclaimer

An unofficial Python API 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'.

Receive Data from Binance WebSockets

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

import unicorn_binance_websocket_api

ubwa = unicorn_binance_websocket_api.BinanceWebSocketApiManager(exchange="binance.com")
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.manager import BinanceWebSocketApiManager

def process_new_receives(stream_data):

ubwa = BinanceWebSocketApiManager(exchange="binance.com")
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.manager import BinanceWebSocketApiManager

def process_api_responses(stream_data):


ubwa = BinanceWebSocketApiManager(exchange="binance.com")
api_stream = ubwa.create_stream(api=True, api_key=api_key, api_secret=api_secret,

orig_client_order_id = ubwa.api.create_order(order_type="LIMIT", price=1.1, 
                                             quantity=15.0, side="SELL", symbol="BUSDUSDT")
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!

Get the right logger:


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

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 www.binance.com, testnet.binance.vision or www.binance.us - for the DEX you need a user address from www.binance.org or testnet.binance.org 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
Binance binance.com
Binance Testnet binance.com-testnet
Binance Margin binance.com-margin
Binance Margin Testnet binance.com-margin-testnet
Binance Isolated Margin binance.com-isolated_margin
Binance Isolated Margin Testnet binance.com-isolated_margin-testnet
Binance USD-M Futures binance.com-futures
Binance USD-M Futures Testnet binance.com-futures-testnet
Binance Coin-M Futures binance.com-coin_futures
Binance US binance.us
Binance TR trbinance.com
Binance DEX binance.org
Binance DEX Testnet binance.org-testnet

ubwa = BinanceWebSocketApiManager(exchange="binance.com", socks5_proxy_server="")

Read the docs or this how to for more information or try example_socks5_proxy.py.

  • Excessively tested on Linux, Mac and Windows

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

Live Demo

This live demo script is streaming from binance.com 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.

The current dependencies are listed here.

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

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

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

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

conda install -c conda-forge unicorn-binance-websocket-api

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

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


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

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/1.46.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-websocket-api/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





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

You want to say Thank You?

We hope you are enjoying using our libraries and that they are proving to be useful to you. If you have a moment, we would greatly appreciate it if you could leave us a review on Google. Thank you for your support!


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.

Do you have any questions? We will be happy to answer them in our chat - usually you will receive an answer within a few minutes during our opening hours.

Arrange a free & no obligation consultation

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

Make an appointment now

Our Stack

Automation and Integration of Trading Platforms

REST API`s and Websockets

We specialize in connecting to crypto API endpoints and are maintainers of the UnicornFy, UNICORN Binance REST API and UNICORN Binance Websocket API for Python.

Binance, KuCoin, Pancakeswap, CoinMarketCap, CoinDesk, ...


Interactive Brokers


Yahoo Finance API


Boto3, Azure SDK, ...

AI / Neural Networks




Data Science



Infrastructure On-Prem or Cloud (AWS, Azure, ...)

Linux (hardened), EC2



Data Lakes

Serverless Microservices