ccxt 4.5.45 → 4.5.47
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.
- package/README.md +5 -6
- package/dist/ccxt.browser.min.js +3 -3
- package/dist/cjs/ccxt.js +1 -6
- package/dist/cjs/src/aftermath.js +1 -1
- package/dist/cjs/src/backpack.js +1 -1
- package/dist/cjs/src/base/Exchange.js +27 -0
- package/dist/cjs/src/binance.js +23 -17
- package/dist/cjs/src/bitfinex.js +6 -11
- package/dist/cjs/src/bitget.js +9 -4
- package/dist/cjs/src/bitmart.js +144 -21
- package/dist/cjs/src/bitmex.js +46 -0
- package/dist/cjs/src/bitstamp.js +14 -1
- package/dist/cjs/src/bittrade.js +1 -1
- package/dist/cjs/src/blofin.js +137 -29
- package/dist/cjs/src/bybit.js +58 -56
- package/dist/cjs/src/bydfi.js +102 -100
- package/dist/cjs/src/gate.js +37 -2
- package/dist/cjs/src/hollaex.js +1 -1
- package/dist/cjs/src/kraken.js +39 -29
- package/dist/cjs/src/kucoin.js +2161 -462
- package/dist/cjs/src/lighter.js +2 -2
- package/dist/cjs/src/okx.js +75 -58
- package/dist/cjs/src/paradex.js +2 -6
- package/dist/cjs/src/pro/bittrade.js +4 -0
- package/dist/cjs/src/pro/bydfi.js +19 -19
- package/dist/cjs/src/pro/gate.js +79 -54
- package/dist/cjs/src/pro/grvt.js +6 -4
- package/dist/cjs/src/pro/htx.js +4 -4
- package/dist/cjs/src/pro/lighter.js +1 -1
- package/dist/cjs/src/pro/okx.js +1 -1
- package/dist/cjs/src/whitebit.js +21 -2
- package/index.d.cts +2 -0
- package/js/ccxt.d.ts +2 -8
- package/js/ccxt.js +2 -6
- package/js/src/abstract/bitmart.d.ts +7 -0
- package/js/src/abstract/blofin.d.ts +28 -12
- package/js/src/abstract/bydfi.d.ts +29 -29
- package/js/src/abstract/kraken.d.ts +36 -29
- package/js/src/abstract/kucoin.d.ts +2 -0
- package/js/src/abstract/kucoinfutures.d.ts +2 -0
- package/js/src/aftermath.js +1 -1
- package/js/src/backpack.js +1 -1
- package/js/src/base/Exchange.d.ts +2 -0
- package/js/src/base/Exchange.js +27 -0
- package/js/src/binance.js +23 -17
- package/js/src/bitfinex.js +6 -11
- package/js/src/bitget.d.ts +1 -1
- package/js/src/bitget.js +9 -4
- package/js/src/bitmart.d.ts +18 -4
- package/js/src/bitmart.js +144 -21
- package/js/src/bitmex.d.ts +12 -0
- package/js/src/bitmex.js +46 -0
- package/js/src/bitstamp.js +14 -1
- package/js/src/bittrade.js +1 -1
- package/js/src/blofin.d.ts +2 -0
- package/js/src/blofin.js +137 -29
- package/js/src/bybit.d.ts +1 -0
- package/js/src/bybit.js +58 -56
- package/js/src/bydfi.d.ts +31 -31
- package/js/src/bydfi.js +102 -100
- package/js/src/gate.js +37 -2
- package/js/src/hollaex.js +1 -1
- package/js/src/kraken.js +39 -29
- package/js/src/kucoin.d.ts +249 -8
- package/js/src/kucoin.js +2161 -462
- package/js/src/lighter.js +2 -2
- package/js/src/okx.d.ts +1 -0
- package/js/src/okx.js +75 -58
- package/js/src/paradex.d.ts +0 -1
- package/js/src/paradex.js +2 -6
- package/js/src/pro/bittrade.js +4 -0
- package/js/src/pro/bydfi.d.ts +18 -18
- package/js/src/pro/bydfi.js +19 -19
- package/js/src/pro/gate.d.ts +2 -2
- package/js/src/pro/gate.js +79 -54
- package/js/src/pro/grvt.js +6 -4
- package/js/src/pro/htx.js +4 -4
- package/js/src/pro/lighter.js +1 -1
- package/js/src/pro/okx.js +1 -1
- package/js/src/whitebit.d.ts +1 -1
- package/js/src/whitebit.js +21 -2
- package/package.json +2 -2
- package/dist/cjs/src/abstract/coincatch.js +0 -11
- package/dist/cjs/src/coincatch.js +0 -5495
- package/dist/cjs/src/pro/coincatch.js +0 -1563
- package/js/src/abstract/coincatch.d.ts +0 -97
- package/js/src/abstract/coincatch.js +0 -5
- package/js/src/coincatch.d.ts +0 -788
- package/js/src/coincatch.js +0 -5488
- package/js/src/pro/coincatch.d.ts +0 -207
- package/js/src/pro/coincatch.js +0 -1556
package/js/src/kucoin.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import Exchange from './abstract/kucoin.js';
|
|
2
|
-
import type { ADL, Account, Balances, BorrowInterest, Currency, Currencies, DepositAddress, Dict, FundingHistory, FundingRate, Int, int, LedgerEntry, Leverage, LeverageTier, LeverageTiers, MarginMode, MarginModification, Market, Num, OHLCV, Order, OrderBook, OrderRequest, OrderSide, OrderType, Position, Str, Strings, Ticker, Tickers, Trade, TradingFeeInterface, Transaction, TransferEntry } from './base/types.js';
|
|
2
|
+
import type { ADL, Account, Balances, BorrowInterest, Currency, Currencies, DepositAddress, Dict, FundingHistory, FundingRate, Int, int, LedgerEntry, Leverage, LeverageTier, LeverageTiers, MarginMode, MarginModification, Market, Num, OHLCV, Order, OrderBook, OrderRequest, OrderSide, OrderType, OpenInterest, OpenInterests, Position, Str, Strings, Ticker, Tickers, Trade, TradingFeeInterface, Transaction, TransferEntry } from './base/types.js';
|
|
3
3
|
/**
|
|
4
4
|
* @class kucoin
|
|
5
5
|
* @augments Exchange
|
|
@@ -72,12 +72,14 @@ export default class kucoin extends Exchange {
|
|
|
72
72
|
* @returns {object} an associative dictionary of currencies
|
|
73
73
|
*/
|
|
74
74
|
fetchCurrencies(params?: {}): Promise<Currencies>;
|
|
75
|
+
parseCurrency(currency: Dict): Currency;
|
|
75
76
|
/**
|
|
76
77
|
* @method
|
|
77
78
|
* @name kucoin#fetchAccounts
|
|
78
79
|
* @description fetch all the accounts associated with a profile
|
|
79
80
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-list-spot
|
|
80
81
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
82
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
|
|
81
83
|
* @returns {object} a dictionary of [account structures]{@link https://docs.ccxt.com/?id=account-structure} indexed by the account type
|
|
82
84
|
*/
|
|
83
85
|
fetchAccounts(params?: {}): Promise<Account[]>;
|
|
@@ -238,10 +240,12 @@ export default class kucoin extends Exchange {
|
|
|
238
240
|
* @name kucoin#fetchDepositAddress
|
|
239
241
|
* @description fetch the deposit address for a currency associated with this account
|
|
240
242
|
* @see https://www.kucoin.com/docs-new/rest/account-info/deposit/get-deposit-address-v3/en
|
|
243
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-deposit-address
|
|
241
244
|
* @param {string} code unified currency code
|
|
242
245
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
243
246
|
* @param {string} [params.network] the blockchain network name
|
|
244
|
-
* @param {string} [params.accountType] 'main' or '
|
|
247
|
+
* @param {string} [params.accountType] 'main', 'contract' or 'uta' (default is 'main')
|
|
248
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
245
249
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/?id=address-structure}
|
|
246
250
|
*/
|
|
247
251
|
fetchDepositAddress(code: string, params?: {}): Promise<DepositAddress>;
|
|
@@ -260,9 +264,11 @@ export default class kucoin extends Exchange {
|
|
|
260
264
|
* @method
|
|
261
265
|
* @name kucoin#fetchDepositAddressesByNetwork
|
|
262
266
|
* @see https://www.kucoin.com/docs-new/rest/account-info/deposit/get-deposit-address-v3/en
|
|
267
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-deposit-address
|
|
263
268
|
* @description fetch the deposit address for a currency associated with this account
|
|
264
269
|
* @param {string} code unified currency code
|
|
265
270
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
271
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
266
272
|
* @returns {object} an array of [address structures]{@link https://docs.ccxt.com/?id=address-structure}
|
|
267
273
|
*/
|
|
268
274
|
fetchDepositAddressesByNetwork(code: string, params?: {}): Promise<DepositAddress[]>;
|
|
@@ -296,13 +302,15 @@ export default class kucoin extends Exchange {
|
|
|
296
302
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/add-order
|
|
297
303
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/add-order-test
|
|
298
304
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/add-take-profit-and-stop-loss-order
|
|
305
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/place-order
|
|
299
306
|
* @param {string} symbol Unified CCXT market symbol
|
|
300
307
|
* @param {string} type 'limit' or 'market'
|
|
301
308
|
* @param {string} side 'buy' or 'sell'
|
|
302
309
|
* @param {float} amount the amount of currency to trade
|
|
303
310
|
* @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
|
|
304
311
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
305
|
-
*
|
|
312
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
313
|
+
* Check createSpotOrder(), createContractOrder() and createUtaOrder () for more details on the extra parameters that can be used in params
|
|
306
314
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
307
315
|
*/
|
|
308
316
|
createOrder(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): Promise<Order>;
|
|
@@ -326,7 +334,7 @@ export default class kucoin extends Exchange {
|
|
|
326
334
|
* @param {float} [params.triggerPrice] The price at which a trigger order is triggered at
|
|
327
335
|
* @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
|
|
328
336
|
* @param {string} [params.timeInForce] GTC, GTT, IOC, or FOK, default is GTC, limit orders only
|
|
329
|
-
* @param {
|
|
337
|
+
* @param {bool} [params.postOnly] Post only flag, invalid when timeInForce is IOC or FOK
|
|
330
338
|
*
|
|
331
339
|
* EXCHANGE SPECIFIC PARAMETERS
|
|
332
340
|
* @param {string} [params.clientOid] client order id, defaults to uuid if not passed
|
|
@@ -373,7 +381,7 @@ export default class kucoin extends Exchange {
|
|
|
373
381
|
* @param {float} [params.takeProfitPrice] price to trigger take-profit orders
|
|
374
382
|
* @param {bool} [params.reduceOnly] A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true.
|
|
375
383
|
* @param {string} [params.timeInForce] GTC, GTT, IOC, or FOK, default is GTC, limit orders only
|
|
376
|
-
* @param {
|
|
384
|
+
* @param {bool} [params.postOnly] Post only flag, invalid when timeInForce is IOC or FOK
|
|
377
385
|
* @param {float} [params.cost] the cost of the order in units of USDT
|
|
378
386
|
* @param {string} [params.marginMode] 'cross' or 'isolated', default is 'isolated'
|
|
379
387
|
* @param {bool} [params.hedged] *swap and future only* true for hedged mode, false for one way mode, default is false
|
|
@@ -392,6 +400,44 @@ export default class kucoin extends Exchange {
|
|
|
392
400
|
*/
|
|
393
401
|
createContractOrder(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): Promise<Order>;
|
|
394
402
|
createContractOrderRequest(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): any;
|
|
403
|
+
/**
|
|
404
|
+
* @method
|
|
405
|
+
* @name kucoin#createUtaOrder
|
|
406
|
+
* @description helper method for creating uta orders
|
|
407
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/place-order
|
|
408
|
+
* @param {string} symbol Unified CCXT market symbol
|
|
409
|
+
* @param {string} type 'limit' or 'market'
|
|
410
|
+
* @param {string} side 'buy' or 'sell'
|
|
411
|
+
* @param {float} amount the amount of currency to trade
|
|
412
|
+
* @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
|
|
413
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
414
|
+
* @param {string} [params.clientOrderId] client order id, defaults to uuid if not passed
|
|
415
|
+
* @param {float} [params.cost] the cost of the order in units of quote currency
|
|
416
|
+
* @param {string} [params.timeInForce] GTC, GTD, IOC, FOK or PO
|
|
417
|
+
* @param {bool} [params.postOnly] Post only flag, invalid when timeInForce is IOC or FOK (default is false)
|
|
418
|
+
* @param {bool} [params.reduceOnly] *contract markets only* A mark to reduce the position size only. Set to false by default
|
|
419
|
+
* @param {float} [params.triggerPrice] The price a trigger order is triggered at
|
|
420
|
+
* @param {string} [params.triggerDirection] 'ascending' or 'descending', the direction the triggerPrice is triggered from, requires triggerPrice
|
|
421
|
+
* @param {string} [params.triggerPriceType] *contract markets only* "last", "mark", "index" - defaults to "mark"
|
|
422
|
+
* @param {float} [params.stopLossPrice] price to trigger stop-loss orders
|
|
423
|
+
* @param {float} [params.takeProfitPrice] price to trigger take-profit orders
|
|
424
|
+
* @param {string} [params.marginMode] 'cross' or 'isolated', (default is 'cross' for margin orders, default is 'isolated' for contract orders)
|
|
425
|
+
*
|
|
426
|
+
* Exchange-specific parameters -------------------------------------------------
|
|
427
|
+
* @param {string} [params.accountMode] 'unified' or 'classic', default is 'unified'
|
|
428
|
+
* @param {string} [params.stp] '', // self trade prevention, CN, CO, CB or DC
|
|
429
|
+
* @param {int} [params.cancelAfter] - Cancel After N Seconds (Calculated from the time of entering the matching engine), only effective when timeInForce is GTD
|
|
430
|
+
* @param {string} [params.sizeUnit] *contracts only* 'BASECCY' (amount of base currency) or 'UNIT' (number of contracts), default is 'UNIT'
|
|
431
|
+
*
|
|
432
|
+
* Classic account parameters
|
|
433
|
+
* @param {bool} [params.autoBorrow] *classic margin orders only*
|
|
434
|
+
* @param {bool} [params.autoRepay] *classic margin orders only*
|
|
435
|
+
* @param {string} [params.hedged] *classic contract orders only* true for hedged mode, false for one way mode, default is false
|
|
436
|
+
* @param {int} [params.leverage] *classic contract orders with isolated marginMode only* Leverage size of the order
|
|
437
|
+
* @returns {object} an [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
438
|
+
*/
|
|
439
|
+
createUtaOrder(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): Promise<Order>;
|
|
440
|
+
createUtaOrderRequest(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): any;
|
|
395
441
|
/**
|
|
396
442
|
* @method
|
|
397
443
|
* @name kucoin#createMarketOrderWithCost
|
|
@@ -497,11 +543,13 @@ export default class kucoin extends Exchange {
|
|
|
497
543
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/cancel-stop-order-by-clientoid
|
|
498
544
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/cancel-order-by-orderld
|
|
499
545
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/cancel-order-by-clientoid
|
|
546
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/cancel-order
|
|
500
547
|
* @param {string} id order id
|
|
501
548
|
* @param {string} symbol unified symbol of the market the order was made in
|
|
502
549
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
503
550
|
* @param {string} [params.type] 'spot' or 'swap', used if symbol is not provided (default is 'spot')
|
|
504
551
|
* @param {string} [params.marginMode] *spot only* 'cross' or 'isolated'
|
|
552
|
+
* @param {boolean} [params.uta] true for cancelling order with unified account endpoint (default is false)
|
|
505
553
|
* Check cancelSpotOrder() and cancelContractOrder() for more details on the extra parameters that can be used in params
|
|
506
554
|
* @returns Response from the exchange
|
|
507
555
|
*/
|
|
@@ -543,6 +591,20 @@ export default class kucoin extends Exchange {
|
|
|
543
591
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
544
592
|
*/
|
|
545
593
|
cancelContractOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
|
|
594
|
+
/**
|
|
595
|
+
* @method
|
|
596
|
+
* @name kucoin#cancelUtaOrder
|
|
597
|
+
* @description helper method for cancelling uta orders
|
|
598
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/cancel-order
|
|
599
|
+
* @param {string} id order id
|
|
600
|
+
* @param {string} symbol unified symbol of the market the order was made in
|
|
601
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
602
|
+
* @param {string} [params.accountMode] 'unified' or 'classic' (default is 'unified')
|
|
603
|
+
* @param {string} [params.clientOrderId] client order id, required if id is not provided
|
|
604
|
+
* @param {string} [params.marginMode] 'cross' or 'isolated', required if fetching a margin order
|
|
605
|
+
* @returns Response from the exchange
|
|
606
|
+
*/
|
|
607
|
+
cancelUtaOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
|
|
546
608
|
/**
|
|
547
609
|
* @method
|
|
548
610
|
* @name kucoin#cancelAllOrders
|
|
@@ -554,10 +616,13 @@ export default class kucoin extends Exchange {
|
|
|
554
616
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/batch-cancel-stop-orders
|
|
555
617
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/cancel-all-orders
|
|
556
618
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/cancel-all-stop-orders
|
|
619
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/batch-cancel-order-by-symbol
|
|
557
620
|
* @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
|
|
558
621
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
559
622
|
* @param {string} [params.type] 'spot' or 'swap', used if symbol is not provided (default is 'spot')
|
|
560
623
|
* @param {string} [params.marginMode] *spot only* 'cross' or 'isolated'
|
|
624
|
+
* @param {boolean} [params.uta] true for cancelling orders with unified account endpoint (default is false)
|
|
625
|
+
* Check cancelAllSpotOrders(), cancelAllContractOrders() and cancelAllUtaOrders() for more details on the extra parameters that can be used in params
|
|
561
626
|
* @returns Response from the exchange
|
|
562
627
|
*/
|
|
563
628
|
cancelAllOrders(symbol?: Str, params?: {}): Promise<Order[]>;
|
|
@@ -591,6 +656,18 @@ export default class kucoin extends Exchange {
|
|
|
591
656
|
* @returns Response from the exchange
|
|
592
657
|
*/
|
|
593
658
|
cancelAllContractOrders(symbol?: Str, params?: {}): Promise<Order[]>;
|
|
659
|
+
/**
|
|
660
|
+
* @method
|
|
661
|
+
* @name kucoin#cancelAllUtaOrders
|
|
662
|
+
* @description helper method for cancelling all uta orders
|
|
663
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/batch-cancel-order-by-symbol
|
|
664
|
+
* @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
|
|
665
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
666
|
+
* @param {bool} [params.trigger] true if cancelling all stop orders
|
|
667
|
+
* @param {string} [params.marginMode] 'CROSS' or 'ISOLATED'
|
|
668
|
+
* @returns Response from the exchange
|
|
669
|
+
*/
|
|
670
|
+
cancelAllUtaOrders(symbol?: Str, params?: {}): Promise<Order[]>;
|
|
594
671
|
/**
|
|
595
672
|
* @method
|
|
596
673
|
* @name kucoin#fetchOrdersByStatus
|
|
@@ -603,12 +680,15 @@ export default class kucoin extends Exchange {
|
|
|
603
680
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-stop-order-list
|
|
604
681
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/get-order-list
|
|
605
682
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/get-stop-order-list
|
|
683
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-open-order-list
|
|
684
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-order-history
|
|
606
685
|
* @param {string} status 'active' or 'closed', only 'active' is valid for stop orders
|
|
607
686
|
* @param {string} symbol unified symbol for the market to retrieve orders from
|
|
608
687
|
* @param {int} [since] timestamp in ms of the earliest order to retrieve
|
|
609
688
|
* @param {int} [limit] The maximum number of orders to retrieve
|
|
610
689
|
* @param {object} [params] exchange specific parameters
|
|
611
|
-
*
|
|
690
|
+
* @param {boolean} [params.uta] true for fetch orders with uta endpoint (default is false)
|
|
691
|
+
* Check fetchSpotOrdersByStatus(), fetchContractOrdersByStatus() and fetchUtaOrdersByStatus() for more details on the extra parameters that can be used in params
|
|
612
692
|
* @returns An [array of order structures]{@link https://docs.ccxt.com/?id=order-structure}
|
|
613
693
|
*/
|
|
614
694
|
fetchOrdersByStatus(status: any, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
|
|
@@ -658,6 +738,24 @@ export default class kucoin extends Exchange {
|
|
|
658
738
|
* @returns An [array of order structures]{@link https://docs.ccxt.com/?id=order-structure}
|
|
659
739
|
*/
|
|
660
740
|
fetchContractOrdersByStatus(status: any, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
|
|
741
|
+
/**
|
|
742
|
+
* @method
|
|
743
|
+
* @name kucoin#fetchUtaOrdersByStatus
|
|
744
|
+
* @description helper method for fetching orders by status with uta endpoint
|
|
745
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-open-order-list
|
|
746
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-order-history
|
|
747
|
+
* @param {string} status 'active' or 'closed', only 'active' is valid for stop orders
|
|
748
|
+
* @param {string} symbol unified symbol for the market to retrieve orders from
|
|
749
|
+
* @param {int} [since] timestamp in ms of the earliest order to retrieve
|
|
750
|
+
* @param {int} [limit] The maximum number of orders to retrieve
|
|
751
|
+
* @param {object} [params] exchange specific parameters
|
|
752
|
+
* @param {int} [params.until] End time in ms
|
|
753
|
+
* @param {string} [params.side] *closed orders only* 'BUY' or 'SELL'
|
|
754
|
+
* @param {string} [params.accountMode] 'unified' or 'classic' (default is unified)
|
|
755
|
+
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
756
|
+
* @returns An [array of order structures]{@link https://docs.ccxt.com/?id=order-structure}
|
|
757
|
+
*/
|
|
758
|
+
fetchUtaOrdersByStatus(status: any, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
|
|
661
759
|
/**
|
|
662
760
|
* @method
|
|
663
761
|
* @name kucoin#fetchClosedOrders
|
|
@@ -668,6 +766,7 @@ export default class kucoin extends Exchange {
|
|
|
668
766
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/get-stop-order-list
|
|
669
767
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-open-orders
|
|
670
768
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-closed-orders
|
|
769
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-order-history
|
|
671
770
|
* @param {string} symbol unified market symbol of the market orders were made in
|
|
672
771
|
* @param {int} [since] the earliest time in ms to fetch orders for
|
|
673
772
|
* @param {int} [limit] the maximum number of order structures to retrieve
|
|
@@ -693,6 +792,7 @@ export default class kucoin extends Exchange {
|
|
|
693
792
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-open-orders
|
|
694
793
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-closed-orders
|
|
695
794
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-stop-order-list
|
|
795
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-open-order-list
|
|
696
796
|
* @param {string} symbol unified market symbol
|
|
697
797
|
* @param {int} [since] the earliest time in ms to fetch open orders for
|
|
698
798
|
* @param {int} [limit] the maximum number of open orders structures to retrieve
|
|
@@ -723,11 +823,13 @@ export default class kucoin extends Exchange {
|
|
|
723
823
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-stop-order-by-clientoid
|
|
724
824
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/get-order-by-orderld
|
|
725
825
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/get-stop-order-by-clientoid
|
|
826
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-order-details
|
|
726
827
|
* @param {string} id order id
|
|
727
828
|
* @param {string} symbol unified symbol of the market the order was made in
|
|
728
829
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
729
830
|
* @param {string} [params.type] 'spot' or 'swap', used if symbol is not provided (default is 'spot')
|
|
730
|
-
*
|
|
831
|
+
* @param {bool} [params.uta] true if fetching an order with uta endpoint (default is false)
|
|
832
|
+
* Check fetchSpotOrder(), fetchContractOrder() and fetchUtaOrder() for more details on the extra parameters that can be used in params
|
|
731
833
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
732
834
|
*/
|
|
733
835
|
fetchOrder(id: Str, symbol?: Str, params?: {}): Promise<Order>;
|
|
@@ -765,9 +867,27 @@ export default class kucoin extends Exchange {
|
|
|
765
867
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
766
868
|
*/
|
|
767
869
|
fetchContractOrder(id: Str, symbol?: Str, params?: {}): Promise<Order>;
|
|
870
|
+
/**
|
|
871
|
+
* @method
|
|
872
|
+
* @name kucoin#fetchUtaOrder
|
|
873
|
+
* @description fetch uta order
|
|
874
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-order-details
|
|
875
|
+
* @param {string} id order id
|
|
876
|
+
* @param {string} symbol unified symbol of the market the order was made in
|
|
877
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
878
|
+
* @param {string} [params.accountMode] 'unified' or 'classic' (default is 'unified')
|
|
879
|
+
* @param {string} [params.clientOrderId] client order id, required if id is not provided
|
|
880
|
+
* @param {string} [params.marginMode] 'cross' or 'isolated', required if fetching a margin order
|
|
881
|
+
* @returns {object} An [order structure]{@link https://docs.ccxt.com/?id=order-structure}
|
|
882
|
+
*/
|
|
883
|
+
fetchUtaOrder(id: Str, symbol?: Str, params?: {}): Promise<Order>;
|
|
884
|
+
handleTradeType(isContractMarket?: boolean, marginMode?: any, params?: {}): string;
|
|
768
885
|
parseOrder(order: Dict, market?: Market): Order;
|
|
769
886
|
parseContractOrder(order: Dict, market?: Market): Order;
|
|
770
887
|
parseSpotOrder(order: Dict, market?: Market): Order;
|
|
888
|
+
parseUtaOrder(order: Dict, market?: Market): Order;
|
|
889
|
+
parseOrderTimeInForce(timeInForce: Str): Str;
|
|
890
|
+
parseOrderStatus(status: Str): Str;
|
|
771
891
|
/**
|
|
772
892
|
* @method
|
|
773
893
|
* @name kucoin#fetchOrderTrades
|
|
@@ -775,12 +895,14 @@ export default class kucoin extends Exchange {
|
|
|
775
895
|
* @see https://docs.kucoin.com/#list-fills
|
|
776
896
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/orders/get-trade-history
|
|
777
897
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-trade-history
|
|
898
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-trade-history
|
|
778
899
|
* @param {string} id order id
|
|
779
900
|
* @param {string} symbol unified market symbol
|
|
780
901
|
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
781
902
|
* @param {int} [limit] the maximum number of trades to retrieve
|
|
782
903
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
783
904
|
* @param {string} [params.type] 'spot' or 'swap', used if symbol is not provided (default is 'spot')
|
|
905
|
+
* @param {boolean} [params.uta] set to true if fetching trades from uta endpoint, default is false.
|
|
784
906
|
* @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/?id=trade-structure}
|
|
785
907
|
*/
|
|
786
908
|
fetchOrderTrades(id: string, symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
|
|
@@ -789,6 +911,7 @@ export default class kucoin extends Exchange {
|
|
|
789
911
|
* @name kucoin#fetchMyTrades
|
|
790
912
|
* @see https://www.kucoin.com/docs-new/rest/spot-trading/orders/get-trade-history
|
|
791
913
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/orders/get-trade-history
|
|
914
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-trade-history
|
|
792
915
|
* @description fetch all trades made by the user
|
|
793
916
|
* @param {string} symbol unified market symbol
|
|
794
917
|
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
@@ -831,6 +954,23 @@ export default class kucoin extends Exchange {
|
|
|
831
954
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/?id=trade-structure}
|
|
832
955
|
*/
|
|
833
956
|
fetchMyContractTrades(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
|
|
957
|
+
/**
|
|
958
|
+
* @method
|
|
959
|
+
* @name kucoin#fetchMyUtaTrades
|
|
960
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-trade-history
|
|
961
|
+
* @description fetch all trades made by the user
|
|
962
|
+
* @param {string} symbol unified market symbol
|
|
963
|
+
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
964
|
+
* @param {int} [limit] the maximum number of trades structures to retrieve (default is 50, max is 200)
|
|
965
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
966
|
+
* @param {int} [params.until] the latest time in ms to fetch entries for
|
|
967
|
+
* @param {string} [params.accountMode] 'unified' or 'classic', defaults to 'unified'
|
|
968
|
+
* @param {string} [params.marginMode] 'cross' or 'isolated', only for margin trades
|
|
969
|
+
* @param {string} [params.side] 'BUY' or 'SELL' (both if not provided)
|
|
970
|
+
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
971
|
+
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/?id=trade-structure}
|
|
972
|
+
*/
|
|
973
|
+
fetchMyUtaTrades(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
|
|
834
974
|
/**
|
|
835
975
|
* @method
|
|
836
976
|
* @name kucoin#fetchTrades
|
|
@@ -849,14 +989,17 @@ export default class kucoin extends Exchange {
|
|
|
849
989
|
parseTrade(trade: Dict, market?: Market): Trade;
|
|
850
990
|
parseSpotOrUtaTrade(trade: Dict, market?: Market): Trade;
|
|
851
991
|
parseContractTrade(trade: Dict, market?: Market): Trade;
|
|
992
|
+
parseMyUtaTrade(trade: Dict, market?: Market): Trade;
|
|
852
993
|
/**
|
|
853
994
|
* @method
|
|
854
995
|
* @name kucoin#fetchTradingFee
|
|
855
996
|
* @description fetch the trading fees for a market
|
|
856
997
|
* @see https://www.kucoin.com/docs-new/rest/account-info/trade-fee/get-actual-fee-spot-margin
|
|
857
998
|
* @see https://www.kucoin.com/docs-new/rest/account-info/trade-fee/get-actual-fee-futures
|
|
999
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-actual-fee
|
|
858
1000
|
* @param {string} symbol unified market symbol
|
|
859
1001
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1002
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
860
1003
|
* @returns {object} a [fee structure]{@link https://docs.ccxt.com/?id=fee-structure}
|
|
861
1004
|
*/
|
|
862
1005
|
fetchTradingFee(symbol: string, params?: {}): Promise<TradingFeeInterface>;
|
|
@@ -940,10 +1083,13 @@ export default class kucoin extends Exchange {
|
|
|
940
1083
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-cross-margin
|
|
941
1084
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-isolated-margin
|
|
942
1085
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-futures
|
|
1086
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-currency-assets-uta
|
|
1087
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-currency-assets-classic
|
|
943
1088
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
944
1089
|
* @param {object} [params.marginMode] 'cross' or 'isolated', margin type for fetching margin balance
|
|
945
1090
|
* @param {object} [params.type] extra parameters specific to the exchange API endpoint
|
|
946
1091
|
* @param {object} [params.hf] *default if false* if true, the result includes the balance of the high frequency account
|
|
1092
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
947
1093
|
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/?id=balance-structure}
|
|
948
1094
|
*/
|
|
949
1095
|
fetchBalance(params?: {}): Promise<Balances>;
|
|
@@ -957,11 +1103,55 @@ export default class kucoin extends Exchange {
|
|
|
957
1103
|
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/?id=balance-structure}
|
|
958
1104
|
*/
|
|
959
1105
|
fetchContractBalance(params?: {}): Promise<Balances>;
|
|
1106
|
+
/**
|
|
1107
|
+
* @method
|
|
1108
|
+
* @name kucoin#fetchUtaBalance
|
|
1109
|
+
* @description helper method for fetching balance with unified trading account (uta) endpoint
|
|
1110
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-currency-assets-uta
|
|
1111
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-currency-assets-classic
|
|
1112
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1113
|
+
* @param {string} [params.type] 'spot', 'unified', 'funding', 'cross', 'isolated' or 'swap' (default is 'spot')
|
|
1114
|
+
* @param {string} [params.marginMode] 'cross' or 'isolated', margin type for fetching margin balance, only applicable if type is margin (default is cross)
|
|
1115
|
+
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/?id=balance-structure}
|
|
1116
|
+
*/
|
|
1117
|
+
fetchUtaBalance(params?: {}): Promise<Balances>;
|
|
960
1118
|
/**
|
|
961
1119
|
* @method
|
|
962
1120
|
* @name kucoin#transfer
|
|
963
1121
|
* @description transfer currency internally between wallets on the same account
|
|
964
1122
|
* @see https://www.kucoin.com/docs-new/rest/account-info/transfer/flex-transfer?lang=en_US&
|
|
1123
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/flex-transfer
|
|
1124
|
+
* @param {string} code unified currency code
|
|
1125
|
+
* @param {float} amount amount to transfer
|
|
1126
|
+
* @param {string} fromAccount account to transfer from
|
|
1127
|
+
* @param {string} toAccount account to transfer to
|
|
1128
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1129
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta) endpoint, defaults to false
|
|
1130
|
+
* Check transferClassic() and transferUta() for more details on params
|
|
1131
|
+
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/?id=transfer-structure}
|
|
1132
|
+
*/
|
|
1133
|
+
transfer(code: string, amount: number, fromAccount: string, toAccount: string, params?: {}): Promise<TransferEntry>;
|
|
1134
|
+
/**
|
|
1135
|
+
* @method
|
|
1136
|
+
* @name kucoin#transferUta
|
|
1137
|
+
* @description transfer currency internally between wallets on the same account with uta endpoint
|
|
1138
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/flex-transfer
|
|
1139
|
+
* @param {string} code unified currency code
|
|
1140
|
+
* @param {float} amount amount to transfer
|
|
1141
|
+
* @param {string} fromAccount account to transfer from
|
|
1142
|
+
* @param {string} toAccount account to transfer to
|
|
1143
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1144
|
+
* @param {string} [params.transferType] INTERNAL, PARENT_TO_SUB, SUB_TO_PARENT, SUB_TO_SUB (default is INTERNAL)
|
|
1145
|
+
* @param {string} [params.fromUserId] required if transferType is SUB_TO_PARENT or SUB_TO_SUB
|
|
1146
|
+
* @param {string} [params.toUserId] required if transferType is PARENT_TO_SUB or SUB_TO_SUB
|
|
1147
|
+
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/?id=transfer-structure}
|
|
1148
|
+
*/
|
|
1149
|
+
transferUta(code: string, amount: number, fromAccount: string, toAccount: string, params?: {}): Promise<TransferEntry>;
|
|
1150
|
+
/**
|
|
1151
|
+
* @method
|
|
1152
|
+
* @name kucoin#transferClassic
|
|
1153
|
+
* @description transfer currency internally between wallets on the same account with classic endpoints
|
|
1154
|
+
* @see https://www.kucoin.com/docs-new/rest/account-info/transfer/flex-transfer?lang=en_US&
|
|
965
1155
|
* @param {string} code unified currency code
|
|
966
1156
|
* @param {float} amount amount to transfer
|
|
967
1157
|
* @param {string} fromAccount account to transfer from
|
|
@@ -972,7 +1162,7 @@ export default class kucoin extends Exchange {
|
|
|
972
1162
|
* @param {string} [params.toUserId] required if transferType is PARENT_TO_SUB
|
|
973
1163
|
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/?id=transfer-structure}
|
|
974
1164
|
*/
|
|
975
|
-
|
|
1165
|
+
transferClassic(code: string, amount: number, fromAccount: string, toAccount: string, params?: {}): Promise<TransferEntry>;
|
|
976
1166
|
isHfOrMining(fromId: Str, toId: Str): boolean;
|
|
977
1167
|
parseTransfer(transfer: Dict, currency?: Currency): TransferEntry;
|
|
978
1168
|
parseTransferStatus(status: Str): Str;
|
|
@@ -988,6 +1178,7 @@ export default class kucoin extends Exchange {
|
|
|
988
1178
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-ledgers-tradehf
|
|
989
1179
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-ledgers-marginhf
|
|
990
1180
|
* @see https://www.kucoin.com/docs-new/rest/account-info/account-funding/get-account-ledgers-futures
|
|
1181
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-ledger
|
|
991
1182
|
* @param {string} [code] unified currency code, default is undefined
|
|
992
1183
|
* @param {int} [since] timestamp in ms of the earliest ledger entry, default is undefined
|
|
993
1184
|
* @param {int} [limit] max number of ledger entries to return, default is undefined
|
|
@@ -995,6 +1186,7 @@ export default class kucoin extends Exchange {
|
|
|
995
1186
|
* @param {object} [params.type] extra parameters specific to the exchange API endpoint
|
|
996
1187
|
* @param {boolean} [params.hf] default false, when true will fetch ledger entries for the high frequency trading account
|
|
997
1188
|
* @param {int} [params.until] the latest time in ms to fetch entries for
|
|
1189
|
+
* @param {boolean} [params.uta] default false, when true will fetch ledger entries for the unified trading account (UTA) instead of the regular accounts endpoint
|
|
998
1190
|
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [available parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
999
1191
|
* @returns {object} a [ledger structure]{@link https://docs.ccxt.com/?id=ledger-entry-structure}
|
|
1000
1192
|
*/
|
|
@@ -1168,9 +1360,11 @@ export default class kucoin extends Exchange {
|
|
|
1168
1360
|
* @description set the level of leverage for a market
|
|
1169
1361
|
* @see https://www.kucoin.com/docs-new/rest/margin-trading/debit/modify-leverage
|
|
1170
1362
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/positions/modify-cross-margin-leverage
|
|
1363
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/modify-leverage-uta
|
|
1171
1364
|
* @param {int } [leverage] New leverage multiplier. Must be greater than 1 and up to two decimal places, and cannot be less than the user's current debt leverage or greater than the system's maximum leverage
|
|
1172
1365
|
* @param {string} [symbol] unified market symbol
|
|
1173
1366
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1367
|
+
* @param {boolean} [params.uta] *contract markets only* set to true for the unified trading account (uta)
|
|
1174
1368
|
* @returns {object} response from the exchange
|
|
1175
1369
|
*/
|
|
1176
1370
|
setLeverage(leverage: int, symbol?: Str, params?: {}): Promise<any>;
|
|
@@ -1179,9 +1373,11 @@ export default class kucoin extends Exchange {
|
|
|
1179
1373
|
* @name kucoin#setContractLeverage
|
|
1180
1374
|
* @description set the level of leverage for a market
|
|
1181
1375
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/positions/modify-cross-margin-leverage
|
|
1376
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/modify-leverage-uta
|
|
1182
1377
|
* @param {float} leverage the rate of leverage
|
|
1183
1378
|
* @param {string} symbol unified market symbol
|
|
1184
1379
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1380
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta)
|
|
1185
1381
|
* @returns {object} response from the exchange
|
|
1186
1382
|
*/
|
|
1187
1383
|
setContractLeverage(leverage: int, symbol?: Str, params?: {}): Promise<Leverage>;
|
|
@@ -1247,9 +1443,11 @@ export default class kucoin extends Exchange {
|
|
|
1247
1443
|
* @method
|
|
1248
1444
|
* @name kucoin#fetchPosition
|
|
1249
1445
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/positions/get-position-details
|
|
1446
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-position-list-uta
|
|
1250
1447
|
* @description fetch data on an open position
|
|
1251
1448
|
* @param {string} symbol unified market symbol of the market the position is held in
|
|
1252
1449
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1450
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
|
|
1253
1451
|
* @returns {object} a [position structure]{@link https://docs.ccxt.com/?id=position-structure}
|
|
1254
1452
|
*/
|
|
1255
1453
|
fetchPosition(symbol: string, params?: {}): Promise<Position>;
|
|
@@ -1258,8 +1456,10 @@ export default class kucoin extends Exchange {
|
|
|
1258
1456
|
* @name kucoin#fetchPositions
|
|
1259
1457
|
* @description fetch all open positions
|
|
1260
1458
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/positions/get-position-list
|
|
1459
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-position-list-uta
|
|
1261
1460
|
* @param {string[]|undefined} symbols list of unified market symbols
|
|
1262
1461
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1462
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
|
|
1263
1463
|
* @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/?id=position-structure}
|
|
1264
1464
|
*/
|
|
1265
1465
|
fetchPositions(symbols?: Strings, params?: {}): Promise<Position[]>;
|
|
@@ -1268,12 +1468,14 @@ export default class kucoin extends Exchange {
|
|
|
1268
1468
|
* @name kucoin#fetchPositionsHistory
|
|
1269
1469
|
* @description fetches historical positions
|
|
1270
1470
|
* @see https://www.kucoin.com/docs-new/rest/futures-trading/positions/get-positions-history
|
|
1471
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-position-history-uta
|
|
1271
1472
|
* @param {string[]} [symbols] list of unified market symbols
|
|
1272
1473
|
* @param {int} [since] the earliest time in ms to fetch position history for
|
|
1273
1474
|
* @param {int} [limit] the maximum number of entries to retrieve
|
|
1274
1475
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1275
1476
|
* @param {int} [params.until] closing end time
|
|
1276
1477
|
* @param {int} [params.pageId] page id
|
|
1478
|
+
* @param {boolean} [params.uta] set to true for the unified trading account (uta), defaults to false
|
|
1277
1479
|
* @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/?id=position-structure}
|
|
1278
1480
|
*/
|
|
1279
1481
|
fetchPositionsHistory(symbols?: Strings, since?: Int, limit?: Int, params?: {}): Promise<Position[]>;
|
|
@@ -1283,10 +1485,14 @@ export default class kucoin extends Exchange {
|
|
|
1283
1485
|
* @name kucoin#cancelOrders
|
|
1284
1486
|
* @description cancel multiple orders for contract markets
|
|
1285
1487
|
* @see https://www.kucoin.com/docs-new/3470241e0
|
|
1488
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/batch-cancel-order-by-id
|
|
1286
1489
|
* @param {string[]} ids order ids
|
|
1287
1490
|
* @param {string} symbol unified symbol of the market the order was made in
|
|
1288
1491
|
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1289
1492
|
* @param {string[]} [params.clientOrderIds] client order ids
|
|
1493
|
+
* @param {boolean} [params.uta] set to true to use the unified trading account (uta) endpoint, defaults to false for the contract orders
|
|
1494
|
+
* @param {string} [params.accountMode] *for uta endpoint only* 'unified' or 'classic' (default is 'unified')
|
|
1495
|
+
* @param {string} [params.marginMode] *for margin orders only* 'cross' or 'isolated'
|
|
1290
1496
|
* @returns {object} an list of [order structures]{@link https://docs.ccxt.com/?id=order-structure}
|
|
1291
1497
|
*/
|
|
1292
1498
|
cancelOrders(ids: string[], symbol?: Str, params?: {}): Promise<Order[]>;
|
|
@@ -1384,6 +1590,41 @@ export default class kucoin extends Exchange {
|
|
|
1384
1590
|
* @returns {object} a dictionary of [leverage tiers structures]{@link https://docs.ccxt.com/?id=leverage-tiers-structure}, indexed by market symbols
|
|
1385
1591
|
*/
|
|
1386
1592
|
fetchLeverageTiers(symbols?: Strings, params?: {}): Promise<LeverageTiers>;
|
|
1593
|
+
/**
|
|
1594
|
+
* @method
|
|
1595
|
+
* @name kucoin#fetchOpenInterests
|
|
1596
|
+
* @description Retrieves the open interest for a list of symbols
|
|
1597
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-futures-open-interset
|
|
1598
|
+
* @param {string[]} [symbols] Unified CCXT market symbol
|
|
1599
|
+
* @param {object} [params] exchange specific parameters
|
|
1600
|
+
* @returns {object} an open interest structure{@link https://docs.ccxt.com/?id=open-interest-structure}
|
|
1601
|
+
*/
|
|
1602
|
+
fetchOpenInterests(symbols?: Strings, params?: {}): Promise<OpenInterests>;
|
|
1603
|
+
parseOpenInterest(interest: any, market?: Market): OpenInterest;
|
|
1604
|
+
/**
|
|
1605
|
+
* @method
|
|
1606
|
+
* @name kucoin#fetchOpenInterestHistory
|
|
1607
|
+
* @description Retrieves the open interest history of a currency
|
|
1608
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-futures-open-interset
|
|
1609
|
+
* @param {string} symbol Unified CCXT market symbol
|
|
1610
|
+
* @param {string} timeframe '5m', '15m', '30m', '1h', '4h' or '1d'
|
|
1611
|
+
* @param {int} [since] the time(ms) of the earliest record to retrieve as a unix timestamp
|
|
1612
|
+
* @param {int} [limit] default 30,max 200
|
|
1613
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1614
|
+
* @param {int} [params.until] the latest time in ms to fetch entries for
|
|
1615
|
+
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
1616
|
+
* @returns {object} an array of [open interest structures]{@link https://docs.ccxt.com/?id=open-interest-structure}
|
|
1617
|
+
*/
|
|
1618
|
+
fetchOpenInterestHistory(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OpenInterest[]>;
|
|
1619
|
+
/**
|
|
1620
|
+
* @method
|
|
1621
|
+
* @name kucoin#isUTAEnabled
|
|
1622
|
+
* @see https://www.kucoin.com/docs-new/rest/ua/get-account-mode
|
|
1623
|
+
* @description returns true or false so the user can check if unified account is enabled
|
|
1624
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1625
|
+
* @returns {boolean} true if unified account is enabled, false otherwise
|
|
1626
|
+
*/
|
|
1627
|
+
isUTAEnabled(params?: {}): Promise<boolean>;
|
|
1387
1628
|
sign(path: any, api?: string, method?: string, params?: {}, headers?: any, body?: any): {
|
|
1388
1629
|
url: any;
|
|
1389
1630
|
method: string;
|