ccxt 4.4.29__py2.py3-none-any.whl → 4.4.31__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 (273) hide show
  1. ccxt/__init__.py +1 -1
  2. ccxt/abstract/alpaca.py +1 -0
  3. ccxt/abstract/binance.py +9 -0
  4. ccxt/abstract/binancecoinm.py +9 -0
  5. ccxt/abstract/binanceus.py +9 -0
  6. ccxt/abstract/binanceusdm.py +9 -0
  7. ccxt/ace.py +36 -12
  8. ccxt/alpaca.py +113 -28
  9. ccxt/ascendex.py +65 -30
  10. ccxt/async_support/__init__.py +1 -1
  11. ccxt/async_support/ace.py +36 -12
  12. ccxt/async_support/alpaca.py +113 -28
  13. ccxt/async_support/ascendex.py +65 -30
  14. ccxt/async_support/base/exchange.py +3 -3
  15. ccxt/async_support/bigone.py +71 -27
  16. ccxt/async_support/binance.py +564 -323
  17. ccxt/async_support/bingx.py +208 -108
  18. ccxt/async_support/bit2c.py +34 -12
  19. ccxt/async_support/bitbank.py +42 -14
  20. ccxt/async_support/bitbns.py +29 -21
  21. ccxt/async_support/bitfinex.py +77 -33
  22. ccxt/async_support/bitfinex2.py +116 -44
  23. ccxt/async_support/bitflyer.py +54 -18
  24. ccxt/async_support/bitget.py +277 -145
  25. ccxt/async_support/bithumb.py +39 -14
  26. ccxt/async_support/bitmart.py +198 -132
  27. ccxt/async_support/bitmex.py +90 -30
  28. ccxt/async_support/bitopro.py +66 -22
  29. ccxt/async_support/bitrue.py +109 -57
  30. ccxt/async_support/bitso.py +55 -19
  31. ccxt/async_support/bitstamp.py +84 -36
  32. ccxt/async_support/bitteam.py +51 -17
  33. ccxt/async_support/bitvavo.py +57 -19
  34. ccxt/async_support/bl3p.py +26 -10
  35. ccxt/async_support/blockchaincom.py +63 -21
  36. ccxt/async_support/blofin.py +95 -38
  37. ccxt/async_support/btcalpha.py +48 -16
  38. ccxt/async_support/btcbox.py +27 -9
  39. ccxt/async_support/btcmarkets.py +57 -19
  40. ccxt/async_support/btcturk.py +36 -12
  41. ccxt/async_support/bybit.py +251 -95
  42. ccxt/async_support/cex.py +65 -22
  43. ccxt/async_support/coinbase.py +138 -56
  44. ccxt/async_support/coinbaseexchange.py +76 -28
  45. ccxt/async_support/coinbaseinternational.py +75 -27
  46. ccxt/async_support/coincatch.py +191 -97
  47. ccxt/async_support/coincheck.py +33 -11
  48. ccxt/async_support/coinex.py +212 -101
  49. ccxt/async_support/coinlist.py +87 -30
  50. ccxt/async_support/coinmate.py +55 -24
  51. ccxt/async_support/coinmetro.py +52 -18
  52. ccxt/async_support/coinone.py +27 -10
  53. ccxt/async_support/coinsph.py +73 -27
  54. ccxt/async_support/coinspot.py +25 -9
  55. ccxt/async_support/cryptocom.py +103 -38
  56. ccxt/async_support/currencycom.py +70 -23
  57. ccxt/async_support/delta.py +90 -30
  58. ccxt/async_support/deribit.py +138 -53
  59. ccxt/async_support/digifinex.py +114 -51
  60. ccxt/async_support/exmo.py +104 -45
  61. ccxt/async_support/gate.py +298 -155
  62. ccxt/async_support/gemini.py +57 -20
  63. ccxt/async_support/hashkey.py +151 -66
  64. ccxt/async_support/hitbtc.py +156 -73
  65. ccxt/async_support/hollaex.py +76 -25
  66. ccxt/async_support/htx.py +297 -240
  67. ccxt/async_support/huobijp.py +1 -0
  68. ccxt/async_support/hyperliquid.py +203 -42
  69. ccxt/async_support/idex.py +73 -24
  70. ccxt/async_support/independentreserve.py +12 -5
  71. ccxt/async_support/indodax.py +53 -16
  72. ccxt/async_support/kraken.py +107 -35
  73. ccxt/async_support/krakenfutures.py +88 -34
  74. ccxt/async_support/kucoin.py +211 -109
  75. ccxt/async_support/kucoinfutures.py +119 -42
  76. ccxt/async_support/kuna.py +80 -39
  77. ccxt/async_support/latoken.py +70 -33
  78. ccxt/async_support/lbank.py +90 -39
  79. ccxt/async_support/luno.py +54 -19
  80. ccxt/async_support/lykke.py +54 -19
  81. ccxt/async_support/mercado.py +1 -0
  82. ccxt/async_support/mexc.py +226 -108
  83. ccxt/async_support/ndax.py +58 -19
  84. ccxt/async_support/novadax.py +67 -22
  85. ccxt/async_support/oceanex.py +58 -19
  86. ccxt/async_support/okcoin.py +81 -38
  87. ccxt/async_support/okx.py +270 -109
  88. ccxt/async_support/onetrading.py +3 -1
  89. ccxt/async_support/oxfun.py +95 -36
  90. ccxt/async_support/p2b.py +49 -23
  91. ccxt/async_support/paradex.py +75 -27
  92. ccxt/async_support/paymium.py +31 -11
  93. ccxt/async_support/phemex.py +91 -41
  94. ccxt/async_support/poloniex.py +80 -30
  95. ccxt/async_support/poloniexfutures.py +72 -30
  96. ccxt/async_support/probit.py +64 -22
  97. ccxt/async_support/timex.py +58 -19
  98. ccxt/async_support/tokocrypto.py +63 -22
  99. ccxt/async_support/tradeogre.py +7 -2
  100. ccxt/async_support/upbit.py +72 -25
  101. ccxt/async_support/vertex.py +74 -28
  102. ccxt/async_support/wavesexchange.py +29 -8
  103. ccxt/async_support/wazirx.py +51 -17
  104. ccxt/async_support/whitebit.py +105 -41
  105. ccxt/async_support/woo.py +162 -65
  106. ccxt/async_support/woofipro.py +118 -49
  107. ccxt/async_support/xt.py +150 -73
  108. ccxt/async_support/yobit.py +49 -16
  109. ccxt/async_support/zaif.py +30 -10
  110. ccxt/async_support/zonda.py +46 -16
  111. ccxt/base/exchange.py +34 -34
  112. ccxt/base/types.py +1 -0
  113. ccxt/bigone.py +71 -27
  114. ccxt/binance.py +564 -323
  115. ccxt/bingx.py +208 -108
  116. ccxt/bit2c.py +34 -12
  117. ccxt/bitbank.py +42 -14
  118. ccxt/bitbns.py +29 -21
  119. ccxt/bitfinex.py +77 -33
  120. ccxt/bitfinex2.py +116 -44
  121. ccxt/bitflyer.py +54 -18
  122. ccxt/bitget.py +277 -145
  123. ccxt/bithumb.py +39 -14
  124. ccxt/bitmart.py +198 -132
  125. ccxt/bitmex.py +90 -30
  126. ccxt/bitopro.py +66 -22
  127. ccxt/bitrue.py +109 -57
  128. ccxt/bitso.py +55 -19
  129. ccxt/bitstamp.py +84 -36
  130. ccxt/bitteam.py +51 -17
  131. ccxt/bitvavo.py +57 -19
  132. ccxt/bl3p.py +26 -10
  133. ccxt/blockchaincom.py +63 -21
  134. ccxt/blofin.py +95 -38
  135. ccxt/btcalpha.py +48 -16
  136. ccxt/btcbox.py +27 -9
  137. ccxt/btcmarkets.py +57 -19
  138. ccxt/btcturk.py +36 -12
  139. ccxt/bybit.py +251 -95
  140. ccxt/cex.py +65 -22
  141. ccxt/coinbase.py +138 -56
  142. ccxt/coinbaseexchange.py +76 -28
  143. ccxt/coinbaseinternational.py +75 -27
  144. ccxt/coincatch.py +191 -97
  145. ccxt/coincheck.py +33 -11
  146. ccxt/coinex.py +212 -101
  147. ccxt/coinlist.py +87 -30
  148. ccxt/coinmate.py +55 -24
  149. ccxt/coinmetro.py +52 -18
  150. ccxt/coinone.py +27 -10
  151. ccxt/coinsph.py +73 -27
  152. ccxt/coinspot.py +25 -9
  153. ccxt/cryptocom.py +103 -38
  154. ccxt/currencycom.py +70 -23
  155. ccxt/delta.py +90 -30
  156. ccxt/deribit.py +138 -53
  157. ccxt/digifinex.py +114 -51
  158. ccxt/exmo.py +104 -45
  159. ccxt/gate.py +298 -155
  160. ccxt/gemini.py +57 -20
  161. ccxt/hashkey.py +151 -66
  162. ccxt/hitbtc.py +156 -73
  163. ccxt/hollaex.py +76 -25
  164. ccxt/htx.py +297 -240
  165. ccxt/huobijp.py +1 -0
  166. ccxt/hyperliquid.py +203 -42
  167. ccxt/idex.py +73 -24
  168. ccxt/independentreserve.py +12 -5
  169. ccxt/indodax.py +53 -16
  170. ccxt/kraken.py +107 -35
  171. ccxt/krakenfutures.py +88 -34
  172. ccxt/kucoin.py +211 -109
  173. ccxt/kucoinfutures.py +119 -42
  174. ccxt/kuna.py +80 -39
  175. ccxt/latoken.py +70 -33
  176. ccxt/lbank.py +90 -39
  177. ccxt/luno.py +54 -19
  178. ccxt/lykke.py +54 -19
  179. ccxt/mercado.py +1 -0
  180. ccxt/mexc.py +226 -108
  181. ccxt/ndax.py +58 -19
  182. ccxt/novadax.py +67 -22
  183. ccxt/oceanex.py +58 -19
  184. ccxt/okcoin.py +81 -38
  185. ccxt/okx.py +270 -109
  186. ccxt/onetrading.py +3 -1
  187. ccxt/oxfun.py +95 -36
  188. ccxt/p2b.py +49 -23
  189. ccxt/paradex.py +75 -27
  190. ccxt/paymium.py +31 -11
  191. ccxt/phemex.py +91 -41
  192. ccxt/poloniex.py +80 -30
  193. ccxt/poloniexfutures.py +72 -30
  194. ccxt/pro/__init__.py +1 -1
  195. ccxt/pro/alpaca.py +15 -5
  196. ccxt/pro/ascendex.py +18 -6
  197. ccxt/pro/binance.py +200 -119
  198. ccxt/pro/bingx.py +44 -24
  199. ccxt/pro/bitfinex.py +13 -5
  200. ccxt/pro/bitget.py +75 -36
  201. ccxt/pro/bithumb.py +12 -4
  202. ccxt/pro/bitmart.py +44 -20
  203. ccxt/pro/bitmex.py +42 -14
  204. ccxt/pro/bitopro.py +15 -5
  205. ccxt/pro/bitrue.py +7 -3
  206. ccxt/pro/bitvavo.py +51 -17
  207. ccxt/pro/blockchaincom.py +18 -6
  208. ccxt/pro/blofin.py +38 -13
  209. ccxt/pro/bybit.py +100 -42
  210. ccxt/pro/cex.py +48 -16
  211. ccxt/pro/coinbase.py +32 -12
  212. ccxt/pro/coinbaseexchange.py +1 -1
  213. ccxt/pro/coinbaseinternational.py +34 -14
  214. ccxt/pro/coincatch.py +54 -19
  215. ccxt/pro/coincheck.py +6 -2
  216. ccxt/pro/coinex.py +40 -20
  217. ccxt/pro/coinone.py +9 -3
  218. ccxt/pro/cryptocom.py +70 -26
  219. ccxt/pro/deribit.py +36 -12
  220. ccxt/pro/exmo.py +10 -4
  221. ccxt/pro/gate.py +64 -30
  222. ccxt/pro/gemini.py +21 -7
  223. ccxt/pro/hashkey.py +26 -8
  224. ccxt/pro/hitbtc.py +61 -37
  225. ccxt/pro/hollaex.py +15 -5
  226. ccxt/pro/htx.py +39 -21
  227. ccxt/pro/hyperliquid.py +41 -14
  228. ccxt/pro/kraken.py +49 -17
  229. ccxt/pro/krakenfutures.py +47 -24
  230. ccxt/pro/kucoin.py +60 -31
  231. ccxt/pro/kucoinfutures.py +41 -19
  232. ccxt/pro/lbank.py +27 -9
  233. ccxt/pro/luno.py +3 -1
  234. ccxt/pro/mexc.py +35 -17
  235. ccxt/pro/ndax.py +12 -4
  236. ccxt/pro/okcoin.py +18 -6
  237. ccxt/pro/okx.py +76 -28
  238. ccxt/pro/onetrading.py +21 -7
  239. ccxt/pro/oxfun.py +54 -20
  240. ccxt/pro/p2b.py +23 -11
  241. ccxt/pro/paradex.py +12 -4
  242. ccxt/pro/phemex.py +31 -19
  243. ccxt/pro/poloniex.py +50 -22
  244. ccxt/pro/poloniexfutures.py +17 -7
  245. ccxt/pro/probit.py +18 -6
  246. ccxt/pro/upbit.py +25 -9
  247. ccxt/pro/vertex.py +20 -6
  248. ccxt/pro/wazirx.py +21 -7
  249. ccxt/pro/whitebit.py +25 -9
  250. ccxt/pro/woo.py +32 -12
  251. ccxt/pro/woofipro.py +35 -13
  252. ccxt/pro/xt.py +46 -26
  253. ccxt/probit.py +64 -22
  254. ccxt/test/tests_helpers.py +2 -2
  255. ccxt/timex.py +58 -19
  256. ccxt/tokocrypto.py +63 -22
  257. ccxt/tradeogre.py +7 -2
  258. ccxt/upbit.py +72 -25
  259. ccxt/vertex.py +74 -28
  260. ccxt/wavesexchange.py +29 -8
  261. ccxt/wazirx.py +51 -17
  262. ccxt/whitebit.py +105 -41
  263. ccxt/woo.py +162 -65
  264. ccxt/woofipro.py +118 -49
  265. ccxt/xt.py +150 -73
  266. ccxt/yobit.py +49 -16
  267. ccxt/zaif.py +30 -10
  268. ccxt/zonda.py +46 -16
  269. {ccxt-4.4.29.dist-info → ccxt-4.4.31.dist-info}/METADATA +5 -5
  270. {ccxt-4.4.29.dist-info → ccxt-4.4.31.dist-info}/RECORD +273 -273
  271. {ccxt-4.4.29.dist-info → ccxt-4.4.31.dist-info}/LICENSE.txt +0 -0
  272. {ccxt-4.4.29.dist-info → ccxt-4.4.31.dist-info}/WHEEL +0 -0
  273. {ccxt-4.4.29.dist-info → ccxt-4.4.31.dist-info}/top_level.txt +0 -0
