A python API to use the Binance Websocket API's (com, com-margin, com-futures, jersey, us, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.
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'])
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)
Thats it!
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)
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 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 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.
The module requires python 3.5.3 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, org) in combination.
-
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 DEX
BinanceWebSocketApiManager(exchange="binance.org") - Binance DEX testnet
BinanceWebSocketApiManager(exchange="binance.org-testnet")
- Binance
-
Streams are processing asynchronous/concurrent (python asyncio) and each stream is started in a separate thread.
-
No use of the twisted module, so you can use this lib in a daemonized application (compatible with python-daemon).
-
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.
-
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(),is_websocket_uri_length_valid(),replace_stream(),wait_till_stream_has_started(),get_current_receiving_speed()and many more, explore them here. -
Monitoring API service and a check_command for ICINGA/Nagios
-
Excessively tested on Linux, Mac and Windows
If you like the project, please 
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
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
Use the below command with the version (such as 1.3.8) you determined here:
pip install https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/archive/1.3.8.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
- Howto: UNICORN Binance WebSocket API
- Howto: Monitoring UNICORN Binance WebSocket API Manager with ICINGA2
https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api
https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api
https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/CHANGELOG.md
https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki
To receive notifications on available updates you can 
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:
- https://t.me/binance_api_announcements
- https://t.me/binance_api_english
- https://t.me/BinanceExchange
- https://t.me/Binance_Jersey
- https://t.me/Binance_USA
- https://t.me/BinanceDEXchange
List of planned features -
click 
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: https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues
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 