ccxt 4.1.19__py2.py3-none-any.whl → 4.1.22__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. ccxt/__init__.py +1 -1
  2. ccxt/abstract/okcoin.py +70 -206
  3. ccxt/ace.py +12 -12
  4. ccxt/ascendex.py +5 -5
  5. ccxt/async_support/__init__.py +1 -1
  6. ccxt/async_support/ace.py +12 -12
  7. ccxt/async_support/ascendex.py +5 -5
  8. ccxt/async_support/base/exchange.py +1 -1
  9. ccxt/async_support/bigone.py +2 -2
  10. ccxt/async_support/binance.py +184 -184
  11. ccxt/async_support/bingx.py +48 -48
  12. ccxt/async_support/bitbank.py +14 -14
  13. ccxt/async_support/bitbns.py +7 -7
  14. ccxt/async_support/bitfinex.py +2 -2
  15. ccxt/async_support/bitfinex2.py +35 -35
  16. ccxt/async_support/bitflyer.py +17 -17
  17. ccxt/async_support/bitforex.py +9 -9
  18. ccxt/async_support/bitget.py +433 -215
  19. ccxt/async_support/bitmart.py +39 -39
  20. ccxt/async_support/bitmex.py +7 -7
  21. ccxt/async_support/bitopro.py +1 -1
  22. ccxt/async_support/bitpanda.py +1 -1
  23. ccxt/async_support/bitrue.py +2 -2
  24. ccxt/async_support/bitso.py +2 -2
  25. ccxt/async_support/bitstamp.py +3 -3
  26. ccxt/async_support/bitvavo.py +2 -2
  27. ccxt/async_support/bl3p.py +1 -1
  28. ccxt/async_support/btcalpha.py +7 -7
  29. ccxt/async_support/btcturk.py +1 -1
  30. ccxt/async_support/bybit.py +58 -58
  31. ccxt/async_support/cex.py +1 -1
  32. ccxt/async_support/coinbase.py +13 -13
  33. ccxt/async_support/coinbasepro.py +15 -15
  34. ccxt/async_support/coinex.py +19 -19
  35. ccxt/async_support/coinone.py +2 -2
  36. ccxt/async_support/coinsph.py +4 -4
  37. ccxt/async_support/coinspot.py +2 -2
  38. ccxt/async_support/cryptocom.py +28 -28
  39. ccxt/async_support/currencycom.py +1 -1
  40. ccxt/async_support/delta.py +26 -26
  41. ccxt/async_support/deribit.py +9 -9
  42. ccxt/async_support/digifinex.py +38 -38
  43. ccxt/async_support/exmo.py +18 -18
  44. ccxt/async_support/gate.py +59 -59
  45. ccxt/async_support/gemini.py +4 -4
  46. ccxt/async_support/hitbtc.py +6 -6
  47. ccxt/async_support/hollaex.py +2 -2
  48. ccxt/async_support/huobi.py +70 -70
  49. ccxt/async_support/indodax.py +1 -1
  50. ccxt/async_support/kraken.py +33 -33
  51. ccxt/async_support/krakenfutures.py +6 -5
  52. ccxt/async_support/kucoin.py +74 -74
  53. ccxt/async_support/kucoinfutures.py +8 -8
  54. ccxt/async_support/latoken.py +14 -14
  55. ccxt/async_support/lbank2.py +33 -33
  56. ccxt/async_support/mexc.py +22 -22
  57. ccxt/async_support/ndax.py +1 -1
  58. ccxt/async_support/novadax.py +22 -22
  59. ccxt/async_support/oceanex.py +18 -18
  60. ccxt/async_support/okcoin.py +1950 -2758
  61. ccxt/async_support/okx.py +73 -73
  62. ccxt/async_support/paymium.py +11 -11
  63. ccxt/async_support/phemex.py +26 -26
  64. ccxt/async_support/poloniex.py +30 -30
  65. ccxt/async_support/poloniexfutures.py +25 -25
  66. ccxt/async_support/probit.py +21 -21
  67. ccxt/async_support/tokocrypto.py +22 -22
  68. ccxt/async_support/upbit.py +21 -21
  69. ccxt/async_support/wavesexchange.py +2 -2
  70. ccxt/async_support/wazirx.py +14 -14
  71. ccxt/async_support/whitebit.py +6 -6
  72. ccxt/async_support/woo.py +21 -21
  73. ccxt/async_support/yobit.py +16 -16
  74. ccxt/async_support/zaif.py +10 -10
  75. ccxt/async_support/zonda.py +15 -15
  76. ccxt/base/exchange.py +2 -1
  77. ccxt/bigone.py +2 -2
  78. ccxt/binance.py +184 -184
  79. ccxt/bingx.py +48 -48
  80. ccxt/bitbank.py +14 -14
  81. ccxt/bitbns.py +7 -7
  82. ccxt/bitfinex.py +2 -2
  83. ccxt/bitfinex2.py +35 -35
  84. ccxt/bitflyer.py +17 -17
  85. ccxt/bitforex.py +9 -9
  86. ccxt/bitget.py +433 -215
  87. ccxt/bitmart.py +39 -39
  88. ccxt/bitmex.py +7 -7
  89. ccxt/bitopro.py +1 -1
  90. ccxt/bitpanda.py +1 -1
  91. ccxt/bitrue.py +2 -2
  92. ccxt/bitso.py +2 -2
  93. ccxt/bitstamp.py +3 -3
  94. ccxt/bitvavo.py +2 -2
  95. ccxt/bl3p.py +1 -1
  96. ccxt/btcalpha.py +7 -7
  97. ccxt/btcturk.py +1 -1
  98. ccxt/bybit.py +58 -58
  99. ccxt/cex.py +1 -1
  100. ccxt/coinbase.py +13 -13
  101. ccxt/coinbasepro.py +15 -15
  102. ccxt/coinex.py +19 -19
  103. ccxt/coinone.py +2 -2
  104. ccxt/coinsph.py +4 -4
  105. ccxt/coinspot.py +2 -2
  106. ccxt/cryptocom.py +28 -28
  107. ccxt/currencycom.py +1 -1
  108. ccxt/delta.py +26 -26
  109. ccxt/deribit.py +9 -9
  110. ccxt/digifinex.py +38 -38
  111. ccxt/exmo.py +18 -18
  112. ccxt/gate.py +59 -59
  113. ccxt/gemini.py +4 -4
  114. ccxt/hitbtc.py +6 -6
  115. ccxt/hollaex.py +2 -2
  116. ccxt/huobi.py +70 -70
  117. ccxt/indodax.py +1 -1
  118. ccxt/kraken.py +33 -33
  119. ccxt/krakenfutures.py +6 -5
  120. ccxt/kucoin.py +74 -74
  121. ccxt/kucoinfutures.py +8 -8
  122. ccxt/latoken.py +14 -14
  123. ccxt/lbank2.py +33 -33
  124. ccxt/mexc.py +22 -22
  125. ccxt/ndax.py +1 -1
  126. ccxt/novadax.py +22 -22
  127. ccxt/oceanex.py +18 -18
  128. ccxt/okcoin.py +1950 -2758
  129. ccxt/okx.py +73 -73
  130. ccxt/paymium.py +11 -11
  131. ccxt/phemex.py +26 -26
  132. ccxt/poloniex.py +30 -30
  133. ccxt/poloniexfutures.py +25 -25
  134. ccxt/pro/__init__.py +1 -1
  135. ccxt/pro/ascendex.py +1 -1
  136. ccxt/pro/binance.py +9 -9
  137. ccxt/pro/bingx.py +12 -12
  138. ccxt/pro/bitget.py +2 -2
  139. ccxt/pro/bitpanda.py +7 -7
  140. ccxt/pro/bitrue.py +2 -2
  141. ccxt/pro/blockchaincom.py +6 -6
  142. ccxt/pro/bybit.py +15 -15
  143. ccxt/pro/cex.py +8 -8
  144. ccxt/pro/coinbase.py +6 -6
  145. ccxt/pro/coinbasepro.py +1 -1
  146. ccxt/pro/coinex.py +8 -8
  147. ccxt/pro/cryptocom.py +12 -12
  148. ccxt/pro/deribit.py +7 -7
  149. ccxt/pro/gemini.py +4 -4
  150. ccxt/pro/hitbtc.py +17 -17
  151. ccxt/pro/huobi.py +3 -3
  152. ccxt/pro/kraken.py +6 -6
  153. ccxt/pro/krakenfutures.py +10 -10
  154. ccxt/pro/kucoin.py +85 -42
  155. ccxt/pro/kucoinfutures.py +5 -5
  156. ccxt/pro/luno.py +1 -1
  157. ccxt/pro/mexc.py +7 -7
  158. ccxt/pro/okx.py +16 -15
  159. ccxt/pro/phemex.py +15 -15
  160. ccxt/pro/poloniex.py +9 -9
  161. ccxt/pro/poloniexfutures.py +5 -5
  162. ccxt/pro/probit.py +5 -5
  163. ccxt/pro/wazirx.py +5 -5
  164. ccxt/pro/woo.py +1 -1
  165. ccxt/probit.py +21 -21
  166. ccxt/test/base/test_shared_methods.py +1 -1
  167. ccxt/tokocrypto.py +22 -22
  168. ccxt/upbit.py +21 -21
  169. ccxt/wavesexchange.py +2 -2
  170. ccxt/wazirx.py +14 -14
  171. ccxt/whitebit.py +6 -6
  172. ccxt/woo.py +21 -21
  173. ccxt/yobit.py +16 -16
  174. ccxt/zaif.py +10 -10
  175. ccxt/zonda.py +15 -15
  176. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/METADATA +5 -9
  177. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/RECORD +179 -179
  178. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/WHEEL +0 -0
  179. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/top_level.txt +0 -0