ccxt/pro/okcoin.py CHANGED
@@ -73,7 +73,9 @@ class okcoin(ccxt.async_support.okcoin):
73
73
  async def watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
74
74
  """
75
75
  get the list of most recent trades for a particular symbol
76
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-trades-channel
76
+
77
+ https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-trades-channel
78
+
77
79
  :param str symbol: unified symbol of the market to fetch trades for
78
80
  :param int [since]: timestamp in ms of the earliest trade to fetch
79
81
  :param int [limit]: the maximum amount of trades to fetch
@@ -90,7 +92,9 @@ class okcoin(ccxt.async_support.okcoin):
90
92
  async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
91
93
  """
92
94
  watches information on multiple orders made by the user
93
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-order-channel
95
+
96
+ https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-order-channel
97
+
94
98
  :param str symbol: unified market symbol of the market orders were made in
95
99
  :param int [since]: the earliest time in ms to fetch orders for
96
100
  :param int [limit]: the maximum number of order structures to retrieve
@@ -169,7 +173,9 @@ class okcoin(ccxt.async_support.okcoin):
169
173
  async def watch_ticker(self, symbol: str, params={}) -> Ticker:
170
174
  """
171
175
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
172
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-tickers-channel
176
+
177
+ https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-tickers-channel
178
+
173
179
  :param str symbol: unified symbol of the market to fetch the ticker for
174
180
  :param dict [params]: extra parameters specific to the exchange API endpoint
175
181
  :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -245,7 +251,9 @@ class okcoin(ccxt.async_support.okcoin):
245
251
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
246
252
  """
