UNICORN Binance WebSocket API¶
An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.
Part of ‘UNICORN Binance Suite’.
Get a UNICORN Binance Suite License¶
To run modules of the UNICORN Binance Suite you need a valid license!
Receive Data from Binance WebSockets¶
Create a multiplex websocket connection to Binance with a
stream_buffer with just 3 lines of code:¶
import unicorn_binance_websocket_api ubwa = BinanceWebSocketApiManager(exchange="binance.com") ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])
And 4 more lines to print the receives:¶
while True: oldest_data_from_stream_buffer = ubwa.pop_stream_data_from_stream_buffer() if oldest_data_from_stream_buffer: print(oldest_data_from_stream_buffer)
Or with a callback function just do:¶
from unicorn_binance_websocket_api.manager import BinanceWebSocketApiManager def process_new_receives(stream_data): print(str(stream_data)) ubwa = BinanceWebSocketApiManager(exchange="binance.com") ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'], process_stream_data=process_new_receives)
Basically that’s it, but there are more options.
unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_data_from_stream_buffer)
ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
Subscribe / unsubscribe new markets and channels:¶
markets = ['engbtc', 'zileth'] channels = ['kline_5m', 'kline_15m', 'kline_30m', 'kline_1h', 'kline_12h', 'depth5'] ubwa.subscribe_to_stream(stream_id=stream_id, channels=channels, markets=markets) ubwa.unsubscribe_from_stream(stream_id=stream_id, markets=markets) ubwa.unsubscribe_from_stream(stream_id=stream_id, channels=channels)
Send Requests to Binance WebSocket API¶
Place orders, cancel orders or send other requests via WebSocket:¶
from unicorn_binance_websocket_api.manager import BinanceWebSocketApiManager def process_api_responses(stream_data): print(str(stream_data)) api_key = "YOUR_BINANCE_API_KEY" api_secret = "YOUR_BINANCE_API_SECRET" ubwa = BinanceWebSocketApiManager(exchange="binance.com") api_stream = ubwa.create_stream(api=True, api_key=api_key, api_secret=api_secret, process_stream_data=process_api_responses) orig_client_order_id = ubwa.api.create_order(order_type="LIMIT", price=1.1, quantity=15.0, side="SELL", symbol="BUSDUSDT") ubwa.api.cancel_order(orig_client_order_id=orig_client_order_id, symbol="BUSDUSDT")
Here you can find a complete guide on how to process requests via the Binance WebSocket API!
ubwa after usage to avoid memory leaks¶
This should be known by everyone using this lib:
The Python package UNICORN Binance WebSocket API provides an API to the Binance Websocket API`s of Binance (+Testnet), Binance Margin (+Testnet), Binance Isolated Margin (+Testnet), Binance Futures (+Testnet), Binance COIN-M Futures, Binance US, Binance TR, Binance DEX and Binance DEX Testnet and supports sending requests to the Binance Websocket API and the streaming of all public streams like trade, kline, ticker, depth, bookTicker, forceOrder, compositeIndex, blockheight etc. 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, testnet.binance.vision 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.
Use the UNICORN Binance REST API in combination.
What are the benefits of the UNICORN Binance WebSocket API?¶
Fully managed websockets and 100% auto-reconnect! Also handles maintenance windows!
|Exchange||Exchange string||WS API|
|Binance Margin Testnet||
|Binance Isolated Margin||
|Binance Isolated Margin Testnet||
|Binance USD-M Futures||
|Binance USD-M Futures Testnet||
|Binance Coin-M Futures||
|Binance DEX Testnet||
Streams are processing asynchronous/concurrent (Python asyncio) and each stream is started in a separate thread, so you don’t need to deal with asyncio in your code!
UNICORN Binance WebSocket API respects Binance’s API guidelines and protects you from avoidable reconnects and bans.
Support for multiple private
!userDatastreams with different
Pick up the received data from the
stream_buffer- 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!
FIRST_RECEIVED_DATAsignals about the streams! Learn more!
Get the received data unchanged as received, as Python dictionary or converted with UnicornFy into well-formed Python dictionaries. Use the
create_stream()to control the output format.
Helpful management features like
wait_till_stream_has_started()and many more! Explore them here.
Nice to use with iPython: “IPython (Interactive Python) is a command shell for interactive computing that offers introspection, rich media, shell syntax, tab completion, and history.” (example_interactive_mode.py)
Also, nice to use with the Jupyter Notebook :)
Customizable base URL.
Socks5 Proxy support:
ubwa = BinanceWebSocketApiManager(exchange="binance.com", socks5_proxy_server="127.0.0.1:9050")
Excessively tested on Linux, Mac and Windows
If you like the project, please it on GitHub!
(Refresh update once a minute!)
Installation and Upgrade¶
The module requires Python 3.7 or above, as it depends on Pythons latest asyncio features for asynchronous/concurrent processing.
For the PyPy interpreter we offer packages only from Python version 3.9 and higher.
Anaconda packages are available from Python version 3.8 and higher.
The current dependencies are listed here.
If you run into errors during the installation take a look here.
Performance Boost with Cython Wheels: Cython is a programming language that supplements Python with static typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package.
PyPy Wheels for Enhanced Efficiency: PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly.
Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that you get the optimized version of our package with minimal setup, allowing you to focus on development rather than configuration.
pip install unicorn-binance-websocket-api
pip install unicorn-binance-websocket-api --upgrade
For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
conda config --add channels conda-forge conda config --add channels lucit conda install -c lucit unicorn-binance-websocket-api
conda update -c lucit unicorn-binance-websocket-api
Linux, macOS, …¶
Run in bash:
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade
Use the below command with the version (such as 2.1.2) you determined here:
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.1.2.tar.gz --upgrade
This is not a release version and can not be considered to be stable!
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/tarball/master --upgrade
Conda environment, Virtualenv or plain Python¶
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 don’t 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 and reporting dead links to new features. To contribute follow this guide.
We open source!
This project is for informational purposes only. You should not construe this information or any other material as legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation, endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such jurisdiction.
If you intend to use real money, use it at your own risk!¶
Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities of any kind, including but not limited to direct or indirect damages for loss of profits.
SOCKS5 Proxy / Geoblocking¶
We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US and that this restriction must not be circumvented!
The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to use US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run on servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and companies from the US analyze binance.com market data - as long as they do not trade there.
Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!