ccxt/pro/kucoinfutures.py CHANGED
@@ -134,7 +134,7 @@ class kucoinfutures(ccxt.async_support.kucoinfutures):
134
134
  async def watch_ticker(self, symbol: str, params={}):
135
135
  """
136
136
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
137
- see https://docs.kucoin.com/futures/#get-real-time-symbol-ticker-v2
137
+ :see: https://docs.kucoin.com/futures/#get-real-time-symbol-ticker-v2
138
138
  :param str symbol: unified symbol of the market to fetch the ticker for
139
139
  :param dict [params]: extra parameters specific to the kucoinfutures api endpoint
140
140
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -180,7 +180,7 @@ class kucoinfutures(ccxt.async_support.kucoinfutures):
180
180
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
181
181
  """
182
182
  get the list of most recent trades for a particular symbol
183
- see https://docs.kucoin.com/futures/#execution-data
183
+ :see: https://docs.kucoin.com/futures/#execution-data
184
184
  :param str symbol: unified symbol of the market to fetch trades for
185
185
  :param int [since]: timestamp in ms of the earliest trade to fetch
186
186
  :param int [limit]: the maximum amount of trades to fetch
@@ -268,7 +268,7 @@ class kucoinfutures(ccxt.async_support.kucoinfutures):
268
268
  * 4. Apply the new Level 2 data flow to the local snapshot to ensure that the sequence of the new Level 2 update lines up with the sequence of the previous Level 2 data. Discard all the message prior to that sequence, and then playback the change to snapshot.