247
253
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
248
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-candlesticks-channel
254
+
255
+ https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-candlesticks-channel
256
+
249
257
  :param str symbol: unified symbol of the market to fetch OHLCV data for
250
258
  :param str timeframe: the length of time each candle represents
251
259
  :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -308,7 +316,9 @@ class okcoin(ccxt.async_support.okcoin):
308
316
  async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
309
317
  """
310
318
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
311
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-order-book-channel
319
+
320
+ https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-order-book-channel
321
+
312
322
  :param str symbol: unified symbol of the market to fetch the order book for
313
323
  :param int [limit]: the maximum amount of order book entries to return
314
324
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -463,7 +473,9 @@ class okcoin(ccxt.async_support.okcoin):
463
473
  async def watch_balance(self, params={}) -> Balances:
464
474
  """
465
475
  watch balance and get the amount of funds available for trading or funds locked in orders
466
- :see: https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-account-channel
476
+
477
+ https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-account-channel
478
+
467
479
  :param dict [params]: extra parameters specific to the exchange API endpoint
468
480
  :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
469
481
  """
ccxt/pro/okx.py CHANGED
@@ -185,7 +185,7 @@ class okx(ccxt.async_support.okx):
185
185
  async def watch_trades_for_symbols(self, symbols: List[str], since: Int = None, limit: Int = None, params={}) -> List[Trade]:
186
186
  """
