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.com")
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:
        print(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 “binance.com”.

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

Description

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 www.binance.com, www.binance.je, www.binance.us or www.jex.com - for the DEX you need a user address from www.binance.org or testnet.binance.org 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.com")

    • Binance Margin BinanceWebSocketApiManager(exchange="binance.com-margin")

    • Binance Futures BinanceWebSocketApiManager(exchange="binance.com-futures")

    • Binance Jersey BinanceWebSocketApiManager(exchange="binance.je")

    • Binance US BinanceWebSocketApiManager(exchange="binance.us")

    • Binance JEX BinanceWebSocketApiManager(exchange="jex.com")

    • Binance DEX BinanceWebSocketApiManager(exchange="binance.org")

    • Binance DEX testnet BinanceWebSocketApiManager(exchange="binance.org-testnet")

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

Windows

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

pip install https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/archive/1.11.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/oliver-zehentleitner/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

Documentation

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!

Contributing

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!