Description | Live Demo | Installation | How To | Documentation | Change Log | Wiki | Social | Notifications | Bugs | Contributing
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.
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)
Basically that's it, but there are more options:
unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_stream_data_from_stream_buffer)
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?
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, forceOrder 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.
BinanceWebSocketApiManager(exchange="binance.com")
BinanceWebSocketApiManager(exchange="binance.com-margin")
BinanceWebSocketApiManager(exchange="binance.com-futures")
BinanceWebSocketApiManager(exchange="binance.je")
BinanceWebSocketApiManager(exchange="binance.us")
BinanceWebSocketApiManager(exchange="jex.com")
BinanceWebSocketApiManager(exchange="binance.org")
BinanceWebSocketApiManager(exchange="binance.org-testnet")
!userData
streams with different api_key
and api_secret
. (example_multiple_userdata_streams.py)stream_buffer
which stores the receives in the RAM till you are able to process the data in the normal way again.
Learn more!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.If you like the project, please it on GitHub!
This live demo script is streaming everything from binance.com, hosted on a small VPS (2vCPU, 2GB RAM) at HETZNER Cloud with 20TB traffic for ~4 EUR per month (no affiliate link, its just a good service!)
(Refresh update once a minute!)
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
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.16.0) you determined here:
pip install https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/archive/1.16.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
Download the latest release or the current master branch and use:
https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api
https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/CHANGELOG.html
https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/wiki
To receive notifications on available updates you can
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:
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!
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 open source!
Since you are probably a developer yourself, you will understand very well that the creation of open source software is not free - it requires technical knowledge, a lot of time and also financial expenditure.
If you would like to help me to dedicate my time and energy to this project, donations are very welcome.
BTC: 39fS74fvcGnmEk8JUV8bG6P1wkdH29GtsA
DASH: XsRhBuPkXGF9WvifdpkVhTGSmVT4VcuQZ7
ETH: 0x1C15857Bf1E18D122dDd1E536705748aa529fc9C
LTC: LYNzHMFUbee3siyHvNCPaCjqXxjyq8YRGJ
XMR: 85dzsTRh6GRPGVSJoUbFDwAf9uwwAdim1HFpiGshLeKHgj2hVqKtYVPXMZvudioLsuLS1AegkUiQ12jwReRwWcFvF7kDAbF
ZEC: t1WvQMPJMriGWD9qkZGDdE9tTJaawvmsBie
If you would like to hire me for a Python project, you can book me through my company LUCIT.