Skip to content
A python API to use the Binance Websocket API`s (com, com-margin, com-futures, jersey, us, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.
Python Shell Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github new issue template Feb 10, 2020
docs docs Feb 26, 2020
pypi update pypi Feb 13, 2020
sphinx docs Feb 26, 2020
tools div Feb 10, 2020
unicorn_binance_websocket_api fix OSError in self.monitoring_api_server.start() Feb 26, 2020
.gitignore some text changes Apr 6, 2019 fix OSError in self.monitoring_api_server.start() Feb 26, 2020 change uri to contact form Nov 2, 2019 add link to issues Dec 27, 2019
LICENSE update docs Nov 25, 2019 fix #11 Feb 26, 2020 change uri to contact form Nov 2, 2019 release 1.10.0 Feb 13, 2020 logging Feb 25, 2020 print_stream_info, print_summary Feb 22, 2020 1.10.6 Feb 24, 2020 1.10.6 Feb 24, 2020 change subscriptions and fix issue 37 Feb 16, 2020
environment.yml fix #11 Feb 26, 2020 1.10.6 Feb 24, 2020 logging Feb 6, 2020 logging Feb 6, 2020 adding binance jex Feb 24, 2020 logging Feb 6, 2020 div Feb 10, 2020 update example Feb 22, 2020 cleaning Feb 21, 2020 logging Feb 6, 2020 div Feb 10, 2020 1.10.5 Feb 21, 2020 Update Feb 23, 2020 release 1.10.0 Feb 13, 2020 updates Feb 19, 2020 updates Feb 19, 2020 unicornfy Feb 20, 2020 updates Feb 19, 2020 logging Feb 6, 2020 fixing typos Jan 29, 2020
requirements.txt fix #11 Feb 26, 2020 dev version Feb 26, 2020 dex websockets: subscribe/unsubscribe - beta Jan 30, 2020 cleaning Feb 21, 2020 count subscriptions cex/dex Feb 22, 2020 count subscriptions cex Feb 22, 2020 unitttests Feb 22, 2020

GitHub release GitHub PyPI - Python Version PyPI - Status PyPI - Wheel

UNICORN Binance WebSocket API

A python API to use the Binance Websocket API's (com, com-margin, com-futures, jersey, us, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.

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

from unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager import BinanceWebSocketApiManager

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

And 4 more lines to print the receives:

while True:
    oldest_stream_data_from_stream_buffer = binance_websocket_api_manager.pop_stream_data_from_stream_buffer()
    if oldest_stream_data_from_stream_buffer:

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_stream_data_from_stream_buffer)

Subscribe / unsubscribe new markets and channels:

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

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

binance_websocket_api_manager.unsubscribe_from_stream(stream_id, markets=markets)

binance_websocket_api_manager.unsubscribe_from_stream(stream_id, channels=channels)

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

This should be known by everyone using this lib: Do you want consistent data from binance?


The python module UNICORN Binance WebSocket API provides an API to the Binance Websocket API`s of Binance, Binance Margin, Binance Futures, Binance Jersey, Binance US, Binance JEX, Binance DEX and Binance DEX Testnet and supports the streaming of all public streams like trade, kline, ticker, depth, !bookTicker and blockheight 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.

The module requires python 3.6.1 or above, as it depends on pythons latest asyncio features for asynchronous/concurrent processing. The current dependencies are listed here.

Be aware that the Binance websocket API just offers to receive data. If you would like to set orders, withdraws and so on, you have to use the Binance Rest API (com, je, us, jex, org) in combination.

What are the benefits of the UNICORN Binance WebSocket API?

  • Fully managed websockets and 100% auto-reconnect!

  • Supported exchanges:

    • Binance BinanceWebSocketApiManager(exchange="")
    • Binance Margin BinanceWebSocketApiManager(exchange="")
    • Binance Futures BinanceWebSocketApiManager(exchange="")
    • Binance Jersey BinanceWebSocketApiManager(exchange="")
    • Binance US BinanceWebSocketApiManager(exchange="")
    • Binance JEX BinanceWebSocketApiManager(exchange="")
    • Binance DEX BinanceWebSocketApiManager(exchange="")
    • Binance DEX testnet BinanceWebSocketApiManager(exchange="")
  • Streams are processing asynchronous/concurrent (python asyncio) and each stream is started in a separate thread, but you dont need to deal with asyncio in your code!

  • No use of the twisted module, so you can use this lib in a daemonized application (compatible with python-daemon).

  • Supports subscribe/unsubscribe on all exchanges!

  • No subscription limits! This multi stream was subscribed to everything that binance offered (except !userData): 20412_subscriptions

  • If you can not store your data in cause of a temporary technical issue, you can kick back the data to the stream_buffer which stores the receives in the RAM till you are able to process the data in the normal way again. Learn more!

  • Compatible with UnicornFy to convert received raw data from crypto API endpoints into well-formed python dictionaries.

  • Helpful management features like get_binance_api_status(), get_stream_info(), get_stream_list(), get_stream_statistic(), get_stream_subscriptions(), replace_stream(), wait_till_stream_has_started(), get_current_receiving_speed(), subscribe_to_stream(), unsubscribe_from_stream() and many more, explore them here.

  • Monitoring API service and a check_command for ICINGA/Nagios icinga2-demo

  • Excessively tested on Linux, Mac and Windows

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

Installation and Upgrade

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

Please note: UnicornFy is not longer part of this package, visit for further information.

A wheel of the latest release with PIP from PyPI

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

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 1.11.0) 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
  • ./requirements.txt
  • ./


Demo source




Source, Downloads, Examples, ...

Change Log


Receive Notifications

To receive notifications on available updates you can watch the repository on GitHub, write your own script with using binance_websocket_api_manager.is_update_availabe() or you use the monitoring API service.

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 dont 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 to new features. To contribute follow this guide.

We love open source!

You can’t perform that action at this time.