ccxt 4.0.74 → 4.0.76

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 (299) hide show
  1. package/README.md +4 -4
  2. package/dist/ccxt.browser.js +2635 -2383
  3. package/dist/ccxt.browser.min.js +3 -3
  4. package/dist/cjs/ccxt.js +1 -1
  5. package/dist/cjs/src/ace.js +11 -11
  6. package/dist/cjs/src/alpaca.js +7 -7
  7. package/dist/cjs/src/ascendex.js +25 -25
  8. package/dist/cjs/src/base/Exchange.js +4 -4
  9. package/dist/cjs/src/bigone.js +19 -19
  10. package/dist/cjs/src/binance.js +56 -56
  11. package/dist/cjs/src/bingx.js +85 -40
  12. package/dist/cjs/src/bit2c.js +12 -12
  13. package/dist/cjs/src/bitbank.js +13 -13
  14. package/dist/cjs/src/bitbns.js +14 -14
  15. package/dist/cjs/src/bitfinex.js +21 -21
  16. package/dist/cjs/src/bitfinex2.js +29 -29
  17. package/dist/cjs/src/bitflyer.js +17 -17
  18. package/dist/cjs/src/bitforex.js +11 -11
  19. package/dist/cjs/src/bitget.js +39 -39
  20. package/dist/cjs/src/bithumb.js +11 -11
  21. package/dist/cjs/src/bitmart.js +44 -31
  22. package/dist/cjs/src/bitmex.js +24 -24
  23. package/dist/cjs/src/bitopro.js +21 -21
  24. package/dist/cjs/src/bitpanda.js +21 -21
  25. package/dist/cjs/src/bitrue.js +18 -18
  26. package/dist/cjs/src/bitso.js +21 -21
  27. package/dist/cjs/src/bitstamp.js +21 -21
  28. package/dist/cjs/src/bitstamp1.js +8 -8
  29. package/dist/cjs/src/bittrex.js +27 -27
  30. package/dist/cjs/src/bitvavo.js +19 -19
  31. package/dist/cjs/src/bkex.js +21 -21
  32. package/dist/cjs/src/bl3p.js +8 -8
  33. package/dist/cjs/src/blockchaincom.js +21 -21
  34. package/dist/cjs/src/btcalpha.js +15 -15
  35. package/dist/cjs/src/btcbox.js +10 -10
  36. package/dist/cjs/src/btcmarkets.js +17 -17
  37. package/dist/cjs/src/btctradeua.js +8 -8
  38. package/dist/cjs/src/btcturk.js +11 -11
  39. package/dist/cjs/src/bybit.js +153 -121
  40. package/dist/cjs/src/cex.js +14 -14
  41. package/dist/cjs/src/coinbase.js +23 -23
  42. package/dist/cjs/src/coinbasepro.js +24 -24
  43. package/dist/cjs/src/coincheck.js +12 -12
  44. package/dist/cjs/src/coinex.js +87 -41
  45. package/dist/cjs/src/coinfalcon.js +16 -16
  46. package/dist/cjs/src/coinmate.js +14 -14
  47. package/dist/cjs/src/coinone.js +12 -12
  48. package/dist/cjs/src/coinsph.js +27 -22
  49. package/dist/cjs/src/coinspot.js +8 -8
  50. package/dist/cjs/src/cryptocom.js +29 -29
  51. package/dist/cjs/src/currencycom.js +20 -20
  52. package/dist/cjs/src/delta.js +25 -25
  53. package/dist/cjs/src/deribit.js +30 -30
  54. package/dist/cjs/src/digifinex.js +31 -31
  55. package/dist/cjs/src/exmo.js +26 -26
  56. package/dist/cjs/src/gate.js +38 -38
  57. package/dist/cjs/src/gemini.js +17 -17
  58. package/dist/cjs/src/hitbtc.js +34 -34
  59. package/dist/cjs/src/hollaex.js +23 -23
  60. package/dist/cjs/src/huobi.js +45 -45
  61. package/dist/cjs/src/huobijp.js +20 -20
  62. package/dist/cjs/src/idex.js +19 -19
  63. package/dist/cjs/src/independentreserve.js +12 -12
  64. package/dist/cjs/src/indodax.js +14 -14
  65. package/dist/cjs/src/kraken.js +27 -27
  66. package/dist/cjs/src/krakenfutures.js +12 -12
  67. package/dist/cjs/src/kucoin.js +33 -33
  68. package/dist/cjs/src/kucoinfutures.js +24 -24
  69. package/dist/cjs/src/kuna.js +12 -12
  70. package/dist/cjs/src/latoken.js +17 -17
  71. package/dist/cjs/src/lbank.js +12 -12
  72. package/dist/cjs/src/lbank2.js +23 -23
  73. package/dist/cjs/src/luno.js +16 -16
  74. package/dist/cjs/src/lykke.js +16 -16
  75. package/dist/cjs/src/mercado.js +12 -12
  76. package/dist/cjs/src/mexc.js +44 -42
  77. package/dist/cjs/src/ndax.js +20 -20
  78. package/dist/cjs/src/novadax.js +20 -20
  79. package/dist/cjs/src/oceanex.js +16 -16
  80. package/dist/cjs/src/okcoin.js +21 -21
  81. package/dist/cjs/src/okx.js +52 -52
  82. package/dist/cjs/src/paymium.js +11 -11
  83. package/dist/cjs/src/phemex.js +26 -26
  84. package/dist/cjs/src/poloniex.js +237 -136
  85. package/dist/cjs/src/poloniexfutures.js +18 -18
  86. package/dist/cjs/src/pro/alpaca.js +5 -5
  87. package/dist/cjs/src/pro/ascendex.js +4 -4
  88. package/dist/cjs/src/pro/binance.js +16 -16
  89. package/dist/cjs/src/pro/bitfinex.js +4 -4
  90. package/dist/cjs/src/pro/bitfinex2.js +6 -6
  91. package/dist/cjs/src/pro/bitget.js +6 -6
  92. package/dist/cjs/src/pro/bitmart.js +4 -4
  93. package/dist/cjs/src/pro/bitmex.js +6 -6
  94. package/dist/cjs/src/pro/bitopro.js +4 -4
  95. package/dist/cjs/src/pro/bitpanda.js +6 -6
  96. package/dist/cjs/src/pro/bitrue.js +2 -2
  97. package/dist/cjs/src/pro/bitstamp.js +3 -3
  98. package/dist/cjs/src/pro/bittrex.js +6 -6
  99. package/dist/cjs/src/pro/bitvavo.js +5 -5
  100. package/dist/cjs/src/pro/blockchaincom.js +5 -5
  101. package/dist/cjs/src/pro/bybit.js +6 -6
  102. package/dist/cjs/src/pro/cex.js +7 -7
  103. package/dist/cjs/src/pro/coinbase.js +5 -5
  104. package/dist/cjs/src/pro/coinbasepro.js +6 -6
  105. package/dist/cjs/src/pro/coinex.js +5 -5
  106. package/dist/cjs/src/pro/cryptocom.js +10 -10
  107. package/dist/cjs/src/pro/currencycom.js +4 -4
  108. package/dist/cjs/src/pro/deribit.js +6 -6
  109. package/dist/cjs/src/pro/exmo.js +5 -5
  110. package/dist/cjs/src/pro/gate.js +7 -7
  111. package/dist/cjs/src/pro/gemini.js +3 -3
  112. package/dist/cjs/src/pro/hitbtc.js +3 -3
  113. package/dist/cjs/src/pro/hollaex.js +5 -5
  114. package/dist/cjs/src/pro/huobi.js +6 -6
  115. package/dist/cjs/src/pro/huobijp.js +3 -3
  116. package/dist/cjs/src/pro/idex.js +4 -4
  117. package/dist/cjs/src/pro/independentreserve.js +2 -2
  118. package/dist/cjs/src/pro/kraken.js +12 -12
  119. package/dist/cjs/src/pro/krakenfutures.js +7 -7
  120. package/dist/cjs/src/pro/kucoin.js +6 -6
  121. package/dist/cjs/src/pro/kucoinfutures.js +6 -5
  122. package/dist/cjs/src/pro/luno.js +2 -2
  123. package/dist/cjs/src/pro/mexc.js +6 -6
  124. package/dist/cjs/src/pro/ndax.js +3 -3
  125. package/dist/cjs/src/pro/okcoin.js +5 -5
  126. package/dist/cjs/src/pro/okx.js +19 -18
  127. package/dist/cjs/src/pro/phemex.js +6 -6
  128. package/dist/cjs/src/pro/poloniex.js +7 -7
  129. package/dist/cjs/src/pro/poloniexfutures.js +5 -5
  130. package/dist/cjs/src/pro/probit.js +6 -6
  131. package/dist/cjs/src/pro/upbit.js +3 -3
  132. package/dist/cjs/src/pro/wazirx.js +6 -6
  133. package/dist/cjs/src/pro/whitebit.js +6 -6
  134. package/dist/cjs/src/probit.js +19 -19
  135. package/dist/cjs/src/tidex.js +13 -13
  136. package/dist/cjs/src/timex.js +16 -16
  137. package/dist/cjs/src/tokocrypto.js +18 -18
  138. package/dist/cjs/src/upbit.js +20 -20
  139. package/dist/cjs/src/wavesexchange.js +16 -16
  140. package/dist/cjs/src/wazirx.js +12 -12
  141. package/dist/cjs/src/whitebit.js +24 -24
  142. package/dist/cjs/src/woo.js +30 -24
  143. package/dist/cjs/src/yobit.js +16 -16
  144. package/dist/cjs/src/zaif.js +10 -10
  145. package/dist/cjs/src/zonda.js +15 -15
  146. package/js/ccxt.d.ts +1 -1
  147. package/js/ccxt.js +1 -1
  148. package/js/src/abstract/bingx.d.ts +2 -0
  149. package/js/src/abstract/bitmart.d.ts +13 -0
  150. package/js/src/abstract/bybit.d.ts +33 -21
  151. package/js/src/abstract/coinsph.d.ts +5 -0
  152. package/js/src/abstract/woo.d.ts +6 -0
  153. package/js/src/ace.js +11 -11
  154. package/js/src/alpaca.js +7 -7
  155. package/js/src/ascendex.js +25 -25
  156. package/js/src/base/Exchange.js +4 -4
  157. package/js/src/bigone.js +19 -19
  158. package/js/src/binance.js +56 -56
  159. package/js/src/bingx.d.ts +1 -0
  160. package/js/src/bingx.js +85 -40
  161. package/js/src/bit2c.js +12 -12
  162. package/js/src/bitbank.js +13 -13
  163. package/js/src/bitbns.js +14 -14
  164. package/js/src/bitfinex.js +21 -21
  165. package/js/src/bitfinex2.js +29 -29
  166. package/js/src/bitflyer.js +17 -17
  167. package/js/src/bitforex.js +11 -11
  168. package/js/src/bitget.js +39 -39
  169. package/js/src/bithumb.js +11 -11
  170. package/js/src/bitmart.js +44 -31
  171. package/js/src/bitmex.js +24 -24
  172. package/js/src/bitopro.js +21 -21
  173. package/js/src/bitpanda.js +21 -21
  174. package/js/src/bitrue.js +18 -18
  175. package/js/src/bitso.js +21 -21
  176. package/js/src/bitstamp.js +21 -21
  177. package/js/src/bitstamp1.js +8 -8
  178. package/js/src/bittrex.js +27 -27
  179. package/js/src/bitvavo.js +19 -19
  180. package/js/src/bkex.js +21 -21
  181. package/js/src/bl3p.js +8 -8
  182. package/js/src/blockchaincom.js +21 -21
  183. package/js/src/btcalpha.js +15 -15
  184. package/js/src/btcbox.js +10 -10
  185. package/js/src/btcmarkets.js +17 -17
  186. package/js/src/btctradeua.js +8 -8
  187. package/js/src/btcturk.js +11 -11
  188. package/js/src/bybit.js +153 -121
  189. package/js/src/cex.js +14 -14
  190. package/js/src/coinbase.js +23 -23
  191. package/js/src/coinbasepro.js +24 -24
  192. package/js/src/coincheck.js +12 -12
  193. package/js/src/coinex.d.ts +1 -0
  194. package/js/src/coinex.js +87 -41
  195. package/js/src/coinfalcon.js +16 -16
  196. package/js/src/coinmate.js +14 -14
  197. package/js/src/coinone.js +12 -12
  198. package/js/src/coinsph.js +27 -22
  199. package/js/src/coinspot.js +8 -8
  200. package/js/src/cryptocom.js +29 -29
  201. package/js/src/currencycom.js +20 -20
  202. package/js/src/delta.js +25 -25
  203. package/js/src/deribit.js +30 -30
  204. package/js/src/digifinex.js +31 -31
  205. package/js/src/exmo.js +26 -26
  206. package/js/src/gate.js +38 -38
  207. package/js/src/gemini.js +17 -17
  208. package/js/src/hitbtc.js +34 -34
  209. package/js/src/hollaex.js +23 -23
  210. package/js/src/huobi.js +45 -45
  211. package/js/src/huobijp.js +20 -20
  212. package/js/src/idex.js +19 -19
  213. package/js/src/independentreserve.js +12 -12
  214. package/js/src/indodax.js +14 -14
  215. package/js/src/kraken.js +27 -27
  216. package/js/src/krakenfutures.js +12 -12
  217. package/js/src/kucoin.js +33 -33
  218. package/js/src/kucoinfutures.js +24 -24
  219. package/js/src/kuna.js +12 -12
  220. package/js/src/latoken.js +17 -17
  221. package/js/src/lbank.js +12 -12
  222. package/js/src/lbank2.js +23 -23
  223. package/js/src/luno.js +16 -16
  224. package/js/src/lykke.js +16 -16
  225. package/js/src/mercado.js +12 -12
  226. package/js/src/mexc.js +45 -43
  227. package/js/src/ndax.js +20 -20
  228. package/js/src/novadax.js +20 -20
  229. package/js/src/oceanex.js +16 -16
  230. package/js/src/okcoin.js +21 -21
  231. package/js/src/okx.js +52 -52
  232. package/js/src/paymium.js +11 -11
  233. package/js/src/phemex.js +26 -26
  234. package/js/src/poloniex.d.ts +1 -1
  235. package/js/src/poloniex.js +237 -136
  236. package/js/src/poloniexfutures.js +18 -18
  237. package/js/src/pro/alpaca.js +5 -5
  238. package/js/src/pro/ascendex.js +4 -4
  239. package/js/src/pro/binance.js +16 -16
  240. package/js/src/pro/bitfinex.js +4 -4
  241. package/js/src/pro/bitfinex2.js +6 -6
  242. package/js/src/pro/bitget.js +6 -6
  243. package/js/src/pro/bitmart.js +4 -4
  244. package/js/src/pro/bitmex.js +6 -6
  245. package/js/src/pro/bitopro.js +4 -4
  246. package/js/src/pro/bitpanda.js +6 -6
  247. package/js/src/pro/bitrue.js +2 -2
  248. package/js/src/pro/bitstamp.js +3 -3
  249. package/js/src/pro/bittrex.js +6 -6
  250. package/js/src/pro/bitvavo.js +5 -5
  251. package/js/src/pro/blockchaincom.js +5 -5
  252. package/js/src/pro/bybit.js +6 -6
  253. package/js/src/pro/cex.js +7 -7
  254. package/js/src/pro/coinbase.js +5 -5
  255. package/js/src/pro/coinbasepro.js +6 -6
  256. package/js/src/pro/coinex.js +5 -5
  257. package/js/src/pro/cryptocom.js +10 -10
  258. package/js/src/pro/currencycom.js +4 -4
  259. package/js/src/pro/deribit.js +6 -6
  260. package/js/src/pro/exmo.js +5 -5
  261. package/js/src/pro/gate.js +7 -7
  262. package/js/src/pro/gemini.js +3 -3
  263. package/js/src/pro/hitbtc.js +3 -3
  264. package/js/src/pro/hollaex.js +5 -5
  265. package/js/src/pro/huobi.js +6 -6
  266. package/js/src/pro/huobijp.js +3 -3
  267. package/js/src/pro/idex.js +4 -4
  268. package/js/src/pro/independentreserve.js +2 -2
  269. package/js/src/pro/kraken.js +12 -12
  270. package/js/src/pro/krakenfutures.js +7 -7
  271. package/js/src/pro/kucoin.js +6 -6
  272. package/js/src/pro/kucoinfutures.js +6 -5
  273. package/js/src/pro/luno.js +2 -2
  274. package/js/src/pro/mexc.js +6 -6
  275. package/js/src/pro/ndax.js +3 -3
  276. package/js/src/pro/okcoin.js +5 -5
  277. package/js/src/pro/okx.d.ts +1 -1
  278. package/js/src/pro/okx.js +19 -18
  279. package/js/src/pro/phemex.js +6 -6
  280. package/js/src/pro/poloniex.js +7 -7
  281. package/js/src/pro/poloniexfutures.js +5 -5
  282. package/js/src/pro/probit.js +6 -6
  283. package/js/src/pro/upbit.js +3 -3
  284. package/js/src/pro/wazirx.js +6 -6
  285. package/js/src/pro/whitebit.js +6 -6
  286. package/js/src/probit.js +19 -19
  287. package/js/src/tidex.js +13 -13
  288. package/js/src/timex.js +16 -16
  289. package/js/src/tokocrypto.js +18 -18
  290. package/js/src/upbit.js +20 -20
  291. package/js/src/wavesexchange.js +16 -16
  292. package/js/src/wazirx.js +12 -12
  293. package/js/src/whitebit.js +24 -24
  294. package/js/src/woo.js +30 -24
  295. package/js/src/yobit.js +16 -16
  296. package/js/src/zaif.js +10 -10
  297. package/js/src/zonda.js +15 -15
  298. package/package.json +1 -1
  299. package/skip-tests.json +2 -0