269
269
  * 5. Update the level2 full data based on sequence according to the size. If the price is 0, ignore the messages and update the sequence. If the size=0, update the sequence and remove the price of which the size is 0 out of level 2. For other cases, please update the price.
270
270
  * 6. If the sequence of the newly pushed message does not line up to the sequence of the last message, you could pull through REST Level 2 message request to get the updated messages. Please note that the difference between the start and end parameters cannot exceed 500.
271
- see https://docs.kucoin.com/futures/#level-2-market-data
271
+ :see: https://docs.kucoin.com/futures/#level-2-market-data
272
272
  :param str symbol: unified symbol of the market to fetch the order book for
273
273
  :param int [limit]: the maximum amount of order book entries to return
274
274
  :param dict [params]: extra parameters specific to the kucoinfutures api endpoint
@@ -450,7 +450,7 @@ class kucoinfutures(ccxt.async_support.kucoinfutures):
450
450
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
451
451
  """
452
452
  watches information on multiple orders made by the user
453
- see https://docs.kucoin.com/futures/#trade-orders-according-to-the-market
453
+ :see: https://docs.kucoin.com/futures/#trade-orders-according-to-the-market
454
454
  :param str symbol: unified market symbol of the market orders were made in
455
455
  :param int [since]: the earliest time in ms to fetch orders for
456
456
  :param int [limit]: the maximum number of orde structures to retrieve
@@ -566,7 +566,7 @@ class kucoinfutures(ccxt.async_support.kucoinfutures):
566
566
  async def watch_balance(self, params={}):
567
567
  """
568
568
  watch balance and get the amount of funds available for trading or funds locked in orders
569
- see https://docs.kucoin.com/futures/#account-balance-events
569
+ :see: https://docs.kucoin.com/futures/#account-balance-events
570
570
  :param dict [params]: extra parameters specific to the kucoinfutures api endpoint
571
571
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
572
572
  """
ccxt/pro/luno.py CHANGED
@@ -40,7 +40,7 @@ class luno(ccxt.async_support.luno):
40
40
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
41
41
  """
42
42
  get the list of most recent trades for a particular symbol
43
- see https://www.luno.com/en/developers/api#tag/Streaming-API
43
+ :see: https://www.luno.com/en/developers/api#tag/Streaming-API
44
44
  :param str symbol: unified symbol of the market to fetch trades for
45
45
  :param int [since]: timestamp in ms of the earliest trade to fetch
46
46
  :param int [limit]: the maximum amount of trades to fetch
ccxt/pro/mexc.py CHANGED
@@ -193,7 +193,7 @@ class mexc(ccxt.async_support.mexc):
193
193
 