187
187
  get the list of most recent trades for a particular symbol
188
- :param str symbol: unified symbol of the market to fetch trades for
188
+ :param str symbols:
189
189
  :param int [since]: timestamp in ms of the earliest trade to fetch
190
190
  :param int [limit]: the maximum amount of trades to fetch
191
191
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -223,7 +223,7 @@ class okx(ccxt.async_support.okx):
223
223
  async def un_watch_trades_for_symbols(self, symbols: List[str], params={}) -> Any:
224
224
  """
225
225
  unWatches from the stream channel
226
- :param str symbol: unified symbol of the market to fetch trades for
226
+ :param str[] symbols:
227
227
  :param dict [params]: extra parameters specific to the exchange API endpoint
228
228
  :returns dict[]: a list of `trade structures <https://docs.ccxt.com/#/?id=public-trades>`
229
229
  """
@@ -292,7 +292,9 @@ class okx(ccxt.async_support.okx):
292
292
  async def watch_funding_rate(self, symbol: str, params={}) -> FundingRate:
293
293
  """
294
294
  watch the current funding rate
295
- :see: https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel
295
+
296
+ https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel
297
+
296
298
  :param str symbol: unified market symbol
297
299
  :param dict [params]: extra parameters specific to the exchange API endpoint
298
300
  :returns dict: a `funding rate structure <https://docs.ccxt.com/#/?id=funding-rate-structure>`
@@ -304,7 +306,9 @@ class okx(ccxt.async_support.okx):
304
306
  async def watch_funding_rates(self, symbols: List[str], params={}) -> FundingRates:
305
307
  """
306
308
  watch the funding rate for multiple markets
307
- :see: https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel
309
+
310
+ https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel
311
+
308
312
  :param str[] symbols: list of unified market symbols
309
313
  :param dict [params]: extra parameters specific to the exchange API endpoint
310
314
  :returns dict: a dictionary of `funding rates structures <https://docs.ccxt.com/#/?id=funding-rates-structure>`, indexe by market symbols
@@ -366,7 +370,9 @@ class okx(ccxt.async_support.okx):
366
370
 
367
371
  async def watch_ticker(self, symbol: str, params={}) -> Ticker:
368
372
  """
369
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
373
+
374
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
375
+
370
376
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
371
377
  :param str symbol: unified symbol of the market to fetch the ticker for
372
378
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -383,7 +389,9 @@ class okx(ccxt.async_support.okx):
383
389
 
384
390
  async def un_watch_ticker(self, symbol: str, params={}) -> Any:
385
391
  """
386
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
392
+
393
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
394
+
387
395
  unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
388
396
  :param str symbol: unified symbol of the market to fetch the ticker for
389
397
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -394,7 +402,9 @@ class okx(ccxt.async_support.okx):
394
402
 
395
403
  async def watch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
396
404
  """
397
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
405
+
406
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
407
+
398
408
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
399
409
  :param str[] [symbols]: unified symbol of the market to fetch the ticker for
400
410
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -412,7 +422,9 @@ class okx(ccxt.async_support.okx):
412
422
 
413
423
  async def watch_mark_price(self, symbol: str, params={}) -> Ticker:
414
424
  """
415
- :see: https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel
425
+
426
+ https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel
427
+
416
428
  watches a mark price
417
429
  :param str symbol: unified symbol of the market to fetch the ticker for
418
430
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -429,7 +441,9 @@ class okx(ccxt.async_support.okx):
429
441
 
