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:
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)
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 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.
What are the benefits of the UNICORN Binance WebSocket API?
Fully managed websockets and 100% auto-reconnect!
- Binance Margin
- Binance Futures
- Binance Jersey
- Binance US
- Binance JEX
- Binance DEX
- Binance DEX 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).
If you can not store your data in cause of a temporary technical issue, you can kick back the data to the
stream_bufferwhich 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
unsubscribe_from_stream()and many more, explore them here.
Excessively tested on Linux, Mac and Windows
If you like the project, please 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.
pip install unicorn-binance-websocket-api --upgrade
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
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
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
- Howto: UNICORN Binance WebSocket API
- Howto: Monitoring UNICORN Binance WebSocket API Manager with ICINGA2
Source, Downloads, Examples, ...
To receive notifications on available updates you can
the repository on GitHub, write your
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 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!