194
194
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit: Optional[int] = None, params={}):
195
195
  """
196
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#kline-streams
196
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#kline-streams
197
197
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
198
198
  :param str symbol: unified symbol of the market to fetch OHLCV data for
199
199
  :param str timeframe: the length of time each candle represents
@@ -333,7 +333,7 @@ class mexc(ccxt.async_support.mexc):
333
333
 
334
334
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
335
335
  """
336
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#diff-depth-stream
336
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#diff-depth-stream
337
337
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
338
338
  :param str symbol: unified symbol of the market to fetch the order book for
339
339
  :param int [limit]: the maximum amount of order book entries to return
@@ -484,7 +484,7 @@ class mexc(ccxt.async_support.mexc):
484
484
 
485
485
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
486
486
  """
487
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#trade-streams
487
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#trade-streams
488
488
  get the list of most recent trades for a particular symbol
489
489
  :param str symbol: unified symbol of the market to fetch trades for
490
490
  :param int [since]: timestamp in ms of the earliest trade to fetch
@@ -564,7 +564,7 @@ class mexc(ccxt.async_support.mexc):
564
564
 
565
565
  async def watch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
566
566
  """
567
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-deals
567
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-deals
568
568
  watches information on multiple trades made by the user
569
569
  :param str symbol: unified market symbol of the market trades were made in
570
570
  :param int [since]: the earliest time in ms to fetch trades for
@@ -681,8 +681,8 @@ class mexc(ccxt.async_support.mexc):
681
681
 
682
682
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
683
683
  """
684
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-orders
685
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#margin-account-orders
684
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-orders
685
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#margin-account-orders
686
686
  watches information on multiple orders made by the user
687
687
  :param str symbol: unified market symbol of the market orders were made in
688
688
  :param int [since]: the earliest time in ms to fetch orders for
@@ -923,7 +923,7 @@ class mexc(ccxt.async_support.mexc):
923
923
 
924
924
  async def watch_balance(self, params={}):
925
925
  """
926
- see https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-upadte
926
+ :see: https://mxcdevelop.github.io/apidocs/spot_v3_en/#spot-account-upadte
927
927
  watch balance and get the amount of funds available for trading or funds locked in orders
928
928
  :param dict [params]: extra parameters specific to the mexc3 api endpoint
929
929
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
ccxt/pro/okx.py CHANGED
@@ -247,7 +247,7 @@ class okx(ccxt.async_support.okx):
247
247
 
248
248
  async def watch_ticker(self, symbol: str, params={}):
249
249
  """
250
- see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
250
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
251
251
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
252
252
  :param str symbol: unified symbol of the market to fetch the ticker for
253
253
  :param dict [params]: extra parameters specific to the okx api endpoint
@@ -262,7 +262,7 @@ class okx(ccxt.async_support.okx):
262
262
 
263
263
  async def watch_tickers(self, symbols: Optional[List[str]] = None, params={}):
264
264
  """
265
- see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
265
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
266
266
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
267
267
  :param str[] [symbols]: unified symbol of the market to fetch the ticker for
268
268
  :param dict [params]: extra parameters specific to the okx api endpoint
@@ -768,7 +768,7 @@ class okx(ccxt.async_support.okx):
768
768
 
769
769
  async def watch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
770
770
  """
771
- see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
771
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
772
772
  watches information on multiple trades made by the user
773
773
  :param str [symbol]: unified market symbol of the market trades were made in
774
774
  :param int [since]: the earliest time in ms to fetch trades for
@@ -805,7 +805,7 @@ class okx(ccxt.async_support.okx):
805
805
 
806
806
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
807
807
  """
808
- see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
808
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
809
809
  watches information on multiple orders made by the user
810
810
  :param str [symbol]: unified market symbol of the market orders were made in
811
811
  :param int [since]: the earliest time in ms to fetch orders for
@@ -817,8 +817,8 @@ class okx(ccxt.async_support.okx):
817
817
  type = None
818
818
  # By default, receive order updates from any instrument type
819
819
  type, params = self.handle_option_and_params(params, 'watchOrders', 'type', 'ANY')
820
- isStop = self.safe_value(params, 'stop', False)
821
- params = self.omit(params, ['stop'])
820
+ isStop = self.safe_value_2(params, 'stop', 'trigger', False)
821
+ params = self.omit(params, ['stop', 'trigger'])
822
822
  await self.load_markets()
823
823
  await self.authenticate({'access': 'business' if isStop else 'private'})
824
824
  market = None
@@ -902,7 +902,8 @@ class okx(ccxt.async_support.okx):
902
902
  limit = self.safe_integer(self.options, 'ordersLimit', 1000)
903
903
  if self.orders is None:
904
904
  self.orders = ArrayCacheBySymbolById(limit)
905
- stored = self.orders
905
+ self.triggerOrders = ArrayCacheBySymbolById(limit)
906
+ stored = self.triggerOrders if (channel == 'orders-algo') else self.orders
906
907
  marketIds = []