430
442
  async def watch_mark_prices(self, symbols: Strings = None, params={}) -> Tickers:
431
443
  """
432
- :see: https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel
444
+
445
+ https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel
446
+
433
447
  watches mark prices
434
448
  :param str[] [symbols]: unified symbol of the market to fetch the ticker for
435
449
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -447,7 +461,9 @@ class okx(ccxt.async_support.okx):
447
461
 
448
462
  async def un_watch_tickers(self, symbols: Strings = None, params={}) -> Any:
449
463
  """
450
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
464
+
465
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
466
+
451
467
  unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
452
468
  :param str[] [symbols]: unified symbol of the market to fetch the ticker for
453
469
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -519,7 +535,9 @@ class okx(ccxt.async_support.okx):
519
535
 
520
536
  async def watch_bids_asks(self, symbols: Strings = None, params={}) -> Tickers:
521
537
  """
522
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
538
+
539
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel
540
+
523
541
  watches best bid & ask for symbols
524
542
  :param str[] symbols: unified symbol of the market to fetch the ticker for
525
543
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -604,8 +622,10 @@ class okx(ccxt.async_support.okx):
604
622
  async def watch_liquidations_for_symbols(self, symbols: List[str] = None, since: Int = None, limit: Int = None, params={}) -> List[Liquidation]:
605
623
  """
606
624
  watch the public liquidations of a trading pair
607
- :see: https://www.okx.com/docs-v5/en/#public-data-websocket-liquidation-orders-channel
608
- :param str symbol: unified CCXT market symbol
625
+
626
+ https://www.okx.com/docs-v5/en/#public-data-websocket-liquidation-orders-channel
627
+
628
+ :param str symbols:
609
629
  :param int [since]: the earliest time in ms to fetch liquidations for
610
630
  :param int [limit]: the maximum number of liquidation structures to retrieve
611
631
  :param dict [params]: exchange specific parameters for the okx api endpoint
@@ -690,8 +710,10 @@ class okx(ccxt.async_support.okx):
690
710
  async def watch_my_liquidations_for_symbols(self, symbols: List[str] = None, since: Int = None, limit: Int = None, params={}) -> List[Liquidation]:
691
711
  """
692
712
  watch the private liquidations of a trading pair
693
- :see: https://www.okx.com/docs-v5/en/#trading-account-websocket-balance-and-position-channel
694
- :param str symbol: unified CCXT market symbol
713
+
714
+ https://www.okx.com/docs-v5/en/#trading-account-websocket-balance-and-position-channel
715
+
716
+ :param str[] symbols:
695
717
  :param int [since]: the earliest time in ms to fetch liquidations for
696
718
  :param int [limit]: the maximum number of liquidation structures to retrieve
697
719
  :param dict [params]: exchange specific parameters for the okx api endpoint
@@ -1008,7 +1030,9 @@ class okx(ccxt.async_support.okx):
1008
1030
 
1009
1031
  async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
1010
1032
  """
1011
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1033
+
1034
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1035
+
1012
1036
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
1013
1037
  :param str symbol: unified symbol of the market to fetch the order book for
1014
1038
  :param int [limit]: the maximum amount of order book entries to return
@@ -1043,7 +1067,9 @@ class okx(ccxt.async_support.okx):
1043
1067
 
1044
1068
  async def watch_order_book_for_symbols(self, symbols: List[str], limit: Int = None, params={}) -> OrderBook:
1045
1069
  """
1046
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1070
+
1071
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1072
+
1047
1073
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
1048
1074
  :param str[] symbols: unified array of symbols
1049
1075
  :param int [limit]: 1,5, 400, 50(l2-tbt, vip4+) or 40000(vip5+) the maximum amount of order book entries to return
@@ -1089,7 +1115,9 @@ class okx(ccxt.async_support.okx):
1089
1115
 
1090
1116
  async def un_watch_order_book_for_symbols(self, symbols: List[str], params={}) -> Any:
1091
1117
  """
1092
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1118
+
1119
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1120
+
1093
1121
  unWatches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
1094
1122
  :param str[] symbols: unified array of symbols
1095
1123
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1133,7 +1161,9 @@ class okx(ccxt.async_support.okx):
1133
1161
 
1134
1162
  async def un_watch_order_book(self, symbol: str, params={}) -> Any:
1135
1163
  """
1136
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1164
+
1165
+ https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel
1166
+
1137
1167
  unWatches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
1138
1168
  :param str symbol: unified array of symbols
1139
1169
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1476,7 +1506,9 @@ class okx(ccxt.async_support.okx):
1476
1506
  async def watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
1477
1507
  """
1478
1508
  watches information on multiple trades made by the user
1479
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
1509
+
1510
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
1511
+
1480
1512
  :param str [symbol]: unified market symbol of the market trades were made in
1481
1513
  :param int [since]: the earliest time in ms to fetch trades for
1482
1514
  :param int [limit]: the maximum number of trade structures to retrieve
@@ -1519,9 +1551,13 @@ class okx(ccxt.async_support.okx):
1519
1551
 
1520
1552
  async def watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={}) -> List[Position]:
1521
1553
  """
1522
- :see: https://www.okx.com/docs-v5/en/#trading-account-websocket-positions-channel
1554
+
1555
+ https://www.okx.com/docs-v5/en/#trading-account-websocket-positions-channel
1556
+
1523
1557
  watch all open positions
1524
1558
  :param str[]|None symbols: list of unified market symbols
1559
+ @param since
1560
+ @param limit
1525
1561
  :param dict params: extra parameters specific to the exchange API endpoint
1526
1562
  :returns dict[]: a list of `position structure <https://docs.ccxt.com/en/latest/manual.html#position-structure>`
1527
1563
  """
