Summary This Python SDK provides a robust, high-performance interface to Binance's WebSocket APIs, enabling real-time data streaming and account management. It simplifies direct WebSocket integration with automatic reconnection and asynchronous handling. Ideal for traders, analysts, and developers needing reliable, low-latency access across Binance spot, margin, futures, and testnet environments.

How It Works

The library utilizes Python's asyncio for concurrent stream processing, with each stream managed in a separate thread. It offers flexible data consumption via buffer polling, callbacks, or asyncio queues. Key performance gains are achieved through Cython and PyPy wheels, compiled C extensions. The system ensures fully managed WebSocket connections with 100% auto-reconnect and resilience against Binance maintenance windows.

Quick Start & Requirements

• Primary install: pip install unicorn-binance-websocket-api
• Prerequisites: Python 3.9-3.14.
• Dependencies: Optimized Cython/PyPy wheels available. Socks5 proxy support included.
• Links:
  • Project Homepage: https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api
  • Documentation: https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/
  • Examples: https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/tree/master/examples

Highlighted Details

• Performance: Leverages Cython/PyPy wheels for significant execution speed improvements.
• Robustness: Features 100% auto-reconnect and handles Binance maintenance windows.
• Full API Access: Supports sending orders and cancellations directly via WebSocket.
• Exchange Support: Covers Binance spot, margin, futures, options, US, TR, and testnets.
• Data Handling: Flexible output formats, stream buffers, and real-time stream status signals.

Maintenance & Community

This open-source project welcomes contributions. Community discussions are available via Telegram (https://t.me/unicorndevs). Update notifications can be received through GitHub actions or the is_update_available() function.

Licensing & Compatibility

The specific license is not explicitly stated, though it is an open-source project. The library is tested and compatible across Linux, macOS, and Windows on various architectures (x86, arm32, arm64), with no memory leaks reported for Python 3.9-3.14.

Limitations & Caveats

Conda support is noted as pending migration to conda-forge. The README warns against using the library to circumvent Binance's geographical restrictions. Development versions are explicitly marked as unstable.