-
-
Notifications
You must be signed in to change notification settings - Fork 164
/
meta.yaml
688 lines (533 loc) · 52.1 KB
/
meta.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
{% set name = "unicorn-binance-websocket-api" %}
{% set version = "2.9.0" %}
package:
name: {{ name|lower }}
version: {{ version }}
source:
path: .
build:
number: 0
script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
script_env:
- PYTHONNOUSERSITE=1
channels:
- lucit
- conda-forge
- default
requirements:
build:
- {{ compiler('c') }}
- mypy
host:
- python
- mypy
- lucit::lucit-licensing-python >=1.8.2
- lucit::unicorn-fy >=0.14.2
- lucit::unicorn-binance-rest-api >=2.5.1
- cheroot
- colorama
- Cython
- flask
- flask-restful
- orjson
- psutil
- PySocks
- requests >=2.31.0
- simplejson
- websocket-client
- websockets==11.0.3
- typing_extensions
run:
- python
- lucit::lucit-licensing-python >=1.8.2
- lucit::unicorn-fy >=0.14.2
- lucit::unicorn-binance-rest-api >=2.5.1
- cheroot
- colorama
- Cython
- flask
- flask-restful
- orjson
- psutil
- PySocks
- requests >=2.31.0
- simplejson
- websocket-client
- websockets==11.0.3
- typing_extensions
dependencies:
- anaconda-client
- conda-build
test:
imports:
- unicorn_binance_websocket_api
commands:
- pip check
requires:
- pip
about:
summary: |
A Python SDK by LUCIT 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 simple, fast, flexible, robust and fully-featured way.
description: |
[](https://shop.lucit.services)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases)
[](https://pypi.org/project/unicorn-binance-websocket-api/)
[](https://pepy.tech/project/unicorn-binance-websocket-api)
[](https://unicorn-binance-websocket-api.docs.lucit.tech/license.html)
[](https://www.python.org/downloads/)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues)
[](https://codecov.io/gh/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/codeql-analysis.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/unit-tests.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/build_wheels.yml)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/build_conda.yml)
[](https://unicorn-binance-websocket-api.docs.lucit.tech)
[](https://medium.lucit.tech)
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
[](https://t.me/unicorndevs)
[](https://gitter.im/unicorn-binance-suite/unicorn-binance-websocket-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://www.lucit.tech/get-support.html)
[](https://www.lucit.tech/unicorn-binance-websocket-api.html)
# UNICORN Binance WebSocket API
[Description](#description) | [Live Demo](#live-demo) | [Installation](#installation-and-upgrade) | [How To](#howto) |
[Documentation](#documentation) | [Examples](#examples) | [Change Log](#change-log) | [Wiki](#wiki) | [Social](#social) |
[Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) |
[Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support)
A Python SDK by [LUCIT](https://www.lucit.tech) 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 simple, fast, flexible, robust and fully-featured way.
Part of '[UNICORN Binance Suite](https://www.lucit.tech/unicorn-binance-suite.html)'.
[Get help](https://www.lucit.tech/get-support.html) with the integration of the `UNICORN Binance Suite` modules!
## Get a UNICORN Binance Suite License
To run modules of the *UNICORN Binance Suite* you need a [valid license](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8#4ca4)!
## Receive Data from Binance WebSockets
### [Create a multiplex websocket connection](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream) to Binance with a [`stream_buffer`](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_buffer%60) with just 3 lines of code
```
from unicorn_binance_websocket_api import BinanceWebSocketApiManager
ubwa = BinanceWebSocketApiManager(exchange="binance.com")
ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])
```
#### And 4 more lines to print out the data
```
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](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=process_stream_data#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream) just do
```
from unicorn_binance_websocket_api 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)
```
### Or with an [async callback function](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=process_stream_data#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream) just do
```
from unicorn_binance_websocket_api import BinanceWebSocketApiManager
import asyncio
async def process_new_receives(stream_data):
print(stream_data)
await asyncio.sleep(1)
ubwa = BinanceWebSocketApiManager()
ubwa.create_stream(channels=['trade', 'kline_1m'],
markets=['btcusdt', 'bnbbtc', 'ethbtc'],
process_stream_data_async=process_new_receives)
```
### Or await the stream data in an asyncio coroutine
All the methods of data collection presented have their own advantages and disadvantages. However, this is the
generally recommended method for processing data from streams.
```
from unicorn_binance_websocket_api import BinanceWebSocketApiManager
import asyncio
async def main():
async def process_asyncio_queue(stream_id=None):
print(f"Start processing the data from stream '{ubwa.get_stream_label(stream_id)}':")
while ubwa.is_stop_request(stream_id) is False:
data = await ubwa.get_stream_data_from_asyncio_queue(stream_id)
print(data)
ubwa.asyncio_queue_task_done(stream_id)
ubwa.create_stream(channels=['trade'],
markets=['ethbtc', 'btcusdt'],
stream_label="TRADES",
process_asyncio_queue=process_asyncio_queue)
while not ubwa.is_manager_stopping():
await asyncio.sleep(1)
with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
try:
asyncio.run(main())
except KeyboardInterrupt:
print("\r\nGracefully stopping ...")
except Exception as e:
print(f"\r\nERROR: {e}\r\nGracefully stopping ...")
```
Basically that's it, but there are more options.
## Convert received stream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html)
```
unicorn_fied_stream_data = UnicornFy.binance_com_websocket(data)
```
or
```
ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
```
## [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) 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](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.api.BinanceWebSocketApiApi.create_order), [cancel orders](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.api.BinanceWebSocketApiApi.cancel_order) or [send other requests](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#module-unicorn_binance_websocket_api.api) via WebSocket
```
from unicorn_binance_websocket_api import BinanceWebSocketApiManager
api_key = "YOUR_BINANCE_API_KEY"
api_secret = "YOUR_BINANCE_API_SECRET"
async def process_api_responses(stream_id=None):
while ubwa.is_stop_request(stream_id=stream_id) is False:
data = await ubwa.get_stream_data_from_asyncio_queue(stream_id=stream_id)
print(data)
ubwa.asyncio_queue_task_done(stream_id=stream_id)
ubwa = BinanceWebSocketApiManager(exchange="binance.com")
api_stream = ubwa.create_stream(api=True,
api_key=api_key,
api_secret=api_secret,
output="UnicornFy",
process_asyncio_queue=process_api_responses)
response = ubwa.api.get_server_time(return_response=True)
print(f"Binance serverTime: {response['result']['serverTime']}")
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](https://medium.lucit.tech/create-and-cancel-orders-via-websocket-on-binance-7f828831404) you can find a complete
guide on
[how to process requests via the Binance WebSocket API](https://medium.lucit.tech/create-and-cancel-orders-via-websocket-on-binance-7f828831404)!
## Stop `ubwa` after usage to avoid memory leaks
When you instantiate UBWA with `with`, `ubwa.stop_manager()` is automatically executed upon exiting the `with`-block.
```
with BinanceWebSocketApiManager() as ubwa:
ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="TRADES")
```
Without `with`, you must explicitly execute `ubwa.stop_manager()` yourself.
```
ubwa.stop_manager()
```
## `stream_signals` - know the state of your streams
Usually you want to know when a stream is working and when it is not. This can be useful to know that your own system is
currently "blind" and you may want to close open positions to be on the safe side, know that indicators will now provide
incorrect values or that you have to reload the missing data via REST as an alternative.
For this purpose, the UNICORN Binance WebSocket API provides so-called
[`stream_signals`](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60),
which are used to tell your code in real time when a stream is connected, when it received its first data record, when
it was disconnected and stopped, and when the stream cannot be restored.
```
from unicorn_binance_websocket_api import BinanceWebSocketApiManager
import time
def process_stream_signals(signal_type=None, stream_id=None, data_record=None, error_msg=None):
print(f"Received stream_signal for stream '{ubwa.get_stream_label(stream_id=stream_id)}': "
f"{signal_type} - {stream_id} - {data_record} - {error_msg}")
with BinanceWebSocketApiManager(process_stream_signals=process_stream_signals) as ubwa:
ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="TRADES")
time.sleep(2)
print(f"Waiting 5 seconds and then stop the stream ...")
time.sleep(5)
```
## More?
[Discover even more possibilities](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html),
[use this script](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_stream_everything.py)
to stream everything from "binance.com" or try our [examples](#examples)!
This should be known by everyone using this lib:
- [Best practice solutions for a maximum stable connection](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/Best-practice-solutions-for-a-maximum-stable-connection!)
- [Do you want consistent data from binance?](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/discussions/254)
## Description
The Python package [UNICORN Binance WebSocket API](https://www.lucit.tech/unicorn-binance-websocket-api.html)
provides an API to the Binance Websocket API`s of
[Binance](https://github.com/binance-exchange/binance-official-api-docs)
([+Testnet](https://testnet.binance.vision/)),
[Binance Margin](https://binance-docs.github.io/apidocs/spot/en/#user-data-streams)
([+Testnet](https://testnet.binance.vision/)),
[Binance Isolated Margin](https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin)
([+Testnet](https://testnet.binance.vision/)),
[Binance Futures](https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams)
([+Testnet](https://testnet.binancefuture.com)),
[Binance COIN-M Futures](https://binance-docs.github.io/apidocs/delivery/en/#change-log),
[Binance US](https://github.com/binance-us/binance-official-api-docs),
[Binance TR](https://www.trbinance.com/apidocs),
[Binance DEX](https://docs.binance.org/api-reference/dex-api/ws-connection.html) and
[Binance DEX Testnet](https://docs.binance.org/api-reference/dex-api/ws-connection.html) and supports sending requests
to the [Binance Websocket API](https://developers.binance.com/docs/binance-trading-api/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](https://medium.lucit.tech/how-to-create-a-binance-api-key-and-api-secret-3bb5f47e360d)
from the Binance Exchange [www.binance.com](https://www.binance.com/),
[testnet.binance.vision](https://testnet.binance.vision/) or
[www.binance.us](https://www.binance.us) - for the DEX you need a user address from
[www.binance.org](https://www.binance.org/en/create) or [testnet.binance.org](https://testnet.binance.org/en/create),
and you can [get funds](https://www.binance.vision/tutorials/binance-dex-funding-your-testnet-account) for the testnet.
Use the [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html) in combination.
### What are the benefits of the UNICORN Binance WebSocket API?
- Fully managed websockets and 100% auto-reconnect! Also handles maintenance windows!
- No memory leaks from Python version 3.8 to 3.12!
- The full [UBS stack](https://www.lucit.tech/unicorn-binance-suite.html) is delivered as a compiled C extension for
maximum performance.
- Support for [Binance Websocket API](https://developers.binance.com/docs/binance-trading-api/websocket_api), send
requests like [create_order](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.ws_api.BinanceWebSocketApiWsApi.create_order),
[cancel_open_orders](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.ws_api.BinanceWebSocketApiWsApi.cancel_open_orders)
and [many more](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#module-unicorn_binance_websocket_api.ws_api) directly over websocket!
- [Supported exchanges](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/Binance-websocket-endpoint-configuration-overview):
| Exchange | Exchange string | WS | WS API |
|--------------------------------------------------------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [Binance](https://www.binance.com) | `binance.com` |  |  |
| [Binance Testnet](https://testnet.binance.vision/) | `binance.com-testnet` |  |  |
| [Binance Margin](https://www.binance.com) | `binance.com-margin` |  |  |
| [Binance Margin Testnet](https://testnet.binance.vision/) | `binance.com-margin-testnet` |  |  |
| [Binance Isolated Margin](https://www.binance.com) | `binance.com-isolated_margin` |  |  |
| [Binance Isolated Margin Testnet](https://testnet.binance.vision/) | `binance.com-isolated_margin-testnet` |  |  |
| [Binance USD-M Futures](https://www.binance.com) | `binance.com-futures` |  |  |
| [Binance USD-M Futures Testnet](https://testnet.binancefuture.com) | `binance.com-futures-testnet` |  |  |
| [Binance Coin-M Futures](https://www.binance.com) | `binance.com-coin_futures` |  |  |
| [Binance US](https://www.binance.us) | `binance.us` |  |  |
| [Binance TR](https://www.trbinance.com) | `trbinance.com` |  |  |
| [Binance DEX](https://www.binance.org) | `binance.org` |  |  |
| [Binance DEX Testnet](https://testnet.binance.org) | `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! But you can consume with
[`await`](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#or-await-the-webstream-data-in-an-asyncio-task)
, if you want!
- Supports
[subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream)/[unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream)
on all exchanges! (Take a look to the max supported subscriptions per stream in the [endpoint configuration overview](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/Binance-websocket-endpoint-configuration-overview)!)
- [UNICORN Binance WebSocket API](https://www.lucit.tech/unicorn-binance-websocket-api.html) 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](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_multiple_userdata_streams.py))
- [Pick up the received data from the `stream_buffer`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=get_stream_info#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.pop_stream_data_from_stream_buffer) ([FIFO or LIFO](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_buffer%60)) -
if you can not store your data in cause of a temporary technical issue, you can
[kick back the data to the `stream_buffer`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=get_stream_info#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.add_to_stream_buffer)
which stores the receives in the RAM till you are able to process the data in the normal way again.
[Learn more!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_buffer%60)
- Use separate `stream_buffers` for
[specific streams](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_stream_buffer_extended.py)
or
[users](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_multiple_userdata_streams.py)!
- Watch the `stream_signals` to receive `CONNECT`, `FIRST_RECEIVED_DATA`, `DISCONNECT`, `STOP` and
`STREAM_UNREPAIRABLE` signals from your streams! [Learn more!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
- Get the received data unchanged as received, as Python dictionary or converted with
[UnicornFy](https://github.com/LUCIT-Systems-and-Development/unicorn-fy) into well-formed Python dictionaries. Use the `output`
parameter of
[`create_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=create_stream#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.create_stream)
to control the output format.
- Helpful management features like
[`clear_asyncio_queue()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.clear_asyncio_queue),
[`clear_stream_buffer()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.clear_stream_buffer),
[`get_binance_api_status()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_binance_api_status),
[`get_current_receiving_speed()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_current_receiving_speed),
[`get_errors_from_endpoints()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_errors_from_endpoints),
[`get_limit_of_subscriptions_per_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_limit_of_subscriptions_per_stream),
[`get_request_id()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_request_id),
[`get_result_by_request_id()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_result_by_request_id),
[`get_results_from_endpoints()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_results_from_endpoints),
[`get_stream_buffer_length()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_buffer_length),
[`get_stream_info()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_info),
[`get_stream_list()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_list),
[`get_stream_id_by_label()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_id_by_label),
[`get_stream_statistic()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_statistic),
[`get_stream_subscriptions()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_subscriptions),
[`get_version()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_version),
[`is_update_available()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.is_update_availabe),
[`get_stream_data_from_asyncio_queue()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_data_from_asyncio_queue),
[`pop_stream_data_from_stream_buffer()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.pop_stream_data_from_stream_buffer),
[`print_summary()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.print_summary),
[`replace_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.replace_stream),
[`set_stream_label()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.set_stream_label),
[`set_ringbuffer_error_max_size()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.set_ringbuffer_error_max_size),
[`subscribe_to_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream),
[`stop_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.stop_stream),
[`unsubscribe_from_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream),
[`wait_till_stream_has_started()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.wait_till_stream_has_started)
and many more! Explore them [here](https://unicorn-binance-websocket-api.docs.lucit.tech/modules.html).
- Monitor the status of the created `BinanceWebSocketApiManager()` instance within your code with
[`get_monitoring_status_plain()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=plain#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.get_monitoring_status_plain)
and specific streams with
[`get_stream_info()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_info).
- Available as a package via `pip` and `conda` as precompiled C extension with stub files for improved Intellisense
functions and source code for easier debugging of the source code. [To the installation.](#installation-and-upgrade)
- Nice to use with [iPython](https://ipython.org/):
"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](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_interactive_mode.py))
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_interactive_mode.py)
- Also, nice to use with the [Jupyter Notebook](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/tree/master/ipynb) :)
- [Monitoring API service](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service)
and a [check_command](https://exchange.icinga.com/LUCIT/check_lucit_collector)
for [ICINGA](https://exchange.icinga.com/LUCIT/check_lucit_collector)/Nagios
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service)
- Integration of [test cases](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/unit-tests.yml) and [examples](#examples).
- Customizable base URL.
- *Socks5 Proxy* support:
```
ubwa = BinanceWebSocketApiManager(exchange="binance.com", socks5_proxy_server="127.0.0.1:9050")
```
Read the [docs](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager)
or this [how to](https://medium.com/@oliverzehentleitner/how-to-connect-to-binance-com-websockets-using-python-via-a-socks5-proxy-3c5a3e063f12)
for more information or try
[example_socks5_proxy.py](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_socks5_proxy.py).
- Excessively tested on Linux, Mac and Windows on x86, arm32, arm64, ...
If you like the project, please [](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/stargazers) it on
[GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)!
## Live Demo
This live demo script is streaming from [binance.com](https://www.binance.com) and runs on a *CCX13* virtual
machine of [HETZNER CLOUD](https://hetzner.cloud/?ref=rKgYRMq0l8fd)
[Open live monitor!](https://www.lucit.tech/unicorn-binance-websocket-api-live-demo.html)
[](https://www.lucit.tech/unicorn-binance-websocket-api-live-demo.html)
(Refresh update once a minute!)
## Installation and Upgrade
The module requires Python 3.8 and runs smoothly up to and including Python 3.12.
Anaconda packages are available from Python version 3.8 and higher, but only in the latest version!
For the PyPy interpreter we offer packages via PyPi only from Python version 3.9 and higher.
The current dependencies are listed [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/requirements.txt).
If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation).
### Packages are created automatically with GitHub Actions
When a new release is to be created, we start two GitHubActions:
- [Build and Publish Anaconda](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/build_conda.yml)
- [Build and Publish GH+PyPi](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/actions/workflows/build_wheels.yml)
Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and
create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on
GitHub, PYPI and Anaconda. This is a transparent method that makes it possible to trace the source code behind a
compilation.
### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/)
Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/),
these wheels offer significant advantages for Python developers:
- ***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.
On Raspberry Pi and other architectures for which there are no pre-compiled versions, the package can still be
installed with PIP. PIP then compiles the package locally on the target system during installation. Please be patient,
this may take some time!
#### Installation
`pip install unicorn-binance-websocket-api`
#### Update
`pip install unicorn-binance-websocket-api --upgrade`
### A Conda Package of the latest version with `conda` from [Anaconda](https://anaconda.org/lucit)
The `unicorn-binance-websocket-api` package is also available as a Cython version for the `linux-64`, `osx-64`
and `win-64` architectures with [Conda](https://docs.conda.io/en/latest/) through the
[`lucit` channel](https://anaconda.org/lucit).
For optimal compatibility and performance, it is recommended to source the necessary dependencies from the
[`conda-forge` channel](https://anaconda.org/conda-forge).
#### Installation
```
conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-binance-websocket-api
```
#### Update
`conda update -c lucit unicorn-binance-websocket-api`
### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/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`
#### Windows
Use the below command with the version (such as 2.9.0) you determined
[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest):
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.9.0.tar.gz --upgrade`
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
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`
## Change Log
[https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html](https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html)
## Documentation
- [General](https://unicorn-binance-websocket-api.docs.lucit.tech)
- [Modules](https://unicorn-binance-websocket-api.docs.lucit.tech/modules.html)
## Examples
- [Look here!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/tree/master/examples/)
## Howto
- [How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8)
- [Create and Cancel Orders via WebSocket on Binance](https://medium.lucit.tech/create-and-cancel-orders-via-websocket-on-binance-7f828831404)
- [How to Download Klines from Binance using Python?](https://medium.lucit.tech/how-to-download-data-from-binance-using-python-8f1b6e8f19f3)
- [Passing Binance Market Data to Apache Kafka in Python with aiokafka](https://medium.lucit.tech/passing-binance-market-data-to-apache-kafka-in-python-with-aiokafka-570541574655)
- [How to Connect to binance.com Websockets using Python via a Socks5 Proxy](https://medium.lucit.tech/how-to-connect-to-binance-com-websockets-using-python-via-a-socks5-proxy-3c5a3e063f12)
## Project Homepage
[https://www.lucit.tech/unicorn-binance-websocket-api.html](https://www.lucit.tech/unicorn-binance-websocket-api.html)
## Wiki
[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](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/discussions)
- [Gitter](https://gitter.im/unicorn-binance-suite/unicorn-binance-websocket-api)
- [https://t.me/unicorndevs](https://t.me/unicorndevs)
- [https://dev.binance.vision](https://dev.binance.vision)
- [https://forum.bnbchain.org/](https://forum.bnbchain.org/)
## Receive Notifications
To receive notifications on available updates you can
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/watchers)
the repository on [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api), write your
[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/examples/_archive/example_version_of_this_package.py)
with using
[`is_update_available()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.is_update_availabe)
or you use the
[monitoring API service](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/UNICORN-Monitoring-API-Service).
Follow us on [LinkedIn](https://www.linkedin.com/company/lucit-systems-and-development),
[X](https://twitter.com/LUCIT_SysDev) or [Facebook](https://www.facebook.com/lucit.systems.and.development)!
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_announcements)
- [https://t.me/binance_api_english](https://t.me/binance_api_english)
- [https://t.me/Binance_USA](https://t.me/Binance_USA)
- [https://t.me/TRBinanceTR](https://t.me/TRBinanceTR)
- [https://t.me/BinanceExchange](https://t.me/BinanceExchange)
## How to report Bugs or suggest Improvements?
[List of planned features](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) - click  if you need one of them or suggest a new feature!
Before you report a bug, [try the latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api#installation-and-upgrade). 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](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues)!
[Report a security bug!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/security/policy)
## Contributing
[UNICORN Binance WebSocket API](https://www.lucit.tech/unicorn-binance-websocket-api.html) 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](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/blob/master/CONTRIBUTING.md).
### Contributors
[](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/graphs/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
[](https://www.lucit.tech/get-support.html)
***Do you need a developer, operator or consultant?*** [Contact us](https://www.lucit.tech/contact.html) for a non-binding initial consultation!
dev_url: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api
doc_url: https://unicorn-binance-websocket-api.docs.lucit.tech
home: https://www.lucit.tech/unicorn-binance-websocket-api.html
license: LSOSL
license_file: LICENSE
extra:
recipe-maintainers:
- oliver-zehentleitner