@@ -1647,7 +1683,9 @@ class okx(ccxt.async_support.okx):
1647
1683
  async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
1648
1684
  """
1649
1685
  watches information on multiple orders made by the user
1650
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
1686
+
1687
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
1688
+
1651
1689
  :param str [symbol]: unified market symbol of the market the orders were made in
1652
1690
  :param int [since]: the earliest time in ms to fetch orders for
1653
1691
  :param int [limit]: the maximum number of order structures to retrieve
@@ -1860,7 +1898,9 @@ class okx(ccxt.async_support.okx):
1860
1898
 
1861
1899
  async def create_order_ws(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}) -> Order:
1862
1900
  """
1863
- :see: https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order
1901
+
1902
+ https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order
1903
+
1864
1904
  create a trade order
1865
1905
  :param str symbol: unified symbol of the market to create an order in
1866
1906
  :param str type: 'market' or 'limit'
@@ -1925,8 +1965,10 @@ class okx(ccxt.async_support.okx):
1925
1965
  async def edit_order_ws(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={}) -> Order:
1926
1966
  """
1927
1967
  edit a trade order
1928
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
1929
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
1968
+
1969
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
1970
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
1971
+
1930
1972
  :param str id: order id
1931
1973
  :param str symbol: unified symbol of the market to create an order in
1932
1974
  :param str type: 'market' or 'limit'
@@ -1952,7 +1994,9 @@ class okx(ccxt.async_support.okx):
1952
1994
 
1953
1995
  async def cancel_order_ws(self, id: str, symbol: Str = None, params={}) -> Order:
1954
1996
  """
1955
- :see: https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade
1997
+
1998
+ https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade
1999
+
1956
2000
  cancel multiple orders
1957
2001
  :param str id: order id
1958
2002
  :param str symbol: unified market symbol, default is None
@@ -1984,7 +2028,9 @@ class okx(ccxt.async_support.okx):
1984
2028
 
1985
2029
  async def cancel_orders_ws(self, ids: List[str], symbol: Str = None, params={}):
1986
2030
  """
1987
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
2031
+
2032
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
2033
+
1988
2034
  cancel multiple orders
1989
2035
  :param str[] ids: order ids
1990
2036
  :param str symbol: unified market symbol, default is None
@@ -2016,7 +2062,9 @@ class okx(ccxt.async_support.okx):
2016
2062
 
2017
2063
  async def cancel_all_orders_ws(self, symbol: Str = None, params={}):
2018
2064
  """
2019
- :see: https://docs.okx.com/websockets/#message-cancelAll
2065
+
2066
+ https://docs.okx.com/websockets/#message-cancelAll
2067
+
2020
2068
  cancel all open orders of a type. Only applicable to Option in Portfolio Margin mode, and MMP privilege is required.
2021
2069
  :param str symbol: unified market symbol, only orders in the market of self symbol are cancelled when symbol is not None
2022
2070
  :param dict [params]: extra parameters specific to the exchange API endpoint
ccxt/pro/onetrading.py CHANGED
@@ -83,7 +83,9 @@ class onetrading(ccxt.async_support.onetrading):
83
83
 
84
84
  async def watch_balance(self, params={}) -> Balances:
85
85
  """
86
- :see: https://developers.bitpanda.com/exchange/#account-history-channel
86
+
87
+ https://developers.bitpanda.com/exchange/#account-history-channel
88
+
87
89
  watch balance and get the amount of funds available for trading or funds locked in orders
88
90
  :param dict [params]: extra parameters specific to the exchange API endpoint
89
91
  :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
@@ -140,7 +142,9 @@ class onetrading(ccxt.async_support.onetrading):
140
142
 
141
143
  async def watch_ticker(self, symbol: str, params={}) -> Ticker:
142
144
  """
143
- :see: https://developers.bitpanda.com/exchange/#market-ticker-channel
145
+
146
+ https://developers.bitpanda.com/exchange/#market-ticker-channel
147
+
144
148
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
145
149
  :param str symbol: unified symbol of the market to fetch the ticker for
146
150
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -164,7 +168,9 @@ class onetrading(ccxt.async_support.onetrading):
164
168
 
165
169
  async def watch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
166
170
  """
167
- :see: https://developers.bitpanda.com/exchange/#market-ticker-channel
171
+
172
+ https://developers.bitpanda.com/exchange/#market-ticker-channel
173
+
168
174
  watches price tickers, a statistical calculation with the information for all markets or those specified.
169
175
  :param str symbols: unified symbols of the markets to fetch the ticker for
170
176
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -256,7 +262,9 @@ class onetrading(ccxt.async_support.onetrading):
256
262
 
257
263
  async def watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
258
264
  """
259
- :see: https://developers.bitpanda.com/exchange/#account-history-channel
265
+
266
+ https://developers.bitpanda.com/exchange/#account-history-channel
267
+
260
268
  get the list of trades associated with the user
261
269
  :param str symbol: unified symbol of the market to fetch trades for. Use 'any' to watch all trades
262
270
  :param int [since]: timestamp in ms of the earliest trade to fetch
@@ -295,7 +303,9 @@ class onetrading(ccxt.async_support.onetrading):
295
303
 
296
304
  async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
