Skip to content

Commit f53ceaf

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
1.32.0
1 parent 7e62d59 commit f53ceaf

24 files changed

+1307
-2228
lines changed

‎CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to
66
[Semantic Versioning](http://semver.org/).
77

8-
## 1.31.0.dev (development stage/unreleased/unstable)
8+
## 1.32.0.dev (development stage/unreleased/unstable)
9+
10+
## 1.32.0
911
Now `stream_buffer` can be used as FIFO or LIFO stack and its possible to define a max length for it.
1012
### Added
1113
- `clear_stream_buffer()` to delete all items on the `stream_buffer` stack.

‎docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2a2666b43b90841f226814b214b20b7a
3+
config: 2642af4f97328a2403dcdc4a5c0f4424
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/CHANGELOG.html

+760-732
Large diffs are not rendered by default.

‎docs/README.html

+8-17
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>UNICORN Binance WebSocket API &#8212; unicorn-binance-websocket-api 1.31.0 documentation</title>
8+
<title>UNICORN Binance WebSocket API &#8212; unicorn-binance-websocket-api 1.32.0 documentation</title>
99
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
1111

1212
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
1313
<script src="_static/jquery.js"></script>
1414
<script src="_static/underscore.js"></script>
1515
<script src="_static/doctools.js"></script>
16-
<script src="_static/language_data.js"></script>
1716

1817
<link rel="index" title="Index" href="genindex.html" />
1918
<link rel="search" title="Search" href="search.html" />
@@ -49,7 +48,7 @@ <h3>Navigation</h3>
4948
<li><a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">unicorn-binance-websocket-api</a> &#187;</li>
5049

5150

52-
<a href="index.html">unicorn-binance-websocket-api 1.31.0 documentation</a> &#187;
51+
<a href="index.html">unicorn-binance-websocket-api 1.32.0 documentation</a> &#187;
5352

5453

5554
<li class="nav-item nav-item-this"><a href="">UNICORN Binance WebSocket API</a></li>
@@ -84,7 +83,7 @@ <h1>UNICORN Binance WebSocket API<a class="headerlink" href="#unicorn-binance-we
8483
<a class="reference external" href="#documentation">Documentation</a> | <a class="reference external" href="#examples">Examples</a> | <a class="reference external" href="#change-log">Change Log</a> | <a class="reference external" href="#wiki">Wiki</a> | <a class="reference external" href="#social">Social</a> |
8584
<a class="reference external" href="#receive-notifications">Notifications</a> | <a class="reference external" href="#how-to-report-bugs-or-suggest-improvements">Bugs</a> |
8685
<a class="reference external" href="#contributing">Contributing</a> | <a class="reference external" href="#commercial-support">Commercial Support</a> | <a class="reference external" href="#donate">Donate</a></p>
87-
<p>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, tr, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.</p>
86+
<p>An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.</p>
8887
<p>Part of <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-suite">‘UNICORN Binance Suite’</a>.</p>
8988
<div class="section" id="create-a-multiplex-websocket-connection-to-binance-with-just-3-lines-of-code">
9089
<h2><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.create_stream">Create a multiplex websocket connection</a> to Binance with just 3 lines of code:<a class="headerlink" href="#create-a-multiplex-websocket-connection-to-binance-with-just-3-lines-of-code" title="Permalink to this headline"></a></h2>
@@ -144,7 +143,6 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
144143
(<a class="reference external" href="https://testnet.binance.vision/">+Testnet</a>),
145144
<a class="reference external" href="https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams">Binance Futures</a>
146145
(<a class="reference external" href="https://testnet.binancefuture.com">+Testnet</a>),
147-
<a class="reference external" href="https://github.com/binance-jersey/binance-official-api-docs/">Binance Jersey</a>,
148146
<a class="reference external" href="https://github.com/binance-us/binance-official-api-docs">Binance US</a>,
149147
<a class="reference external" href="https://www.trbinance.com/apidocs">Binance TR</a>,
150148
<a class="reference external" href="https://jexapi.github.io/api-doc/spot.html#web-socket-streams">Binance JEX</a>,
@@ -154,7 +152,6 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
154152
which needs to be used with a valid api_key and api_secret from the Binance Exchange
155153
<a class="reference external" href="https://www.binance.com/userCenter/createApi.html">www.binance.com</a>,
156154
<a class="reference external" href="https://testnet.binance.vision/">testnet.binance.vision</a>,
157-
<a class="reference external" href="https://www.binance.je/userCenter/createApi.html">www.binance.je</a>,
158155
<a class="reference external" href="https://www.binance.us/userCenter/createApi.html">www.binance.us</a> or
159156
<a class="reference external" href="https://www.jex.com/userCenter/createApi.html">www.jex.com</a> - for the DEX you need a user address from
160157
<a class="reference external" href="https://www.binance.org/en/create">www.binance.org</a> or <a class="reference external" href="https://testnet.binance.org/en/create">testnet.binance.org</a>
@@ -212,10 +209,6 @@ <h3>What are the benefits of the UNICORN Binance WebSocket API?<a class="headerl
212209
<td><code>BinanceWebSocketApiManager(exchange="binance.com-coin-futures")</code></td>
213210
</tr>
214211
<tr>
215-
<td><a href="https://www.binance.je">Binance Jersey</a></td>
216-
<td><code>BinanceWebSocketApiManager(exchange="binance.je")</code></td>
217-
</tr>
218-
<tr>
219212
<td><a href="https://www.binance.us">Binance US</a></td>
220213
<td><code>BinanceWebSocketApiManager(exchange="binance.us")</code></td>
221214
</tr>
@@ -377,7 +370,6 @@ <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this head
377370
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_dex.py">example_binance_dex.py</a></p></li>
378371
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_futures.py">example_binance_futures.py</a></p></li>
379372
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_futures_1s.py">example_binance_futures_1s.py</a></p></li>
380-
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_jersey.py">example_binance_jersey.py</a></p></li>
381373
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_jex.py">example_binance_jex.py</a></p></li>
382374
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_us.py">example_binance_us.py</a></p></li>
383375
<li><p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_bookticker.py">example_bookticker.py</a></p></li>
@@ -447,7 +439,6 @@ <h2>Receive Notifications<a class="headerlink" href="#receive-notifications" tit
447439
<li><p><a class="reference external" href="https://t.me/binance_api_announcements">https://t.me/binance_api_announcements</a></p></li>
448440
<li><p><a class="reference external" href="https://t.me/binance_api_english">https://t.me/binance_api_english</a></p></li>
449441
<li><p><a class="reference external" href="https://t.me/BinanceExchange">https://t.me/BinanceExchange</a></p></li>
450-
<li><p><a class="reference external" href="https://t.me/Binance_Jersey">https://t.me/Binance_Jersey</a></p></li>
451442
<li><p><a class="reference external" href="https://t.me/Binance_USA">https://t.me/Binance_USA</a></p></li>
452443
<li><p><a class="reference external" href="https://t.me/Binance_JEX_EN">https://t.me/Binance_JEX_EN</a></p></li>
453444
<li><p><a class="reference external" href="https://t.me/BinanceDEXchange">https://t.me/BinanceDEXchange</a></p></li>
@@ -467,7 +458,7 @@ <h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to t
467458
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">UNICORN Binance WebSocket API</a> is an open
468459
source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To
469460
contribute follow
470-
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/CONTRIBUTING">this guide</a>.</p>
461+
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/CONTRIBUTING.md">this guide</a>.</p>
471462
<div class="section" id="contributors">
472463
<h3>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline"></a></h3>
473464
<p><a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/graphs/contributors"><img alt="Contributors" src="https://contributors-img.web.app/image?repo=oliver-zehentleitner/unicorn-binance-websocket-api" /></a></p>
@@ -634,7 +625,7 @@ <h3>Navigation</h3>
634625
<li><a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">unicorn-binance-websocket-api</a> &#187;</li>
635626

636627

637-
<a href="index.html">unicorn-binance-websocket-api 1.31.0 documentation</a> &#187;
628+
<a href="index.html">unicorn-binance-websocket-api 1.32.0 documentation</a> &#187;
638629

639630

640631
<li class="nav-item nav-item-this"><a href="">UNICORN Binance WebSocket API</a></li>
@@ -649,7 +640,7 @@ <h3>Navigation</h3>
649640
&copy; <a href="copyright.html">Copyright</a> 2021, Oliver Zehentleitner.
650641
<br />
651642

652-
Last updated on Jul 07 2021 at 22:27 (CET).
643+
Last updated on Aug 24 2021 at 19:44 (CET).
653644
<a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
654645
<br />
655646

@@ -658,13 +649,13 @@ <h3>Navigation</h3>
658649
<a href="https://www.python.org/psf/donations/">Please donate.</a>
659650
<br />
660651

661-
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.3.1
652+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.5.4
662653
with <a href="https://github.com/oliver-zehentleitner/python-docs-theme-technopathy">python-docs-theme-technopathy</a>
663654
by <a href="https://about.me/oliver-zehentleitner">Oliver Zehentleitner</a>.
664655
<br />
665656
<a href="https://www.technopathy.club/2019/11/03/use-python-sphinx-on-github-pages-with-html-and-an-indivdual-theme">
666657
Create a GitHub Page like this one!</a> <br />
667-
Powered by <a href="https://www.lucit.co/desktop-and-server-apps.html">LUCIT - Python Development</a>
658+
Sponsored by <a href="https://www.lucit-development.co">LUCIT - Python Development</a>
668659
</div>
669660

670661
</body>

‎docs/_sources/CHANGELOG.md.txt

+12
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
66
[Semantic Versioning](http://semver.org/).
77

88
## 1.31.0.dev (development stage/unreleased/unstable)
9+
Now `stream_buffer` can be used as FIFO or LIFO stack and its possible to define a max length for it.
10+
### Added
11+
- `clear_stream_buffer()` to delete all items on the `stream_buffer` stack.
12+
- `get_stream_buffer_maxlen()` to get the maxlen value of the stack.
13+
- Support for `stream_buffer_maxlen` in methods of `BinanceWebSocketApiManager()` class `_create_stream_thread()`, `print_stream_info()`, `__init__()`,
14+
`_add_stream_to_stream_list()`, `_create_stream_thread()`, `create_stream()`, `replace_stream()`.
15+
- Support for FIFO and LIFO in `pop_stream_data_from_stream_buffer(mode="FIFO")`
16+
### Changed
17+
- `get_used_weight()` replaces `get_binance_api_status()`
18+
- `self.stream_buffer` and `self.stream_buffer[xxx]` is not a list anymore, its changed to `collections.deque()`
919

1020
## 1.31.0
1121
### Added
@@ -15,6 +25,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
1525
### Fixed
1626
- Exception Handling listen_key [issue#143](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues/143)
1727
- Unsubscribe_from_stream method doesn't handle uppercase symbols while subscribe_to_stream does [issue#167](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues/167)
28+
### Removed
29+
- binance.je support (Binance Jersey has ceased operations.)
1830

1931
## 1.30.0
2032
### Added

‎docs/_sources/README.md.txt

+1-6
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
[Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) |
1919
[Contributing](#contributing) | [Commercial Support](#commercial-support) | [Donate](#donate)
2020

21-
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, tr, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.
21+
An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr, jex, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.
2222

2323
Part of ['UNICORN Binance Suite'](https://github.com/oliver-zehentleitner/unicorn-binance-suite).
2424

@@ -76,7 +76,6 @@ provides an API to the Binance Websocket API`s of
7676
([+Testnet](https://testnet.binance.vision/)),
7777
[Binance Futures](https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams)
7878
([+Testnet](https://testnet.binancefuture.com)),
79-
[Binance Jersey](https://github.com/binance-jersey/binance-official-api-docs/),
8079
[Binance US](https://github.com/binance-us/binance-official-api-docs),
8180
[Binance TR](https://www.trbinance.com/apidocs),
8281
[Binance JEX](https://jexapi.github.io/api-doc/spot.html#web-socket-streams),
@@ -86,7 +85,6 @@ all public streams like trade, kline, ticker, depth, bookTicker, forceOrder, com
8685
which needs to be used with a valid api_key and api_secret from the Binance Exchange
8786
[www.binance.com](https://www.binance.com/userCenter/createApi.html),
8887
[testnet.binance.vision](https://testnet.binance.vision/),
89-
[www.binance.je](https://www.binance.je/userCenter/createApi.html),
9088
[www.binance.us](https://www.binance.us/userCenter/createApi.html) or
9189
[www.jex.com](https://www.jex.com/userCenter/createApi.html) - for the DEX you need a user address from
9290
[www.binance.org](https://www.binance.org/en/create) or [testnet.binance.org](https://testnet.binance.org/en/create)
@@ -110,7 +108,6 @@ on, you can to use the [UNICORN Binance REST API](https://github.com/oliver-zehe
110108
| [Binance USD-M Futures](https://www.binance.com) | `BinanceWebSocketApiManager(exchange="binance.com-futures")` |
111109
| [Binance USD-M Futures Testnet](https://testnet.binancefuture.com) | `BinanceWebSocketApiManager(exchange="binance.com-futures-testnet")` |
112110
| [Binance Coin-M Futures](https://www.binance.com) | `BinanceWebSocketApiManager(exchange="binance.com-coin-futures")` |
113-
| [Binance Jersey](https://www.binance.je) | `BinanceWebSocketApiManager(exchange="binance.je")` |
114111
| [Binance US](https://www.binance.us) | `BinanceWebSocketApiManager(exchange="binance.us")` |
115112
| [Binance TR](https://www.trbinance.com) | `BinanceWebSocketApiManager(exchange="trbinance.com")` |
116113
| [Binance JEX](https://www.jex.com) | `BinanceWebSocketApiManager(exchange="jex.com")` |
@@ -258,7 +255,6 @@ or the [current master branch](https://github.com/oliver-zehentleitner/unicorn-b
258255
- [example_binance_dex.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_dex.py)
259256
- [example_binance_futures.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_futures.py)
260257
- [example_binance_futures_1s.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_futures_1s.py)
261-
- [example_binance_jersey.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_jersey.py)
262258
- [example_binance_jex.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_jex.py)
263259
- [example_binance_us.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_binance_us.py)
264260
- [example_bookticker.py](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/example_bookticker.py)
@@ -318,7 +314,6 @@ To receive news (like inspection windows/maintenance) about the Binance API`s su
318314
- [https://t.me/binance_api_announcements](https://t.me/binance_api_announcements)
319315
- [https://t.me/binance_api_english](https://t.me/binance_api_english)
320316
- [https://t.me/BinanceExchange](https://t.me/BinanceExchange)
321-
- [https://t.me/Binance_Jersey](https://t.me/Binance_Jersey)
322317
- [https://t.me/Binance_USA](https://t.me/Binance_USA)
323318
- [https://t.me/Binance_JEX_EN](https://t.me/Binance_JEX_EN)
324319
- [https://t.me/BinanceDEXchange](https://t.me/BinanceDEXchange)

‎docs/_static/basic.css

+15-10
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -277,25 +277,25 @@ p.rubric {
277277
font-weight: bold;
278278
}
279279

280-
img.align-left, .figure.align-left, object.align-left {
280+
img.align-left, figure.align-left, .figure.align-left, object.align-left {
281281
clear: left;
282282
float: left;
283283
margin-right: 1em;
284284
}
285285

286-
img.align-right, .figure.align-right, object.align-right {
286+
img.align-right, figure.align-right, .figure.align-right, object.align-right {
287287
clear: right;
288288
float: right;
289289
margin-left: 1em;
290290
}
291291

292-
img.align-center, .figure.align-center, object.align-center {
292+
img.align-center, figure.align-center, .figure.align-center, object.align-center {
293293
display: block;
294294
margin-left: auto;
295295
margin-right: auto;
296296
}
297297

298-
img.align-default, .figure.align-default {
298+
img.align-default, figure.align-default, .figure.align-default {
299299
display: block;
300300
margin-left: auto;
301301
margin-right: auto;
@@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
319319

320320
/* -- sidebars -------------------------------------------------------------- */
321321

322-
div.sidebar {
322+
div.sidebar,
323+
aside.sidebar {
323324
margin: 0 0 0.5em 1em;
324325
border: 1px solid #ddb;
325326
padding: 7px;
@@ -377,12 +378,14 @@ div.body p.centered {
377378
/* -- content of sidebars/topics/admonitions -------------------------------- */
378379

379380
div.sidebar > :last-child,
381+
aside.sidebar > :last-child,
380382
div.topic > :last-child,
381383
div.admonition > :last-child {
382384
margin-bottom: 0;
383385
}
384386

385387
div.sidebar::after,
388+
aside.sidebar::after,
386389
div.topic::after,
387390
div.admonition::after,
388391
blockquote::after {
@@ -455,20 +458,22 @@ td > :last-child {
455458

456459
/* -- figures --------------------------------------------------------------- */
457460

458-
div.figure {
461+
div.figure, figure {
459462
margin: 0.5em;
460463
padding: 0.5em;
461464
}
462465

463-
div.figure p.caption {
466+
div.figure p.caption, figcaption {
464467
padding: 0.3em;
465468
}
466469

467-
div.figure p.caption span.caption-number {
470+
div.figure p.caption span.caption-number,
471+
figcaption span.caption-number {
468472
font-style: italic;
469473
}
470474

471-
div.figure p.caption span.caption-text {
475+
div.figure p.caption span.caption-text,
476+
figcaption span.caption-text {
472477
}
473478

474479
/* -- field list styles ----------------------------------------------------- */

0 commit comments

Comments
 (0)