@@ -413,7 +413,7 @@ export default class krakenfutures extends Exchange {
413
413
  * @param {string} symbol Unified market symbol
414
414
  * @param {int} [limit] Not used by krakenfutures
415
415
  * @param {object} [params] exchange specific params
416
- * @returns An [order book structure]{@link https://docs.ccxt.com/#/?id=order-book-structure}
416
+ * @returns An [order book structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure}
417
417
  */
418
418
  await this.loadMarkets();
419
419
  const market = this.market(symbol);
@@ -642,7 +642,7 @@ export default class krakenfutures extends Exchange {
642
642
  * @param {int} [limit] Total number of trades, cannot exceed 100
643
643
  * @param {object} [params] Exchange specific params
644
644
  * @param {int} [params.until] Timestamp in ms of latest trade
645
- * @returns An array of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
645
+ * @returns An array of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#trade-structure}
646
646
  */
647
647
  await this.loadMarkets();
648
648
  const market = this.market(symbol);
@@ -810,7 +810,7 @@ export default class krakenfutures extends Exchange {
810
810
  * @param {string} type One of 'limit', 'market', 'take_profit'
811
811
  * @param {string} side buy or sell
812
812
  * @param {int} amount Contract quantity
813
- * @param {float} price Limit order price
813
+ * @param {float} [price] Limit order price
814
814
  * @param {float} [params.stopPrice] The stop price associated with a stop or take profit order, Required if orderType is stp or take_profit, Must not have more than 2 decimal places, Note that for stop orders, limitPrice denotes the worst price at which the stop or take_profit order can get filled at. If no limitPrice is provided the stop or take_profit order will trigger a market order,
815
815
  * @param {bool} [params.reduceOnly] Set as true if you wish the order to only reduce an existing position, Any order which increases an existing position will be rejected, Default false,
816
816
  * @param {bool} [params.postOnly] Set as true if you wish to make a postOnly order, Default false
@@ -902,9 +902,9 @@ export default class krakenfutures extends Exchange {
902
902
  * @param {string} type Not used by Krakenfutures
903
903
  * @param {string} side Not used by Krakenfutures
904
904
  * @param {float} amount Order size
905
- * @param {float} price Price to fill order at
905
+ * @param {float} [price] Price to fill order at
906
906
  * @param {object} [params] Exchange specific params
907
- * @returns An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
907
+ * @returns An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
908
908
  */
909
909
  await this.loadMarkets();
910
910
  const request = {
@@ -927,7 +927,7 @@ export default class krakenfutures extends Exchange {
927
927
  * @param {string} id Order id
928
928
  * @param {string} symbol Not used by Krakenfutures
929
929
  * @param {object} [params] Exchange specific params
930
- * @returns An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
930
+ * @returns An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
931
931
  */
932
932
  await this.loadMarkets();
933
933
  const response = await this.privatePostCancelorder(this.extend({ 'order_id': id }, params));
@@ -964,7 +964,7 @@ export default class krakenfutures extends Exchange {
964
964
  * @param {int} [since] Timestamp (ms) of earliest order. (Not used by kraken api but filtered internally by CCXT)
965
965
  * @param {int} [limit] How many orders to return. (Not used by kraken api but filtered internally by CCXT)
966
966
  * @param {object} [params] Exchange specific parameters
967
- * @returns An array of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
967
+ * @returns An array of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
968
968
  */
969
969
  await this.loadMarkets();
970
970
  let market = undefined;
@@ -1389,7 +1389,7 @@ export default class krakenfutures extends Exchange {
1389
1389
  * @param {object} [params] Exchange specific parameters
1390
1390
  * @param {string} [params.type] The sub-account type to query the balance of, possible values include 'flex', 'cash'/'main'/'funding', or a market symbol * defaults to 'cash' *
1391
1391
  * @param {string} [params.symbol] A unified market symbol, when assigned the balance for a trading market that matches the symbol is returned
1392
- * @returns A [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
1392
+ * @returns A [balance structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#balance-structure}
1393
1393
  */
1394
1394
  await this.loadMarkets();
1395
1395
  let type = this.safeString2(params, 'type', 'account');
@@ -1612,7 +1612,7 @@ export default class krakenfutures extends Exchange {
1612
1612
  * @description fetch the current funding rates
1613
1613
  * @param {string[]} symbols unified market symbols
1614
1614
  * @param {object} [params] extra parameters specific to the krakenfutures api endpoint
1615
- * @returns {Order[]} an array of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
1615
+ * @returns {Order[]} an array of [funding rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure}
1616
1616
  */
1617
1617
  await this.loadMarkets();
1618
1618
  const marketIds = this.marketIds(symbols);
@@ -1995,7 +1995,7 @@ export default class krakenfutures extends Exchange {
1995
1995
  * @param {str} code Unified currency code
1996
1996
  * @param {float} amount Size of the transfer
1997
1997
  * @param {dict} [params] Exchange specific parameters
1998
- * @returns a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
1998
+ * @returns a [transfer structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure}
1999
1999
  */
2000
2000
  return await this.transfer(code, amount, 'future', 'spot', params);
2001
2001
  }
@@ -2009,7 +2009,7 @@ export default class krakenfutures extends Exchange {
2009
2009
  * @param {string} fromAccount 'main'/'funding'/'future', 'flex', or a unified market symbol
2010
2010
  * @param {string} toAccount 'main'/'funding', 'flex', 'spot' or a unified market symbol
2011
2011
  * @param {object} [params] Exchange specific parameters
2012
- * @returns a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
2012
+ * @returns a [transfer structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure}
2013
2013
  */
2014
2014
  await this.loadMarkets();
2015
2015
  const currency = this.currency(code);
@@ -2076,7 +2076,7 @@ export default class krakenfutures extends Exchange {
2076
2076
  * @see https://docs.futures.kraken.com/#http-api-trading-v3-api-multi-collateral-get-the-leverage-setting-for-a-market
2077
2077
  * @param {string} symbol unified market symbol
2078
2078
  * @param {object} [params] extra parameters specific to the krakenfutures api endpoint
2079
- * @returns {object} a [leverage structure]{@link https://docs.ccxt.com/#/?id=leverage-structure}
2079
+ * @returns {object} a [leverage structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#leverage-structure}
2080
2080
  */
2081
2081
  this.checkRequiredSymbol('fetchLeverage', symbol);
2082
2082
  await this.loadMarkets();
package/js/src/kucoin.js CHANGED
@@ -829,7 +829,7 @@ export default class kucoin extends Exchange {
829
829
  * @name kucoin#fetchStatus
830
830
  * @description the latest known information on the availability of the exchange API
831
831
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
832
- * @returns {object} a [status structure]{@link https://docs.ccxt.com/#/?id=exchange-status-structure}
832
+ * @returns {object} a [status structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#exchange-status-structure}
833
833
  */
834
834
  const response = await this.publicGetStatus(params);
835
835
  //
@@ -1119,7 +1119,7 @@ export default class kucoin extends Exchange {
1119
1119
  * @name kucoin#fetchAccounts
1120
1120
  * @description fetch all the accounts associated with a profile
1121
1121
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1122
- * @returns {object} a dictionary of [account structures]{@link https://docs.ccxt.com/#/?id=account-structure} indexed by the account type
1122
+ * @returns {object} a dictionary of [account structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#account-structure} indexed by the account type
1123
1123
  */
1124
1124
  const response = await this.privateGetAccounts(params);
1125
1125
  //
@@ -1170,7 +1170,7 @@ export default class kucoin extends Exchange {
1170
1170
  * @see https://docs.kucoin.com/#get-withdrawal-quotas
1171
1171
  * @param {string} code unified currency code
1172
1172
  * @param {object} params extra parameters specific to the kucoin api endpoint
1173
- * @returns {object} a [fee structure]{@link https://docs.ccxt.com/en/latest/manual.html#fee-structure}
1173
+ * @returns {object} a [fee structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#fee-structure}
1174
1174
  */
1175
1175
  await this.loadMarkets();
1176
1176
  const currency = this.currency(code);
@@ -1201,7 +1201,7 @@ export default class kucoin extends Exchange {
1201
1201
  * @param {string} code unified currency code
1202
1202
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1203
1203
  * @param {string} [params.network] The chain of currency. This only apply for multi-chain currency, and there is no need for single chain currency; you can query the chain through the response of the GET /api/v2/currencies/{currency} interface
1204
- * @returns {object} a [fee structure]{@link https://docs.ccxt.com/#/?id=fee-structure}
1204
+ * @returns {object} a [fee structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#fee-structure}
1205
1205
  */
1206
1206
  await this.loadMarkets();
1207
1207
  const currency = this.currency(code);
@@ -1397,7 +1397,7 @@ export default class kucoin extends Exchange {
1397
1397
  * @description fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
1398
1398
  * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
1399
1399
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1400
- * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1400
+ * @returns {object} a dictionary of [ticker structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure}
1401
1401
  */
1402
1402
  await this.loadMarkets();
1403
1403
  symbols = this.marketSymbols(symbols);
@@ -1451,7 +1451,7 @@ export default class kucoin extends Exchange {
1451
1451
  * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
1452
1452
  * @param {string} symbol unified symbol of the market to fetch the ticker for
1453
1453
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1454
- * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1454
+ * @returns {object} a [ticker structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure}
1455
1455
  */
1456
1456
  await this.loadMarkets();
1457
1457
  const market = this.market(symbol);
@@ -1565,7 +1565,7 @@ export default class kucoin extends Exchange {
1565
1565
  * @param {string} code unified currency code of the currency for the deposit address
1566
1566
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1567
1567
  * @param {string} [params.network] the blockchain network name
1568
- * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
1568
+ * @returns {object} an [address structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#address-structure}
1569
1569
  */
1570
1570
  await this.loadMarkets();
1571
1571
  const currency = this.currency(code);
@@ -1592,7 +1592,7 @@ export default class kucoin extends Exchange {
1592
1592
  * @param {string} code unified currency code
1593
1593
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1594
1594
  * @param {string} [params.network] the blockchain network name
1595
- * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
1595
+ * @returns {object} an [address structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#address-structure}
1596
1596
  */
1597
1597
  await this.loadMarkets();
1598
1598
  const currency = this.currency(code);
@@ -1649,7 +1649,7 @@ export default class kucoin extends Exchange {
1649
1649
  * @description fetch the deposit address for a currency associated with this account
1650
1650
  * @param {string} code unified currency code
1651
1651
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1652
- * @returns {object} an array of [address structures]{@link https://docs.ccxt.com/#/?id=address-structure}
1652
+ * @returns {object} an array of [address structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#address-structure}
1653
1653
  */
1654
1654
  await this.loadMarkets();
1655
1655
  const currency = this.currency(code);
@@ -1689,7 +1689,7 @@ export default class kucoin extends Exchange {
1689
1689
  * @param {string} symbol unified symbol of the market to fetch the order book for
1690
1690
  * @param {int} [limit] the maximum amount of order book entries to return
1691
1691
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
1692
- * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
1692
+ * @returns {object} A dictionary of [order book structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure} indexed by market symbols
1693
1693
  */
1694
1694
  await this.loadMarkets();
1695
1695
  const market = this.market(symbol);
@@ -1777,7 +1777,7 @@ export default class kucoin extends Exchange {
1777
1777
  * @param {string} type 'limit' or 'market'
1778
1778
  * @param {string} side 'buy' or 'sell'
1779
1779
  * @param {float} amount the amount of currency to trade
1780
- * @param {float} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency
1780
+ * @param {float} [price] *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency
1781
1781
  * @param {object} [params] Extra parameters specific to the exchange API endpoint
1782
1782
  * @param {float} [params.triggerPrice] The price at which a trigger order is triggered at
1783
1783
  * @param {string} [params.marginMode] 'cross', // cross (cross mode) and isolated (isolated mode), set to cross by default, the isolated mode will be released soon, stay tuned
@@ -1802,7 +1802,7 @@ export default class kucoin extends Exchange {
1802
1802
  * @param {string} [params.stp] '', // self trade prevention, CN, CO, CB or DC
1803
1803
  * @param {bool} [params.autoBorrow] false, // The system will first borrow you funds at the optimal interest rate and then place an order for you
1804
1804
  * @param {bool} [params.hf] false, // true for hf order
1805
- * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
1805
+ * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1806
1806
  */
1807
1807
  await this.loadMarkets();
1808
1808
  const market = this.market(symbol);
@@ -1901,10 +1901,10 @@ export default class kucoin extends Exchange {
1901
1901
  * @param {string} type not used
1902
1902
  * @param {string} side not used
1903
1903
  * @param {float} amount how much of the currency you want to trade in units of the base currency
1904
- * @param {float} price the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders
1904
+ * @param {float} [price] the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders
1905
1905
  * @param {object} [params] extra parameters specific to the gate api endpoint
1906
1906
  * @param {string} [params.clientOrderId] client order id, defaults to id if not passed
1907
- * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
1907
+ * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1908
1908
  */
1909
1909
  await this.loadMarkets();
1910
1910
  const market = this.market(symbol);
@@ -2058,7 +2058,7 @@ export default class kucoin extends Exchange {
2058
2058
  * @param {string} [params.orderIds] *stop orders only* comma seperated order ID list
2059
2059
  * @param {bool} [params.stop] True if fetching a stop order
2060
2060
  * @param {bool} [params.hf] false, // true for hf order
2061
- * @returns An [array of order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
2061
+ * @returns An [array of order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
2062
2062
  */
2063
2063
  await this.loadMarkets();
2064
2064
  let lowercaseStatus = status.toLowerCase();
@@ -2166,7 +2166,7 @@ export default class kucoin extends Exchange {
2166
2166
  * @param {string} [params.tradeType] TRADE for spot trading, MARGIN_TRADE for Margin Trading
2167
2167
  * @param {bool} [params.stop] True if fetching a stop order
2168
2168
  * @param {bool} [params.hf] false, // true for hf order
2169
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
2169
+ * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
2170
2170
  */
2171
2171
  return await this.fetchOrdersByStatus('done', symbol, since, limit, params);
2172
2172
  }
@@ -2188,7 +2188,7 @@ export default class kucoin extends Exchange {
2188
2188
  * @param {string} [params.orderIds] *stop orders only* comma seperated order ID list
2189
2189
  * @param {bool} [params.stop] True if fetching a stop order
2190
2190
  * @param {bool} [params.hf] false, // true for hf order
2191
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
2191
+ * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
2192
2192
  */
2193
2193
  return await this.fetchOrdersByStatus('active', symbol, since, limit, params);
2194
2194
  }
@@ -2209,7 +2209,7 @@ export default class kucoin extends Exchange {
2209
2209
  * @param {bool} [params.stop] true if fetching a stop order
2210
2210
  * @param {bool} [params.hf] false, // true for hf order
2211
2211
  * @param {bool} [params.clientOid] unique order id created by users to identify their orders
2212
- * @returns An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2212
+ * @returns An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
2213
2213
  */
2214
2214
  await this.loadMarkets();
2215
2215
  const request = {};
@@ -2456,7 +2456,7 @@ export default class kucoin extends Exchange {
2456
2456
  * @param {int} [since] the earliest time in ms to fetch trades for
2457
2457
  * @param {int} [limit] the maximum number of trades to retrieve
2458
2458
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2459
- * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
2459
+ * @returns {object[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#trade-structure}
2460
2460
  */
2461
2461
  const request = {
2462
2462
  'orderId': id,
@@ -2475,7 +2475,7 @@ export default class kucoin extends Exchange {
2475
2475
  * @param {int} [limit] the maximum number of trades structures to retrieve
2476
2476
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2477
2477
  * @param {bool} [params.hf] false, // true for hf order
2478
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
2478
+ * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#trade-structure}
2479
2479
  */
2480
2480
  await this.loadMarkets();
2481
2481
  const request = {};
@@ -2580,7 +2580,7 @@ export default class kucoin extends Exchange {
2580
2580
  * @param {int} [since] timestamp in ms of the earliest trade to fetch
2581
2581
  * @param {int} [limit] the maximum amount of trades to fetch
2582
2582
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2583
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades}
2583
+ * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#public-trades}
2584
2584
  */
2585
2585
  await this.loadMarkets();
2586
2586
  const market = this.market(symbol);
@@ -2750,7 +2750,7 @@ export default class kucoin extends Exchange {
2750
2750
  * @description fetch the trading fees for a market
2751
2751
  * @param {string} symbol unified market symbol
2752
2752
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2753
- * @returns {object} a [fee structure]{@link https://docs.ccxt.com/#/?id=fee-structure}
2753
+ * @returns {object} a [fee structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#fee-structure}
2754
2754
  */
2755
2755
  await this.loadMarkets();
2756
2756
  const market = this.market(symbol);
@@ -2792,7 +2792,7 @@ export default class kucoin extends Exchange {
2792
2792
  * @param {string} address the address to withdraw to
2793
2793
  * @param {string} tag
2794
2794
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2795
- * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
2795
+ * @returns {object} a [transaction structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
2796
2796
  */
2797
2797
  [tag, params] = this.handleWithdrawTagAndParams(tag, params);
2798
2798
  await this.loadMarkets();
@@ -2963,7 +2963,7 @@ export default class kucoin extends Exchange {
2963
2963
  * @param {int} [since] the earliest time in ms to fetch deposits for
2964
2964
  * @param {int} [limit] the maximum number of deposits structures to retrieve
2965
2965
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
2966
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
2966
+ * @returns {object[]} a list of [transaction structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
2967
2967
  */
2968
2968
  await this.loadMarkets();
2969
2969
  const request = {};
@@ -3037,7 +3037,7 @@ export default class kucoin extends Exchange {
3037
3037
  * @param {int} [since] the earliest time in ms to fetch withdrawals for
3038
3038
  * @param {int} [limit] the maximum number of withdrawals structures to retrieve
3039
3039
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3040
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
3040
+ * @returns {object[]} a list of [transaction structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
3041
3041
  */
3042
3042
  await this.loadMarkets();
3043
3043
  const request = {};
@@ -3123,7 +3123,7 @@ export default class kucoin extends Exchange {
3123
3123
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3124
3124
  * @param {object} [params.marginMode] 'cross' or 'isolated', margin type for fetching margin balance
3125
3125
  * @param {object} [params.type] extra parameters specific to the kucoin api endpoint
3126
- * @returns {object} a [balance structure]{@link https://docs.ccxt.com/en/latest/manual.html?#balance-structure}
3126
+ * @returns {object} a [balance structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#balance-structure}
3127
3127
  */
3128
3128
  await this.loadMarkets();
3129
3129
  const code = this.safeString(params, 'code');
@@ -3271,7 +3271,7 @@ export default class kucoin extends Exchange {
3271
3271
  * @param {string} fromAccount account to transfer from
3272
3272
  * @param {string} toAccount account to transfer to
3273
3273
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3274
- * @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
3274
+ * @returns {object} a [transfer structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure}
3275
3275
  */
3276
3276
  await this.loadMarkets();
3277
3277
  const currency = this.currency(code);
@@ -3551,7 +3551,7 @@ export default class kucoin extends Exchange {
3551
3551
  * @param {int} [since] timestamp in ms of the earliest ledger entry, default is undefined
3552
3552
  * @param {int} [limit] max number of ledger entrys to return, default is undefined
3553
3553
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3554
- * @returns {object} a [ledger structure]{@link https://docs.ccxt.com/#/?id=ledger-structure}
3554
+ * @returns {object} a [ledger structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#ledger-structure}
3555
3555
  */
3556
3556
  await this.loadMarkets();
3557
3557
  await this.loadAccounts();
@@ -3640,7 +3640,7 @@ export default class kucoin extends Exchange {
3640
3640
  * @param {int} [since] timestamp for the earliest borrow rate
3641
3641
  * @param {int} [limit] the maximum number of [borrow rate structures]
3642
3642
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3643
- * @returns {object[]} an array of [borrow rate structures]{@link https://docs.ccxt.com/#/?id=borrow-rate-structure}
3643
+ * @returns {object[]} an array of [borrow rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#borrow-rate-structure}
3644
3644
  */
3645
3645
  await this.loadMarkets();
3646
3646
  const currency = this.currency(code);
@@ -3712,7 +3712,7 @@ export default class kucoin extends Exchange {
3712
3712
  * @param {int} [limit] the maximum number of structures to retrieve
3713
3713
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
3714
3714
  * @param {string} [params.marginMode] 'cross' or 'isolated' default is 'cross'
3715
- * @returns {object[]} a list of [borrow interest structures]{@link https://docs.ccxt.com/#/?id=borrow-interest-structure}
3715
+ * @returns {object[]} a list of [borrow interest structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#borrow-interest-structure}
3716
3716
  */
3717
3717
  await this.loadMarkets();
3718
3718
  let marginMode = undefined;
@@ -3888,7 +3888,7 @@ export default class kucoin extends Exchange {
3888
3888
  * @param {object} [params] extra parameters specific to the kucoin api endpoints
3889
3889
  * @param {string} [params.timeInForce] either IOC or FOK
3890
3890
  * @param {string} [params.marginMode] 'cross' or 'isolated' default is 'cross'
3891
- * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/#/?id=margin-loan-structure}
3891
+ * @returns {object} a [margin loan structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#margin-loan-structure}
3892
3892
  */
3893
3893
  const marginMode = this.safeString(params, 'marginMode'); // cross or isolated
3894
3894
  const isIsolated = marginMode === 'isolated';
@@ -3938,7 +3938,7 @@ export default class kucoin extends Exchange {
3938
3938
  * @param {string} symbol unified market symbol
3939
3939
  * @param {object} [params] extra parameters specific to the kucoin api endpoints
3940
3940
  * @param {string} [params.marginMode] 'cross' or 'isolated' default is 'cross'
3941
- * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/#/?id=margin-loan-structure}
3941
+ * @returns {object} a [margin loan structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#margin-loan-structure}
3942
3942
  */
3943
3943
  const marginMode = this.safeString(params, 'marginMode'); // cross or isolated
3944
3944
  const isIsolated = marginMode === 'isolated';
@@ -4001,7 +4001,7 @@ export default class kucoin extends Exchange {
4001
4001
  * @see https://docs.kucoin.com/#get-currencies
4002
4002
  * @param {string[]|undefined} codes list of unified currency codes
4003
4003
  * @param {object} [params] extra parameters specific to the kucoin api endpoint
4004
- * @returns {object} a list of [fee structures]{@link https://docs.ccxt.com/en/latest/manual.html#fee-structure}
4004
+ * @returns {object} a list of [fee structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#fee-structure}
4005
4005
  */
4006
4006
  await this.loadMarkets();
4007
4007
  const response = await this.publicGetCurrencies(params);
@@ -328,7 +328,7 @@ export default class kucoinfutures extends kucoin {
328
328
  * @name kucoinfutures#fetchStatus
329
329
  * @description the latest known information on the availability of the exchange API
330
330
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
331
- * @returns {object} a [status structure]{@link https://docs.ccxt.com/#/?id=exchange-status-structure}
331
+ * @returns {object} a [status structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#exchange-status-structure}
332
332
  */
333
333
  const response = await this.futuresPublicGetStatus(params);
334
334
  //
@@ -611,7 +611,7 @@ export default class kucoinfutures extends kucoin {
611
611
  * @description fetch the deposit address for a currency associated with this account
612
612
  * @param {string} code unified currency code
613
613
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
614
- * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
614
+ * @returns {object} an [address structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#address-structure}
615
615
  */
616
616
  await this.loadMarkets();
617
617
  const currency = this.currency(code);
@@ -651,7 +651,7 @@ export default class kucoinfutures extends kucoin {
651
651
  * @param {string} symbol unified symbol of the market to fetch the order book for
652
652
  * @param {int} [limit] the maximum amount of order book entries to return
653
653
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
654
- * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
654
+ * @returns {object} A dictionary of [order book structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure} indexed by market symbols
655
655
  */
656
656
  await this.loadMarkets();
657
657
  const level = this.safeNumber(params, 'level');
@@ -708,7 +708,7 @@ export default class kucoinfutures extends kucoin {
708
708
  * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
709
709
  * @param {string} symbol unified symbol of the market to fetch the ticker for
710
710
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
711
- * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
711
+ * @returns {object} a [ticker structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure}
712
712
  */
713
713
  await this.loadMarkets();
714
714
  const market = this.market(symbol);
@@ -794,7 +794,7 @@ export default class kucoinfutures extends kucoin {
794
794
  * @param {int} [since] the earliest time in ms to fetch funding history for
795
795
  * @param {int} [limit] the maximum number of funding history structures to retrieve
796
796
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
797
- * @returns {object} a [funding history structure]{@link https://docs.ccxt.com/#/?id=funding-history-structure}
797
+ * @returns {object} a [funding history structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-history-structure}
798
798
  */
799
799
  //
800
800
  if (symbol === undefined) {
@@ -865,7 +865,7 @@ export default class kucoinfutures extends kucoin {
865
865
  * @description fetch data on an open position
866
866
  * @param {string} symbol unified market symbol of the market the position is held in
867
867
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
868
- * @returns {object} a [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure}
868
+ * @returns {object} a [position structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#position-structure}
869
869
  */
870
870
  await this.loadMarkets();
871
871
  const market = this.market(symbol);
@@ -933,7 +933,7 @@ export default class kucoinfutures extends kucoin {
933
933
  * @see https://docs.kucoin.com/futures/#get-position-list
934
934
  * @param {string[]|undefined} symbols list of unified market symbols
935
935
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
936
- * @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
936
+ * @returns {object[]} a list of [position structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#position-structure}
937
937
  */
938
938
  await this.loadMarkets();
939
939
  const response = await this.futuresPrivateGetPositions(params);
@@ -1092,7 +1092,7 @@ export default class kucoinfutures extends kucoin {
1092
1092
  * @param {string} type 'limit' or 'market'
1093
1093
  * @param {string} side 'buy' or 'sell'
1094
1094
  * @param {float} amount the amount of currency to trade
1095
- * @param {float} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency
1095
+ * @param {float} [price] *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency
1096
1096
  * @param {object} [params] Extra parameters specific to the exchange API endpoint
1097
1097
  * @param {float} [params.triggerPrice] The price a trigger order is triggered at
1098
1098
  * @param {float} [params.stopLossPrice] price to trigger stop-loss orders
@@ -1108,7 +1108,7 @@ export default class kucoinfutures extends kucoin {
1108
1108
  * @param {string} [params.stopPriceType] TP, IP or MP, defaults to MP: Mark Price
1109
1109
  * @param {bool} [params.closeOrder] set to true to close position
1110
1110
  * @param {bool} [params.forceHold] A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default.
1111
- * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
1111
+ * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1112
1112
  */
1113
1113
  await this.loadMarkets();
1114
1114
  const market = this.market(symbol);
@@ -1219,7 +1219,7 @@ export default class kucoinfutures extends kucoin {
1219
1219
  * @param {string} id order id
1220
1220
  * @param {string} symbol unified symbol of the market the order was made in
1221
1221
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1222
- * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
1222
+ * @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1223
1223
  */
1224
1224
  await this.loadMarkets();
1225
1225
  const request = {
@@ -1276,7 +1276,7 @@ export default class kucoinfutures extends kucoin {
1276
1276
  * @param {string} symbol unified market symbol
1277
1277
  * @param {float} amount amount of margin to add
1278
1278
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1279
- * @returns {object} a [margin structure]{@link https://docs.ccxt.com/#/?id=add-margin-structure}
1279
+ * @returns {object} a [margin structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#add-margin-structure}
1280
1280
  */
1281
1281
  await this.loadMarkets();
1282
1282
  const market = this.market(symbol);
@@ -1420,7 +1420,7 @@ export default class kucoinfutures extends kucoin {
1420
1420
  * @param {int} [params.until] End time in ms
1421
1421
  * @param {string} [params.side] buy or sell
1422
1422
  * @param {string} [params.type] limit or market
1423
- * @returns An [array of order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
1423
+ * @returns An [array of order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1424
1424
  */
1425
1425
  await this.loadMarkets();
1426
1426
  const stop = this.safeValue(params, 'stop');
@@ -1520,7 +1520,7 @@ export default class kucoinfutures extends kucoin {
1520
1520
  * @param {int} [params.till] end time in ms
1521
1521
  * @param {string} [params.side] buy or sell
1522
1522
  * @param {string} [params.type] limit, or market
1523
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
1523
+ * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1524
1524
  */
1525
1525
  return await this.fetchOrdersByStatus('done', symbol, since, limit, params);
1526
1526
  }
@@ -1532,7 +1532,7 @@ export default class kucoinfutures extends kucoin {
1532
1532
  * @see https://docs.kucoin.com/futures/#get-details-of-a-single-order
1533
1533
  * @param {string} symbol unified symbol of the market the order was made in
1534
1534
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1535
- * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
1535
+ * @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
1536
1536
  */
1537
1537
  await this.loadMarkets();
1538
1538
  const request = {};
@@ -1716,7 +1716,7 @@ export default class kucoinfutures extends kucoin {
1716
1716
  * @description fetch the current funding rate
1717
1717
  * @param {string} symbol unified market symbol
1718
1718
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1719
- * @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
1719
+ * @returns {object} a [funding rate structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure}
1720
1720
  */
1721
1721
  await this.loadMarkets();
1722
1722
  const market = this.market(symbol);
@@ -1780,7 +1780,7 @@ export default class kucoinfutures extends kucoin {
1780
1780
  * @name kucoinfutures#fetchBalance
1781
1781
  * @description query for balance and get the amount of funds available for trading or funds locked in orders
1782
1782
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1783
- * @returns {object} a [balance structure]{@link https://docs.ccxt.com/en/latest/manual.html?#balance-structure}
1783
+ * @returns {object} a [balance structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#balance-structure}
1784
1784
  */
1785
1785
  await this.loadMarkets();
1786
1786
  // only fetches one balance at a time
@@ -1820,7 +1820,7 @@ export default class kucoinfutures extends kucoin {
1820
1820
  * @param {string} fromAccount account to transfer from
1821
1821
  * @param {string} toAccount account to transfer to
1822
1822
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1823
- * @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
1823
+ * @returns {object} a [transfer structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure}
1824
1824
  */
1825
1825
  if ((toAccount !== 'main' && toAccount !== 'funding') || (fromAccount !== 'futures' && fromAccount !== 'future' && fromAccount !== 'contract')) {
1826
1826
  throw new BadRequest(this.id + ' transfer() only supports transfers from contract(future) account to main(funding) account');
@@ -1885,7 +1885,7 @@ export default class kucoinfutures extends kucoin {
1885
1885
  * @param {int} [since] the earliest time in ms to fetch trades for
1886
1886
  * @param {int} [limit] the maximum number of trades structures to retrieve
1887
1887
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1888
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
1888
+ * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#trade-structure}
1889
1889
  */
1890
1890
  await this.loadMarkets();
1891
1891
  const request = {
@@ -1951,7 +1951,7 @@ export default class kucoinfutures extends kucoin {
1951
1951
  * @param {int} [since] timestamp in ms of the earliest trade to fetch
1952
1952
  * @param {int} [limit] the maximum amount of trades to fetch
1953
1953
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
1954
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades}
1954
+ * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#public-trades}
1955
1955
  */
1956
1956
  await this.loadMarkets();
1957
1957
  const market = this.market(symbol);
@@ -2123,7 +2123,7 @@ export default class kucoinfutures extends kucoin {
2123
2123
  * @param {int} [since] the earliest time in ms to fetch deposits for
2124
2124
  * @param {int} [limit] the maximum number of deposits structures to retrieve
2125
2125
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
2126
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
2126
+ * @returns {object[]} a list of [transaction structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
2127
2127
  */
2128
2128
  await this.loadMarkets();
2129
2129
  const request = {};
@@ -2178,7 +2178,7 @@ export default class kucoinfutures extends kucoin {
2178
2178
  * @param {int} [since] the earliest time in ms to fetch withdrawals for
2179
2179
  * @param {int} [limit] the maximum number of withdrawals structures to retrieve
2180
2180
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
2181
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
2181
+ * @returns {object[]} a list of [transaction structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
2182
2182
  */
2183
2183
  await this.loadMarkets();
2184
2184
  const request = {};
@@ -2231,7 +2231,7 @@ export default class kucoinfutures extends kucoin {
2231
2231
  * @description retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market
2232
2232
  * @param {string} symbol unified market symbol
2233
2233
  * @param {object} [params] extra parameters specific to the kucoinfutures api endpoint
2234
- * @returns {object} a [leverage tiers structure]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}
2234
+ * @returns {object} a [leverage tiers structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#leverage-tiers-structure}
2235
2235
  */
2236
2236
  await this.loadMarkets();
2237
2237
  const market = this.market(symbol);
@@ -2302,9 +2302,9 @@ export default class kucoinfutures extends kucoin {
2302
2302
  * @description fetches historical funding rate prices
2303
2303
  * @param {string} symbol unified symbol of the market to fetch the funding rate history for
2304
2304
  * @param {int} [since] not used by kucuoinfutures
2305
- * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch
2305
+ * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-history-structure} to fetch
2306
2306
  * @param {object} [params] extra parameters specific to the okx api endpoint
2307
- * @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure}
2307
+ * @returns {object[]} a list of [funding rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-history-structure}
2308
2308
  */
2309
2309
  if (symbol === undefined) {
2310
2310
  throw new ArgumentsRequired(this.id + ' fetchFundingRateHistory() requires a symbol argument');