907
908
  parsed = self.parse_orders(orders)
908
909
  for i in range(0, len(parsed)):
@@ -911,10 +912,10 @@ class okx(ccxt.async_support.okx):
911
912
  symbol = order['symbol']
912
913
  market = self.market(symbol)
913
914
  marketIds.append(market['id'])
914
- client.resolve(self.orders, channel)
915
+ client.resolve(stored, channel)
915
916
  for i in range(0, len(marketIds)):
916
917
  messageHash = channel + ':' + marketIds[i]
917
- client.resolve(self.orders, messageHash)
918
+ client.resolve(stored, messageHash)
918
919
 
919
920
  def handle_my_trades(self, client: Client, message):
920
921
  #
@@ -1005,7 +1006,7 @@ class okx(ccxt.async_support.okx):
1005
1006
 
1006
1007
  async def create_order_ws(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Optional[float] = None, params={}):
1007
1008
  """
1008
- see https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order
1009
+ :see: https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order
1009
1010
  create a trade order
1010
1011
  :param str symbol: unified symbol of the market to create an order in
1011
1012
  :param str type: 'market' or 'limit'
@@ -1069,8 +1070,8 @@ class okx(ccxt.async_support.okx):
1069
1070
  async def edit_order_ws(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Optional[float] = None, params={}):
1070
1071
  """
1071
1072
  edit a trade order
1072
- see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
1073
- see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
1073
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
1074
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
1074
1075
  :param str id: order id
1075
1076
  :param str symbol: unified symbol of the market to create an order in
1076
1077
  :param str type: 'market' or 'limit'
@@ -1096,7 +1097,7 @@ class okx(ccxt.async_support.okx):
1096
1097
 
1097
1098
  async def cancel_order_ws(self, id: str, symbol: Optional[str] = None, params={}):
1098
1099
  """
1099
- see https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade
1100
+ :see: https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade
1100
1101
  cancel multiple orders
1101
1102
  :param str id: order id
1102
1103
  :param str symbol: unified market symbol, default is None
@@ -1128,7 +1129,7 @@ class okx(ccxt.async_support.okx):
1128
1129
 
1129
1130
  async def cancel_orders_ws(self, ids: List[str], symbol: Optional[str] = None, params={}):
1130
1131
  """
1131
- see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
1132
+ :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
1132
1133
  cancel multiple orders
1133
1134
  :param str[] ids: order ids
1134
1135
  :param str symbol: unified market symbol, default is None
@@ -1160,7 +1161,7 @@ class okx(ccxt.async_support.okx):
1160
1161
 
1161
1162
  async def cancel_all_orders_ws(self, symbol: Optional[str] = None, params={}):
1162
1163
  """
1163
- see https://docs.okx.com/websockets/#message-cancelAll
1164
+ :see: https://docs.okx.com/websockets/#message-cancelAll
1164
1165
  cancel all open orders of a type. Only applicable to Option in Portfolio Margin mode, and MMP privilege is required.
1165
1166
  :param str symbol: unified market symbol, only orders in the market of self symbol are cancelled when symbol is not None
1166
1167
  :param dict [params]: extra parameters specific to the okx api endpoint
ccxt/pro/phemex.py CHANGED
@@ -286,9 +286,9 @@ class phemex(ccxt.async_support.phemex):
286
286
 
287
287
  async def watch_balance(self, params={}):
288
288
  """
289
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-account-order-position-aop
290
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-account-order-position-aop
291
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-wallet-order-messages
289
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-account-order-position-aop
290
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-account-order-position-aop
291
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-wallet-order-messages
292
292
  watch balance and get the amount of funds available for trading or funds locked in orders
293
293
  :param dict [params]: extra parameters specific to the phemex api endpoint
294
294
  :param str [params.settle]: set to USDT to use hedged perpetual api
@@ -470,9 +470,9 @@ class phemex(ccxt.async_support.phemex):
470
470
 
471
471
  async def watch_ticker(self, symbol: str, params={}):
472
472
  """
473
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-24-hours-ticker
474
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-24-hours-ticker
475
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-24-hours-ticker
473
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-24-hours-ticker
474
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-24-hours-ticker
475
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-24-hours-ticker
476
476
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
477
477
  :param str symbol: unified symbol of the market to fetch the ticker for
478
478
  :param dict [params]: extra parameters specific to the phemex api endpoint
@@ -500,9 +500,9 @@ class phemex(ccxt.async_support.phemex):
500
500
 
501
501
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
502
502
  """
503
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-trade
504
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-trade
505
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-trade
503
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-trade
504
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-trade
505
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-trade
506
506
  get the list of most recent trades for a particular symbol