297
305
  """
298
- :see: https://developers.bitpanda.com/exchange/#market-ticker-channel
306
+
307
+ https://developers.bitpanda.com/exchange/#market-ticker-channel
308
+
299
309
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
300
310
  :param str symbol: unified symbol of the market to fetch the order book for
301
311
  :param int [limit]: the maximum amount of order book entries to return
@@ -401,7 +411,9 @@ class onetrading(ccxt.async_support.onetrading):
401
411
 
402
412
  async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
403
413
  """
404
- :see: https://developers.bitpanda.com/exchange/#account-history-channel
414
+
415
+ https://developers.bitpanda.com/exchange/#account-history-channel
416
+
405
417
  watches information on multiple orders made by the user
406
418
  :param str symbol: unified market symbol of the market orders were made in
407
419
  :param int [since]: the earliest time in ms to fetch orders for
@@ -997,7 +1009,9 @@ class onetrading(ccxt.async_support.onetrading):
997
1009
 
998
1010
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
999
1011
  """
1000
- :see: https://developers.bitpanda.com/exchange/#candlesticks-channel
1012
+
1013
+ https://developers.bitpanda.com/exchange/#candlesticks-channel
1014
+
1001
1015
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
1002
1016
  :param str symbol: unified symbol of the market to fetch OHLCV data for
1003
1017
  :param str timeframe: the length of time each candle represents
ccxt/pro/oxfun.py CHANGED
@@ -78,7 +78,9 @@ class oxfun(ccxt.async_support.oxfun):
78
78
  async def watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
79
79
  """
80
80
  watches information on multiple trades made in a market
81
- :see: https://docs.ox.fun/?json#trade
81
+
82
+ https://docs.ox.fun/?json#trade
83
+
82
84
  :param str symbol: unified market symbol of the market trades were made in
83
85
  :param int [since]: the earliest time in ms to fetch orders for
84
86
  :param int [limit]: the maximum number of trade structures to retrieve
@@ -91,8 +93,10 @@ class oxfun(ccxt.async_support.oxfun):
91
93
  async def watch_trades_for_symbols(self, symbols: List[str], since: Int = None, limit: Int = None, params={}) -> List[Trade]:
92
94
  """
93
95
  get the list of most recent trades for a particular symbol
94
- :see: https://docs.ox.fun/?json#trade
95
- :param str symbol: unified symbol of the market to fetch trades for
96
+
97
+ https://docs.ox.fun/?json#trade
98
+
99
+ :param str[] symbols:
96
100
  :param int [since]: timestamp in ms of the earliest trade to fetch
97
101
  :param int [limit]: the maximum amount of trades to fetch
98
102
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -181,7 +185,9 @@ class oxfun(ccxt.async_support.oxfun):
181
185
  async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
182
186
  """
183
187
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
184
- :see: https://docs.ox.fun/?json#candles
188
+
189
+ https://docs.ox.fun/?json#candles
190
+
185
191
  :param str symbol: unified symbol of the market to fetch OHLCV data for
186
192
  :param str timeframe: the length of time each candle represents
187
193
  :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -209,7 +215,9 @@ class oxfun(ccxt.async_support.oxfun):
209
215
  async def watch_ohlcv_for_symbols(self, symbolsAndTimeframes: List[List[str]], since: Int = None, limit: Int = None, params={}):
210
216
  """
211
217
  watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
212
- :see: https://docs.ox.fun/?json#candles
218
+
219
+ https://docs.ox.fun/?json#candles
220
+
213
221
  :param str[][] symbolsAndTimeframes: array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']]
214
222
  :param int [since]: timestamp in ms of the earliest candle to fetch
215
223
  :param int [limit]: the maximum amount of candles to fetch
@@ -310,8 +318,10 @@ class oxfun(ccxt.async_support.oxfun):
310
318
  async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
311
319
  """
312
320
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
313
- :see: https://docs.ox.fun/?json#fixed-size-order-book
314
- :see: https://docs.ox.fun/?json#full-order-book
321
+
322
+ https://docs.ox.fun/?json#fixed-size-order-book
323
+ https://docs.ox.fun/?json#full-order-book
324
+
315
325
  :param str symbol: unified symbol of the market to fetch the order book for
316
326
  :param int [limit]: the maximum amount of order book entries to return
317
327
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -322,8 +332,10 @@ class oxfun(ccxt.async_support.oxfun):
322
332
  async def watch_order_book_for_symbols(self, symbols: List[str], limit: Int = None, params={}) -> OrderBook:
323
333
  """
324
334
  watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
325
- :see: https://docs.ox.fun/?json#fixed-size-order-book
326
- :see: https://docs.ox.fun/?json#full-order-book
335
+
336
+ https://docs.ox.fun/?json#fixed-size-order-book
337
+ https://docs.ox.fun/?json#full-order-book
338
+
327
339
  :param str[] symbols: unified array of symbols
328
340
  :param int [limit]: the maximum amount of order book entries to return
329
341
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -393,7 +405,9 @@ class oxfun(ccxt.async_support.oxfun):
393
405
 
394
406
  async def watch_ticker(self, symbol: str, params={}) -> Ticker:
395
407
  """
396
- :see: https://docs.ox.fun/?json#ticker
408
+
409
+ https://docs.ox.fun/?json#ticker
410
+
397
411
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
398
412
  :param str symbol: unified symbol of the market to fetch the ticker for
399
413
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -405,7 +419,9 @@ class oxfun(ccxt.async_support.oxfun):
405
419
 
406
420
  async def watch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
