Skip to content

Commit 1552b0c

Browse files
authored
chore: add missing docs for ws endpoints (sammchardy#1520)
1 parent 2b33f2a commit 1552b0c

File tree

2 files changed

+2098
-47
lines changed

2 files changed

+2098
-47
lines changed

binance/async_client.py

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3550,7 +3550,7 @@ async def ws_get_order(self, **params):
35503550
async def ws_cancel_order(self, **params):
35513551
return await self._ws_api_request("order.cancel", True, params)
35523552

3553-
cancel_order.__doc__ = cancel_order.__doc__
3553+
ws_cancel_order.__doc__ = Client.ws_cancel_order.__doc__
35543554

35553555
async def cancel_all_open_orders(self, **params):
35563556
return await self._delete("openOrders", True, data=params)
@@ -3560,105 +3560,173 @@ async def cancel_replace_order(self, **params):
35603560
params["newClientOrderId"] = self.SPOT_ORDER_PREFIX + self.uuid22()
35613561
return await self._post("order/cancelReplace", signed=True, data=params)
35623562

3563+
cancel_replace_order.__doc__ = Client.cancel_replace_order.__doc__
3564+
35633565
async def ws_cancel_and_replace_order(self, **params):
35643566
return await self._ws_api_request("order.cancelReplace", True, params)
35653567

3568+
ws_cancel_and_replace_order.__doc__ = Client.ws_cancel_and_replace_order.__doc__
3569+
35663570
async def ws_get_open_orders(self, **params):
35673571
return await self._ws_api_request("openOrders.status", True, params)
35683572

3573+
ws_get_open_orders.__doc__ = Client.ws_get_open_orders.__doc__
3574+
35693575
async def ws_cancel_all_open_orders(self, **params):
35703576
return await self._ws_api_request("openOrders.cancelAll", True, params)
35713577

3578+
ws_cancel_all_open_orders.__doc__ = Client.ws_cancel_all_open_orders.__doc__
3579+
35723580
async def ws_create_oco_order(self, **params):
35733581
return await self._ws_api_request("orderList.place.oco", True, params)
35743582

3583+
ws_create_oco_order.__doc__ = Client.ws_create_oco_order.__doc__
3584+
35753585
async def ws_create_oto_order(self, **params):
35763586
return await self._ws_api_request("orderList.place.oto", True, params)
35773587

3588+
ws_create_oto_order.__doc__ = Client.ws_create_oto_order.__doc__
3589+
35783590
async def ws_create_otoco_order(self, **params):
35793591
return await self._ws_api_request("orderList.place.otoco", True, params)
35803592

3593+
ws_create_otoco_order.__doc__ = Client.ws_create_otoco_order.__doc__
3594+
35813595
async def ws_get_oco_order(self, **params):
35823596
return await self._ws_api_request("orderList.status", True, params)
35833597

3598+
ws_get_oco_order.__doc__ = Client.ws_get_oco_order.__doc__
3599+
35843600
async def ws_cancel_oco_order(self, **params):
35853601
return await self._ws_api_request("orderList.cancel", True, params)
35863602

3603+
ws_cancel_oco_order.__doc__ = Client.ws_cancel_oco_order.__doc__
3604+
35873605
async def ws_get_oco_open_orders(self, **params):
35883606
return await self._ws_api_request("openOrderLists.status", True, params)
35893607

3608+
ws_get_oco_open_orders.__doc__ = Client.ws_get_oco_open_orders.__doc__
3609+
35903610
async def ws_create_sor_order(self, **params):
35913611
return await self._ws_api_request("sor.order.place", True, params)
35923612

3613+
ws_create_sor_order.__doc__ = Client.ws_create_sor_order.__doc__
3614+
35933615
async def ws_create_test_sor_order(self, **params):
35943616
return await self._ws_api_request("sor.order.test", True, params)
35953617

3618+
ws_create_test_sor_order.__doc__ = Client.ws_create_test_sor_order.__doc__
3619+
35963620
async def ws_get_account(self, **params):
35973621
return await self._ws_api_request("account.status", True, params)
35983622

3623+
ws_get_account.__doc__ = Client.ws_get_account.__doc__
3624+
35993625
async def ws_get_account_rate_limits_orders(self, **params):
36003626
return await self._ws_api_request("account.rateLimits.orders", True, params)
36013627

3628+
ws_get_account_rate_limits_orders.__doc__ = Client.ws_get_account_rate_limits_orders.__doc__
3629+
36023630
async def ws_get_all_orders(self, **params):
36033631
return await self._ws_api_request("allOrders", True, params)
36043632

3633+
ws_get_all_orders.__doc__ = Client.ws_get_all_orders.__doc__
3634+
36053635
async def ws_get_my_trades(self, **params):
36063636
return await self._ws_api_request("myTrades", True, params)
36073637

3638+
ws_get_my_trades.__doc__ = Client.ws_get_my_trades.__doc__
3639+
36083640
async def ws_get_prevented_matches(self, **params):
36093641
return await self._ws_api_request("myPreventedMatches", True, params)
36103642

3643+
ws_get_prevented_matches.__doc__ = Client.ws_get_prevented_matches.__doc__
3644+
36113645
async def ws_get_allocations(self, **params):
36123646
return await self._ws_api_request("myAllocations", True, params)
36133647

3648+
ws_get_allocations.__doc__ = Client.ws_get_allocations.__doc__
3649+
36143650
async def ws_get_commission_rates(self, **params):
36153651
return await self._ws_api_request("account.commission", True, params)
36163652

3653+
ws_get_commission_rates.__doc__ = Client.ws_get_commission_rates.__doc__
3654+
36173655
async def ws_get_order_book(self, **params):
36183656
return await self._ws_api_request("depth", False, params)
36193657

3658+
ws_get_order_book.__doc__ = Client.ws_get_order_book.__doc__
3659+
36203660
async def ws_get_recent_trades(self, **params):
36213661
return await self._ws_api_request("trades.recent", False, params)
36223662

3663+
ws_get_recent_trades.__doc__ = Client.ws_get_recent_trades.__doc__
3664+
36233665
async def ws_get_historical_trades(self, **params):
36243666
return await self._ws_api_request("trades.historical", False, params)
36253667

3668+
ws_get_historical_trades.__doc__ = Client.ws_get_historical_trades.__doc__
3669+
36263670
async def ws_get_aggregate_trades(self, **params):
36273671
return await self._ws_api_request("trades.aggregate", False, params)
36283672

3673+
ws_get_aggregate_trades.__doc__ = Client.ws_get_aggregate_trades.__doc__
3674+
36293675
async def ws_get_klines(self, **params):
36303676
return await self._ws_api_request("klines", False, params)
36313677

3678+
ws_get_klines.__doc__ = Client.ws_get_klines.__doc__
3679+
36323680
async def ws_get_uiKlines(self, **params):
36333681
return await self._ws_api_request("uiKlines", False, params)
36343682

3683+
ws_get_uiKlines.__doc__ = Client.ws_get_uiKlines.__doc__
3684+
36353685
async def ws_get_avg_price(self, **params):
36363686
return await self._ws_api_request("avgPrice", False, params)
36373687

3688+
ws_get_avg_price.__doc__ = Client.ws_get_avg_price.__doc__
3689+
36383690
async def ws_get_ticker(self, **params):
36393691
return await self._ws_api_request("ticker.24hr", False, params)
36403692

3693+
ws_get_ticker.__doc__ = Client.ws_get_ticker.__doc__
3694+
36413695
async def ws_get_trading_day_ticker(self, **params):
36423696
return await self._ws_api_request("ticker.tradingDay", False, params)
36433697

3698+
ws_get_trading_day_ticker.__doc__ = Client.ws_get_trading_day_ticker.__doc__
3699+
36443700
async def ws_get_symbol_ticker_window(self, **params):
36453701
return await self._ws_api_request("ticker", False, params)
36463702

3703+
ws_get_symbol_ticker_window.__doc__ = Client.ws_get_symbol_ticker_window.__doc__
3704+
36473705
async def ws_get_symbol_ticker(self, **params):
36483706
return await self._ws_api_request("ticker.price", False, params)
36493707

3708+
ws_get_symbol_ticker.__doc__ = Client.ws_get_symbol_ticker.__doc__
3709+
36503710
async def ws_get_orderbook_ticker(self, **params):
36513711
return await self._ws_api_request("ticker.book", False, params)
36523712

3713+
ws_get_orderbook_ticker.__doc__ = Client.ws_get_orderbook_ticker.__doc__
3714+
36533715
async def ws_ping(self, **params):
36543716
return await self._ws_api_request("ping", False, params)
36553717

3718+
ws_ping.__doc__ = Client.ws_ping.__doc__
3719+
36563720
async def ws_get_time(self, **params):
36573721
return await self._ws_api_request("time", False, params)
36583722

3723+
ws_get_time.__doc__ = Client.ws_get_time.__doc__
3724+
36593725
async def ws_get_exchange_info(self, **params):
36603726
return await self._ws_api_request("exchangeInfo", False, params)
36613727

3728+
ws_get_exchange_info.__doc__ = Client.ws_get_exchange_info.__doc__
3729+
36623730
####################################################
36633731
# FUTURES WS API Endpoints
36643732
####################################################

0 commit comments

Comments
 (0)