507
507
  :param str symbol: unified symbol of the market to fetch trades for
508
508
  :param int [since]: timestamp in ms of the earliest trade to fetch
@@ -535,9 +535,9 @@ class phemex(ccxt.async_support.phemex):
535
535
 
536
536
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
537
537
  """
538
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-orderbook-for-new-model
539
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-30-levels-orderbook
540
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-orderbook
538
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-orderbook-for-new-model
539
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-30-levels-orderbook
540
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-orderbook
541
541
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
542
542
  :param str symbol: unified symbol of the market to fetch the order book for
543
543
  :param int [limit]: the maximum amount of order book entries to return
@@ -567,9 +567,9 @@ class phemex(ccxt.async_support.phemex):
567
567
 
568
568
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit: Optional[int] = None, params={}):
569
569
  """
570
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-kline
571
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-kline
572
- see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-kline
570
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#subscribe-kline
571
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#subscribe-kline
572
+ :see: https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#subscribe-kline
573
573
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
574
574
  :param str symbol: unified symbol of the market to fetch OHLCV data for
575
575
  :param str timeframe: the length of time each candle represents
ccxt/pro/poloniex.py CHANGED
@@ -75,7 +75,7 @@ class poloniex(ccxt.async_support.poloniex):
75
75
  """
76
76
  * @ignore
77
77
  authenticates the user to access private web socket channels
78
- see https://docs.poloniex.com/#authenticated-channels-market-data-authentication
78
+ :see: https://docs.poloniex.com/#authenticated-channels-market-data-authentication
79
79
  :returns dict: response from exchange
80
80
  """
81
81
  self.check_required_credentials()
@@ -156,7 +156,7 @@ class poloniex(ccxt.async_support.poloniex):
156
156
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit: Optional[int] = None, params={}):
157
157
  """
158
158
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
159
- see https://docs.poloniex.com/#public-channels-market-data-candlesticks
159
+ :see: https://docs.poloniex.com/#public-channels-market-data-candlesticks
160
160
  :param str symbol: unified symbol of the market to fetch OHLCV data for
161
161
  :param str timeframe: the length of time each candle represents
162
162
  :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -177,7 +177,7 @@ class poloniex(ccxt.async_support.poloniex):
177
177
  async def watch_ticker(self, symbol: str, params={}):
178
178
  """
179
179
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
180
- see https://docs.poloniex.com/#public-channels-market-data-ticker
180
+ :see: https://docs.poloniex.com/#public-channels-market-data-ticker
181
181
  :param str symbol: unified symbol of the market to fetch the ticker for
182
182
  :param dict [params]: extra parameters specific to the poloniex api endpoint
183
183
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -190,7 +190,7 @@ class poloniex(ccxt.async_support.poloniex):
190
190
  async def watch_tickers(self, symbols=None, params={}):
191
191
  """
192
192
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
193
- see https://docs.poloniex.com/#public-channels-market-data-ticker
193
+ :see: https://docs.poloniex.com/#public-channels-market-data-ticker
194
194
  :param str symbol: unified symbol of the market to fetch the ticker for
195
195
  :param dict [params]: extra parameters specific to the poloniex api endpoint
196
196
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -206,7 +206,7 @@ class poloniex(ccxt.async_support.poloniex):
206
206
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
207
207
  """
208
208
  get the list of most recent trades for a particular symbol
209
- see https://docs.poloniex.com/#public-channels-market-data-trades
209
+ :see: https://docs.poloniex.com/#public-channels-market-data-trades
210
210
  :param str symbol: unified symbol of the market to fetch trades for
211
211
  :param int [since]: timestamp in ms of the earliest trade to fetch
212
212
  :param int [limit]: the maximum amount of trades to fetch
@@ -224,7 +224,7 @@ class poloniex(ccxt.async_support.poloniex):
224
224
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
225
225
  """
226
226
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
227
- see https://docs.poloniex.com/#public-channels-market-data-book-level-2
227
+ :see: https://docs.poloniex.com/#public-channels-market-data-book-level-2
228
228
  :param str symbol: unified symbol of the market to fetch the order book for
229
229
  :param int [limit]: not used by poloniex watchOrderBook
230
230
  :param dict [params]: extra parameters specific to the poloniex api endpoint
@@ -240,7 +240,7 @@ class poloniex(ccxt.async_support.poloniex):
240
240
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
241
241
  """
242
242
  watches information on multiple orders made by the user
243
- see https://docs.poloniex.com/#authenticated-channels-market-data-orders
243
+ :see: https://docs.poloniex.com/#authenticated-channels-market-data-orders
244
244
  :param str symbol: unified market symbol of the market orders were made in
245
245
  :param int [since]: not used by poloniex watchOrders