407
421
  """
408
- :see: https://docs.ox.fun/?json#ticker
422
+
423
+ https://docs.ox.fun/?json#ticker
424
+
409
425
  watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
410
426
  :param str[] [symbols]: unified symbol of the market to fetch the ticker for
411
427
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -469,7 +485,9 @@ class oxfun(ccxt.async_support.oxfun):
469
485
 
470
486
  async def watch_bids_asks(self, symbols: Strings = None, params={}) -> Tickers:
471
487
  """
472
- :see: https://docs.ox.fun/?json#best-bid-ask
488
+
489
+ https://docs.ox.fun/?json#best-bid-ask
490
+
473
491
  watches best bid & ask for symbols
474
492
  :param str[] symbols: unified symbol of the market to fetch the ticker for
475
493
  :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -536,7 +554,9 @@ class oxfun(ccxt.async_support.oxfun):
536
554
 
537
555
  async def watch_balance(self, params={}) -> Balances:
538
556
  """
539
- :see: https://docs.ox.fun/?json#balance-channel
557
+
558
+ https://docs.ox.fun/?json#balance-channel
559
+
540
560
  watch balance and get the amount of funds available for trading or funds locked in orders
541
561
  :param dict [params]: extra parameters specific to the exchange API endpoint
542
562
  :param int|str [params.tag]: If given it will be echoed in the reply and the max size of tag is 32
@@ -594,9 +614,13 @@ class oxfun(ccxt.async_support.oxfun):
594
614
 
595
615
  async def watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={}) -> List[Position]:
596
616
  """
597
- :see: https://docs.ox.fun/?json#position-channel
617
+
618
+ https://docs.ox.fun/?json#position-channel
619
+
598
620
  watch all open positions
599
621
  :param str[]|None symbols: list of unified market symbols
622
+ @param since
623
+ @param limit
600
624
  :param dict params: extra parameters specific to the exchange API endpoint
601
625
  :param int|str [params.tag]: If given it will be echoed in the reply and the max size of tag is 32
602
626
  :returns dict[]: a list of `position structure <https://docs.ccxt.com/en/latest/manual.html#position-structure>`
@@ -705,7 +729,9 @@ class oxfun(ccxt.async_support.oxfun):
705
729
  async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
706
730
  """
707
731
  watches information on multiple orders made by the user
708
- :see: https://docs.ox.fun/?json#order-channel
732
+
733
+ https://docs.ox.fun/?json#order-channel
734
+
709
735
  :param str symbol: unified market symbol of the market orders were made in
710
736
  :param int [since]: the earliest time in ms to fetch orders for
711
737
  :param int [limit]: the maximum number of order structures to retrieve
@@ -777,7 +803,9 @@ class oxfun(ccxt.async_support.oxfun):
777
803
 
778
804
  async def create_order_ws(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}) -> Order:
779
805
  """
780
- :see: https://docs.ox.fun/?json#order-commands
806
+
807
+ https://docs.ox.fun/?json#order-commands
808
+
781
809
  create a trade order
782
810
  :param str symbol: unified symbol of the market to create an order in
783
811
  :param str type: 'market', 'limit', 'STOP_LIMIT' or 'STOP_MARKET'
@@ -816,16 +844,18 @@ class oxfun(ccxt.async_support.oxfun):
816
844
  async def edit_order_ws(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={}) -> Order:
817
845
  """
818
846
  edit a trade order
819
- :see: https://docs.ox.fun/?json#modify-order
847
+
848
+ https://docs.ox.fun/?json#modify-order
849
+
820
850
  :param str id: order id
821
851
  :param str symbol: unified symbol of the market to create an order in
822
852
  :param str type: 'market' or 'limit'
823
853
  :param str side: 'buy' or 'sell'
824
854
  :param float amount: how much of the currency you want to trade in units of the base currency
825
855
  :param float|None [price]: the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
856
+ :param dict [params]: extra parameters specific to the exchange API endpoint
826
857
  :param int [params.timestamp]: in milliseconds. If an order reaches the matching engine and the current timestamp exceeds timestamp + recvWindow, then the order will be rejected.
827
858
  :param int [params.recvWindow]: in milliseconds. If an order reaches the matching engine and the current timestamp exceeds timestamp + recvWindow, then the order will be rejected. If timestamp is provided without recvWindow, then a default recvWindow of 1000ms is used.
828
- :param dict [params]: extra parameters specific to the exchange API endpoint
829
859
  :returns dict: an `order structure <https://docs.ccxt.com/#/?id=order-structure>`
830
860
  """
831
861
  await self.load_markets()
@@ -889,7 +919,9 @@ class oxfun(ccxt.async_support.oxfun):
889
919
 
890
920
  async def cancel_order_ws(self, id: str, symbol: Str = None, params={}) -> Order:
891
921
  """
892
- :see: https://docs.ox.fun/?json#cancel-order
922
+
923
+ https://docs.ox.fun/?json#cancel-order
924
+
893
925
  cancels an open order
894
926
  :param str id: order id
895
927
  :param str symbol: unified market symbol, default is None
@@ -915,7 +947,9 @@ class oxfun(ccxt.async_support.oxfun):
915
947
 
916
948
  async def cancel_orders_ws(self, ids: List[str], symbol: Str = None, params={}):
917
949
  """
918
- :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
950
+
951
+ https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
952
+
919
953
  cancel multiple orders
920
954
  :param str[] ids: order ids
921
955
  :param str symbol: unified market symbol, default is None