unicorn-binance-websocket-api 2.1.0

An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, jersey, us, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.

UNICORN Binance WebSocket API

Description | Live Demo | Installation | How To | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Disclaimer | Commercial Support

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.

Convert received raw webstream data into well-formed Python dictionaries with UnicornFy:

unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_data_from_stream_buffer)

or

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!

Get the right logger:

logging.getLogger("unicorn_binance_websocket_api")

Discover even more possibilities or use this script to stream everything from "binance.com".

This should be known by everyone using this lib:

• Best practice solutions for a maximum stable connection
• Do you want consistent data from binance?

Description

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!

• Support for Binance Websocket API, send requests like create_order, cancel_open_orders and many more directly over websocket!

• Supported exchanges:

Exchange	Exchange string	WS API
Binance	binance.com
Binance Testnet	binance.com-testnet
Binance Margin	binance.com-margin
Binance Margin Testnet	binance.com-margin-testnet
Binance Isolated Margin	binance.com-isolated_margin
Binance Isolated Margin Testnet	binance.com-isolated_margin-testnet
Binance USD-M Futures	binance.com-futures
Binance USD-M Futures Testnet	binance.com-futures-testnet
Binance Coin-M Futures	binance.com-coin_futures
Binance US	binance.us
Binance TR	trbinance.com
Binance DEX	binance.org
Binance DEX Testnet	binance.org-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!

• Supports subscribe/unsubscribe on all exchanges! (Take a look to the max supported subscriptions per stream in the endpoint configuration overview!)

• UNICORN Binance WebSocket API respects Binance's API guidelines and protects you from avoidable reconnects and bans.

• Support for multiple private !userData streams with different api_key and api_secret. (example_multiple_userdata_streams.py)

• 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_buffer which stores the receives in the RAM till you are able to process the data in the normal way again. Learn more!

• Use separate stream_buffers for specific streams or users!

• Watch the stream_signal_buffer to receive CONNECT, DISCONNECT and FIRST_RECEIVED_DATA signals 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 output parameter of create_stream() to control the output format.

• Helpful management features like get_binance_api_status(), get_current_receiving_speed(), get_errors_from_endpoints(), get_limit_of_subscriptions_per_stream(), get_request_id(), get_result_by_request_id(), get_results_from_endpoints(), get_stream_buffer_length(), get_stream_info(), get_stream_list(), get_stream_id_by_label(), get_stream_statistic(), get_stream_subscriptions(), get_version(), is_update_available(), pop_stream_data_from_stream_buffer(), print_summary(), replace_stream(), set_stream_label(), set_ringbuffer_error_max_size(), subscribe_to_stream(), stop_stream(), stop_manager_with_all_streams(), unsubscribe_from_stream(), wait_till_stream_has_started() and many more! Explore them here.

• Monitor the status of the created BinanceWebSocketApiManager() instance within your code with get_monitoring_status_plain() and specific streams with get_stream_info().

• 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 :)

• Monitoring API service and a check_command for ICINGA/Nagios

• Integration of test cases and examples.

• Customizable base URL.

• Socks5 Proxy support:

  ubwa = BinanceWebSocketApiManager(exchange="binance.com", socks5_proxy_server="127.0.0.1:9050") 
  

  Read the docs or this how to for more information or try example_socks5_proxy.py.

• Excessively tested on Linux, Mac and Windows

If you like the project, please it on GitHub!

Live Demo

This live demo script is streaming from binance.com and runs on a cx31 virtual machine of HETZNER CLOUD - get 20 EUR starting credit!

Open live monitor!

(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.

The current dependencies are listed here.

If you run into errors during the installation take a look here.

A binary, PyPy or source code based wheel of the latest version with pip from PyPI

pip install unicorn-binance-websocket-api --upgrade

A conda package of the latest release with conda from Anaconda via CONDA-FORGE.

conda install -c conda-forge unicorn-binance-websocket-api

conda update -c conda-forge unicorn-binance-websocket-api

From source of the latest release with PIP from GitHub

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

Windows

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

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.0.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/LUCIT-Systems-and-Development/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
• ./pyproject.toml
• ./requirements.txt
• ./setup.py

Change Log

https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html

Documentation

• General
• Modules

Examples

• example_apache_kafka.py
• example_binance_coin_futures.py
• example_binance_dex.py
• example_binance_futures.py
• example_binance_futures_1s.py
• example_binance_us.py
• example_bookticker.py
• example_ctrl-c.py
• example_demo.py
• example_easy_migration_from_python-binance.py
• example_interactive_mode.py
• example_kline_1m_with_unicorn_fy.py
• example_logging.py
• example_monitoring.py
• example_multi_stream.py
• example_multiple_userdata_streams.py
• example_pandas_ta-lib.py
• example_plotting_last_price.py
• example_process_streams.py
• example_socks5_proxy.py
• example_stream_buffer.py
• example_stream_buffer_extended.py
• example_stream_buffer_fifo-lifo.py
• example_stream_everything.py
• example_stream_management.py
• example_stream_management_extended.py
• example_stream_signals.py
• example_stream_signals_callback.py
• example_subscribe.py
• example_ticker_and_miniticker.py
• example_trade_stream.py
• example_trbinance.com.py
• example_userdata_stream.py
• example_userdata_stream_new_style.py
• example_version_of_this_package.py
• example_websocket_api.py

Howto

• How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice
• Create and Cancel Orders via WebSocket on Binance
• How to Download Klines from Binance using Python?
• Passing Binance Market Data to Apache Kafka in Python with aiokafka
• How to Connect to binance.com Websockets using Python via a Socks5 Proxy

Project Homepage

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki

Social

• Discussions
• Gitter
• https://t.me/unicorndevs
• https://dev.binance.vision
• https://community.binance.org

Receive Notifications

To receive notifications on available updates you can the repository on GitHub, write your own script with using is_update_available() or you use the monitoring API service.

Follow us on LinkedIn, X or Facebook!

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/Binance_USA
• https://t.me/TRBinanceTR
• https://t.me/BinanceDEXchange
• https://t.me/BinanceExchange

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!

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 and reporting dead links to new features. To contribute follow this guide.

Contributors

We open source!

Disclaimer

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.

Commercial Support

Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!