Skip to content

Commit 0cc7378

Browse files
author
Sam McHardy
committed
Add BinanceResponseException to documentation
1 parent 11f2b8c commit 0cc7378

2 files changed

Lines changed: 35 additions & 28 deletions

File tree

‎binance/client.py‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ def get_products(self):
163163
164164
:returns: list - List of product dictionaries
165165
166+
:raises: BinanceResponseException, BinanceAPIException
167+
166168
"""
167169

168170
products = self._request_website('get', 'exchange/public/product')
@@ -182,7 +184,7 @@ def ping(self):
182184
183185
{}
184186
185-
:raises: BinanceAPIException
187+
:raises: BinanceResponseException, BinanceAPIException
186188
187189
"""
188190
return self._get('ping')
@@ -200,7 +202,7 @@ def get_server_time(self):
200202
"serverTime": 1499827319559
201203
}
202204
203-
:raises: BinanceAPIException
205+
:raises: BinanceResponseException, BinanceAPIException
204206
205207
"""
206208
return self._get('time')
@@ -227,7 +229,7 @@ def get_all_tickers(self):
227229
}
228230
]
229231
230-
:raises: BinanceAPIException
232+
:raises: BinanceResponseException, BinanceAPIException
231233
232234
"""
233235
return self._get('ticker/allPrices')
@@ -258,7 +260,7 @@ def get_orderbook_tickers(self):
258260
}
259261
]
260262
261-
:raises: BinanceAPIException
263+
:raises: BinanceResponseException, BinanceAPIException
262264
263265
"""
264266
return self._get('ticker/allBookTickers')
@@ -295,7 +297,7 @@ def get_order_book(self, **params):
295297
]
296298
}
297299
298-
:raises: BinanceAPIException
300+
:raises: BinanceResponseException, BinanceAPIException
299301
300302
"""
301303
return self._get('depth', data=params)
@@ -334,7 +336,7 @@ def get_aggregate_trades(self, **params):
334336
}
335337
]
336338
337-
:raises: BinanceAPIException
339+
:raises: BinanceResponseException, BinanceAPIException
338340
339341
"""
340342
return self._get('aggTrades', data=params)
@@ -376,7 +378,7 @@ def get_klines(self, **params):
376378
]
377379
]
378380
379-
:raises: BinanceAPIException
381+
:raises: BinanceResponseException, BinanceAPIException
380382
381383
"""
382384
return self._get('klines', data=params)
@@ -412,7 +414,7 @@ def get_ticker(self, **params):
412414
"count": 76 # Trade count
413415
}
414416
415-
:raises: BinanceAPIException
417+
:raises: BinanceResponseException, BinanceAPIException
416418
417419
"""
418420
return self._get('ticker/24hr', data=params)
@@ -456,7 +458,7 @@ def create_order(self, disable_validation=False, **params):
456458
"transactTime": 1499827319559
457459
}
458460
459-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
461+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
460462
461463
"""
462464
if not disable_validation:
@@ -496,7 +498,7 @@ def order_limit(self, disable_validation=False, timeInForce=TIME_IN_FORCE_GTC, *
496498
"transactTime": 1499827319559
497499
}
498500
499-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
501+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
500502
501503
"""
502504
params.update({
@@ -536,7 +538,7 @@ def order_limit_buy(self, disable_validation=False, timeInForce=TIME_IN_FORCE_GT
536538
"transactTime": 1499827319559
537539
}
538540
539-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
541+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
540542
541543
"""
542544
params.update({
@@ -575,7 +577,7 @@ def order_limit_sell(self, disable_validation=False, timeInForce=TIME_IN_FORCE_G
575577
"transactTime": 1499827319559
576578
}
577579
578-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
580+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
579581
580582
"""
581583
params.update({
@@ -608,7 +610,7 @@ def order_market(self, disable_validation=False, **params):
608610
"transactTime": 1499827319559
609611
}
610612
611-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
613+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
612614
613615
"""
614616
params.update({
@@ -639,7 +641,7 @@ def order_market_buy(self, disable_validation=False, **params):
639641
"transactTime": 1499827319559
640642
}
641643
642-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
644+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
643645
644646
"""
645647
params.update({
@@ -670,7 +672,7 @@ def order_market_sell(self, disable_validation=False, **params):
670672
"transactTime": 1499827319559
671673
}
672674
673-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
675+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
674676
675677
"""
676678
params.update({
@@ -712,7 +714,7 @@ def create_test_order(self, disable_validation=False, **params):
712714
713715
{}
714716
715-
:raises: BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
717+
:raises: BinanceResponseException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException
716718
717719
718720
"""
@@ -754,7 +756,7 @@ def get_order(self, **params):
754756
"time": 1499827319559
755757
}
756758
757-
:raises: BinanceAPIException
759+
:raises: BinanceResponseException, BinanceAPIException
758760
759761
"""
760762
return self._get('order', True, data=params)
@@ -795,7 +797,7 @@ def get_all_orders(self, **params):
795797
}
796798
]
797799
798-
:raises: BinanceAPIException
800+
:raises: BinanceResponseException, BinanceAPIException
799801
800802
"""
801803
return self._get('allOrders', True, data=params)
@@ -827,7 +829,7 @@ def cancel_order(self, **params):
827829
"clientOrderId": "cancelMyOrder1"
828830
}
829831
830-
:raises: BinanceAPIException
832+
:raises: BinanceResponseException, BinanceAPIException
831833
832834
"""
833835
return self._delete('order', True, data=params)
@@ -864,7 +866,7 @@ def get_open_orders(self, **params):
864866
}
865867
]
866868
867-
:raises: BinanceAPIException
869+
:raises: BinanceResponseException, BinanceAPIException
868870
869871
"""
870872
return self._get('openOrders', True, data=params)
@@ -904,7 +906,7 @@ def get_account(self, **params):
904906
]
905907
}
906908
907-
:raises: BinanceAPIException
909+
:raises: BinanceResponseException, BinanceAPIException
908910
909911
"""
910912
return self._get('account', True, data=params)
@@ -941,7 +943,7 @@ def get_my_trades(self, **params):
941943
}
942944
]
943945
944-
:raises: BinanceAPIException
946+
:raises: BinanceResponseException, BinanceAPIException
945947
946948
"""
947949
return self._get('myTrades', True, data=params)
@@ -978,7 +980,7 @@ def withdraw(self, **params):
978980
"success": true
979981
}
980982
981-
:raises: BinanceAPIException, BinanceWithdrawException
983+
:raises: BinanceResponseException, BinanceAPIException, BinanceWithdrawException
982984
983985
"""
984986
res = self._request_withdraw_api('post', 'withdraw.html', True, data=params)
@@ -1018,7 +1020,7 @@ def get_deposit_history(self, **params):
10181020
"success": true
10191021
}
10201022
1021-
:raises: BinanceAPIException
1023+
:raises: BinanceResponseException, BinanceAPIException
10221024
10231025
"""
10241026
return self._request_withdraw_api('post', 'getDepositHistory.html', True, data=params)
@@ -1064,7 +1066,7 @@ def get_withdraw_history(self, **params):
10641066
"success": true
10651067
}
10661068
1067-
:raises: BinanceAPIException
1069+
:raises: BinanceResponseException, BinanceAPIException
10681070
10691071
"""
10701072
return self._request_withdraw_api('post', 'getWithdrawHistory.html', True, data=params)
@@ -1084,7 +1086,7 @@ def stream_get_listen_key(self):
10841086
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
10851087
}
10861088
1087-
:raises: BinanceAPIException
1089+
:raises: BinanceResponseException, BinanceAPIException
10881090
10891091
"""
10901092
res = self._post('userDataStream', False, data={})
@@ -1101,7 +1103,7 @@ def stream_keepalive(self, **params):
11011103
11021104
{}
11031105
1104-
:raises: BinanceAPIException
1106+
:raises: BinanceResponseException, BinanceAPIException
11051107
11061108
"""
11071109
return self._put('userDataStream', False, data=params)
@@ -1117,7 +1119,7 @@ def stream_close(self, **params):
11171119
11181120
{}
11191121
1120-
:raises: BinanceAPIException
1122+
:raises: BinanceResponseException, BinanceAPIException
11211123
11221124
"""
11231125
return self._delete('userDataStream', False, data=params)

‎docs/exceptions.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Exceptions
22
==========
33

4+
BinanceResponseException
5+
------------------------
6+
7+
Raised if a non JSON response is returned
8+
49
BinanceAPIException
510
-------------------
611

0 commit comments

Comments
 (0)