246
246
  :param int [limit]: not used by poloniex watchOrders
@@ -261,7 +261,7 @@ class poloniex(ccxt.async_support.poloniex):
261
261
  async def watch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
262
262
  """
263
263
  watches information on multiple trades made by the user using orders stream
264
- see https://docs.poloniex.com/#authenticated-channels-market-data-orders
264
+ :see: https://docs.poloniex.com/#authenticated-channels-market-data-orders
265
265
  :param str symbol: unified market symbol of the market orders were made in
266
266
  :param int [since]: not used by poloniex watchMyTrades
267
267
  :param int [limit]: not used by poloniex watchMyTrades
@@ -283,7 +283,7 @@ class poloniex(ccxt.async_support.poloniex):
283
283
  async def watch_balance(self, params={}):
284
284
  """
285
285
  watch balance and get the amount of funds available for trading or funds locked in orders
286
- see https://docs.poloniex.com/#authenticated-channels-market-data-balances
286
+ :see: https://docs.poloniex.com/#authenticated-channels-market-data-balances
287
287
  :param dict [params]: extra parameters specific to the poloniex api endpoint
288
288
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
289
289
  """
@@ -214,7 +214,7 @@ class poloniexfutures(ccxt.async_support.poloniexfutures):
214
214
  async def watch_ticker(self, symbol: str, params={}):
215
215
  """
216
216
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
217
- see https://futures-docs.poloniex.com/#get-real-time-symbol-ticker
217
+ :see: https://futures-docs.poloniex.com/#get-real-time-symbol-ticker
218
218
  :param str symbol: unified symbol of the market to fetch the ticker for
219
219
  :param dict [params]: extra parameters specific to the poloniexfutures api endpoint
220
220
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -227,7 +227,7 @@ class poloniexfutures(ccxt.async_support.poloniexfutures):
227
227
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
228
228
  """
229
229
  get the list of most recent trades for a particular symbol
230
- see https://futures-docs.poloniex.com/#full-matching-engine-data-level-3
230
+ :see: https://futures-docs.poloniex.com/#full-matching-engine-data-level-3
231
231
  :param str symbol: unified symbol of the market to fetch trades for
232
232
  :param int [since]: timestamp in ms of the earliest trade to fetch
233
233
  :param int [limit]: the maximum amount of trades to fetch
@@ -247,7 +247,7 @@ class poloniexfutures(ccxt.async_support.poloniexfutures):
247
247
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
248
248
  """
249
249
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
250
- see https://futures-docs.poloniex.com/#level-2-market-data
250
+ :see: https://futures-docs.poloniex.com/#level-2-market-data
251
251
  :param str symbol: unified symbol of the market to fetch the order book for
252
252
  :param int [limit]: not used by poloniexfutures watchOrderBook
253
253
  :param dict [params]: extra parameters specific to the poloniexfutures api endpoint
@@ -273,7 +273,7 @@ class poloniexfutures(ccxt.async_support.poloniexfutures):
273
273
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
274
274
  """
275
275
  watches information on multiple orders made by the user
276
- see https://futures-docs.poloniex.com/#private-messages
276
+ :see: https://futures-docs.poloniex.com/#private-messages
277
277
  :param str symbol: filter by unified market symbol of the market orders were made in
278
278
  :param int [since]: the earliest time in ms to fetch orders for
279
279
  :param int [limit]: the maximum number of orde structures to retrieve
@@ -296,7 +296,7 @@ class poloniexfutures(ccxt.async_support.poloniexfutures):
296
296
  async def watch_balance(self, params={}):
297
297
  """
298
298
  watch balance and get the amount of funds available for trading or funds locked in orders
299
- see https://futures-docs.poloniex.com/#account-balance-events
299
+ :see: https://futures-docs.poloniex.com/#account-balance-events
300
300
  :param dict [params]: extra parameters specific to the poloniexfutures api endpoint
301
301
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
302
302
  """
ccxt/pro/probit.py CHANGED
@@ -58,7 +58,7 @@ class probit(ccxt.async_support.probit):
58
58
  async def watch_balance(self, params={}):
59
59
  """
60
60
  watch balance and get the amount of funds available for trading or funds locked in orders
61
- see https://docs-en.probit.com/reference/balance-1
61
+ :see: https://docs-en.probit.com/reference/balance-1
62
62
  :param dict [params]: extra parameters specific to the probit api endpoint
63
63
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
64
64
  """
@@ -120,7 +120,7 @@ class probit(ccxt.async_support.probit):
120
120
  async def watch_ticker(self, symbol: str, params={}):
121
121
  """
122
122
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
123
- see https://docs-en.probit.com/reference/marketdata
123
+ :see: https://docs-en.probit.com/reference/marketdata
124
124
  :param str symbol: unified symbol of the market to fetch the ticker for
125
125
  :param dict [params]: extra parameters specific to the probit api endpoint
126
126
  :param int [params.interval]: Unit time to synchronize market information(ms). Available units: 100, 500
@@ -161,7 +161,7 @@ class probit(ccxt.async_support.probit):
161
161
  async def watch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
162
162
  """
163
163
  get the list of most recent trades for a particular symbol
164
- see https://docs-en.probit.com/reference/trade_history
164
+ :see: https://docs-en.probit.com/reference/trade_history
165
165
  :param str symbol: unified symbol of the market to fetch trades for
166
166
  :param int [since]: timestamp in ms of the earliest trade to fetch
167
167
  :param int [limit]: the maximum amount of trades to fetch
@@ -290,7 +290,7 @@ class probit(ccxt.async_support.probit):
290
290
  async def watch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
291
291
  """
292
292
  watches information on an order made by the user
293
- see https://docs-en.probit.com/reference/open_order
293
+ :see: https://docs-en.probit.com/reference/open_order
294
294
  :param str symbol: unified symbol of the market the order was made in
295
295
  :param int [since]: timestamp in ms of the earliest order to watch
296
296
  :param int [limit]: the maximum amount of orders to watch
@@ -369,7 +369,7 @@ class probit(ccxt.async_support.probit):
369
369
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
370
370
  """
371
371
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
372
- see https://docs-en.probit.com/reference/marketdata
372
+ :see: https://docs-en.probit.com/reference/marketdata
373
373
  :param str symbol: unified symbol of the market to fetch the order book for
374
374
  :param int [limit]: the maximum amount of order book entries to return
375
375
  :param dict [params]: extra parameters specific to the probit api endpoint
ccxt/pro/wazirx.py CHANGED
@@ -50,7 +50,7 @@ class wazirx(ccxt.async_support.wazirx):
50
50
  async def watch_balance(self, params={}):
51
51
  """
52
52
  watch balance and get the amount of funds available for trading or funds locked in orders
53
- see https://docs.wazirx.com/#account-update
53
+ :see: https://docs.wazirx.com/#account-update
54
54
  :param dict [params]: extra parameters specific to the wazirx api endpoint
55
55
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
56
56
  """
@@ -166,7 +166,7 @@ class wazirx(ccxt.async_support.wazirx):
166
166
  async def watch_ticker(self, symbol: str, params={}):
167
167
  """
168
168
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
169
- see https://docs.wazirx.com/#all-market-tickers-stream
169
+ :see: https://docs.wazirx.com/#all-market-tickers-stream
170
170
  :param str symbol: unified symbol of the market to fetch the ticker for
171
171
  :param dict [params]: extra parameters specific to the wazirx api endpoint
172
172
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -187,7 +187,7 @@ class wazirx(ccxt.async_support.wazirx):
187
187
  async def watch_tickers(self, symbols: Optional[List[str]] = None, params={}):
188
188
  """
189
189
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
190
- see https://docs.wazirx.com/#all-market-tickers-stream
190
+ :see: https://docs.wazirx.com/#all-market-tickers-stream
191
191
  :param str[] symbols: unified symbol of the market to fetch the ticker for
192
192
  :param dict [params]: extra parameters specific to the wazirx api endpoint
193
193
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -343,7 +343,7 @@ class wazirx(ccxt.async_support.wazirx):
343
343
  async def watch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
344
344
  """
345
345
  watch trades by user
346
- see https://docs.wazirx.com/#trade-update
346
+ :see: https://docs.wazirx.com/#trade-update
347
347
  :param str symbol: unified symbol of the market to fetch trades for
348
348
  :param int [since]: timestamp in ms of the earliest trade to fetch
349
349
  :param int [limit]: the maximum amount of trades to fetch
@@ -455,7 +455,7 @@ class wazirx(ccxt.async_support.wazirx):
455
455
  async def watch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
456
456
  """
457
457
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
458
- see https://docs.wazirx.com/#depth-stream
458
+ :see: https://docs.wazirx.com/#depth-stream
459
459
  :param str symbol: unified symbol of the market to fetch the order book for
460
460
  :param int [limit]: the maximum amount of order book entries to return
461
461
  :param dict [params]: extra parameters specific to the wazirx api endpoint
ccxt/pro/woo.py CHANGED
@@ -593,7 +593,7 @@ class woo(ccxt.async_support.woo):
593
593
 
594
594
  async def watch_balance(self, params={}):
595
595
  """
596
- see https://docs.woo.org/#balance
596
+ :see: https://docs.woo.org/#balance
597
597
  watch balance and get the amount of funds available for trading or funds locked in orders
598
598
  :param dict [params]: extra parameters specific to the woo api endpoint
599
599
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`