kucoin-api 2.5.0 → 2.5.2
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 +1 -0
- package/dist/cjs/BrokerClient.d.ts +2 -2
- package/dist/cjs/BrokerClient.js +2 -2
- package/dist/cjs/SpotClient.d.ts +20 -13
- package/dist/cjs/SpotClient.js +20 -13
- package/dist/cjs/SpotClient.js.map +1 -1
- package/dist/cjs/UnifiedAPIClient.d.ts +44 -3
- package/dist/cjs/UnifiedAPIClient.js +61 -1
- package/dist/cjs/UnifiedAPIClient.js.map +1 -1
- package/dist/cjs/types/request/broker.types.d.ts +1 -1
- package/dist/cjs/types/request/spot-funding.d.ts +2 -2
- package/dist/cjs/types/request/uta-types.d.ts +67 -8
- package/dist/cjs/types/response/broker.types.d.ts +1 -1
- package/dist/cjs/types/response/spot-account.d.ts +3 -1
- package/dist/cjs/types/response/uta-types.d.ts +85 -8
- package/dist/mjs/BrokerClient.d.ts +2 -2
- package/dist/mjs/BrokerClient.js +2 -2
- package/dist/mjs/SpotClient.d.ts +20 -13
- package/dist/mjs/SpotClient.js +20 -13
- package/dist/mjs/SpotClient.js.map +1 -1
- package/dist/mjs/UnifiedAPIClient.d.ts +44 -3
- package/dist/mjs/UnifiedAPIClient.js +61 -1
- package/dist/mjs/UnifiedAPIClient.js.map +1 -1
- package/dist/mjs/types/request/broker.types.d.ts +1 -1
- package/dist/mjs/types/request/spot-funding.d.ts +2 -2
- package/dist/mjs/types/request/uta-types.d.ts +67 -8
- package/dist/mjs/types/response/broker.types.d.ts +1 -1
- package/dist/mjs/types/response/spot-account.d.ts +3 -1
- package/dist/mjs/types/response/uta-types.d.ts +85 -8
- package/llms.txt +11927 -10918
- package/package.json +1 -1
|
@@ -113,10 +113,27 @@ export interface GetInterestHistoryRequestUTA {
|
|
|
113
113
|
page?: number;
|
|
114
114
|
size?: number;
|
|
115
115
|
}
|
|
116
|
+
export interface GetBorrowingRatesAndLimitsRequestUTA {
|
|
117
|
+
currency: string;
|
|
118
|
+
}
|
|
116
119
|
export interface ModifyLeverageRequestUTA {
|
|
117
120
|
symbol: string;
|
|
118
121
|
leverage: string;
|
|
119
122
|
}
|
|
123
|
+
/** UTA cross margin only — path includes accountMode (typically unified) */
|
|
124
|
+
export interface ModifyMarginCrossLeverageRequestUTA {
|
|
125
|
+
leverage: string;
|
|
126
|
+
/** Cross margin currency (e.g. BTC) */
|
|
127
|
+
currency?: string;
|
|
128
|
+
}
|
|
129
|
+
export interface GetLeverageRequestUTA {
|
|
130
|
+
tradeType: 'MARGIN' | 'FUTURES';
|
|
131
|
+
marginMode: 'CROSS' | 'ISOLATED';
|
|
132
|
+
/** Required for MARGIN when not returning all; optional => all for MARGIN */
|
|
133
|
+
currency?: string;
|
|
134
|
+
/** Required for FUTURES when not returning all; optional => all for FUTURES */
|
|
135
|
+
symbol?: string;
|
|
136
|
+
}
|
|
120
137
|
export interface GetDepositAddressRequestUTA {
|
|
121
138
|
currency: string;
|
|
122
139
|
chain?: string;
|
|
@@ -125,7 +142,7 @@ export interface GetDepositAddressRequestUTA {
|
|
|
125
142
|
* Order Endpoints
|
|
126
143
|
*/
|
|
127
144
|
export interface PlaceOrderRequestUTA {
|
|
128
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
145
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
129
146
|
clientOid?: string;
|
|
130
147
|
symbol: string;
|
|
131
148
|
side: 'BUY' | 'SELL';
|
|
@@ -161,17 +178,17 @@ export interface PlaceOrderRequestUTA {
|
|
|
161
178
|
slTriggerPriceType?: 'TP' | 'IP' | 'MP';
|
|
162
179
|
}
|
|
163
180
|
export interface BatchPlaceOrderRequestUTA {
|
|
164
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
181
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
165
182
|
orderList: Omit<PlaceOrderRequestUTA, 'tradeType'>[];
|
|
166
183
|
}
|
|
167
184
|
export interface GetOrderDetailsRequestUTA {
|
|
168
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
185
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
169
186
|
symbol: string;
|
|
170
187
|
orderId?: string;
|
|
171
188
|
clientOid?: string;
|
|
172
189
|
}
|
|
173
190
|
export interface GetOpenOrderListRequestUTA {
|
|
174
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
191
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
175
192
|
symbol?: string;
|
|
176
193
|
orderFilter?: 'NORMAL' | 'CONDITION';
|
|
177
194
|
startAt?: number;
|
|
@@ -180,7 +197,7 @@ export interface GetOpenOrderListRequestUTA {
|
|
|
180
197
|
pageSize?: number;
|
|
181
198
|
}
|
|
182
199
|
export interface GetOrderHistoryRequestUTA {
|
|
183
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
200
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
184
201
|
symbol?: string;
|
|
185
202
|
side?: 'BUY' | 'SELL';
|
|
186
203
|
orderFilter?: 'NORMAL' | 'CONDITION';
|
|
@@ -190,7 +207,7 @@ export interface GetOrderHistoryRequestUTA {
|
|
|
190
207
|
pageSize?: number;
|
|
191
208
|
}
|
|
192
209
|
export interface GetTradeHistoryRequestUTA {
|
|
193
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
210
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
194
211
|
symbol?: string;
|
|
195
212
|
orderId?: string;
|
|
196
213
|
side?: 'BUY' | 'SELL';
|
|
@@ -201,7 +218,7 @@ export interface GetTradeHistoryRequestUTA {
|
|
|
201
218
|
pageSize?: number;
|
|
202
219
|
}
|
|
203
220
|
export interface CancelOrderRequestUTA {
|
|
204
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
221
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
205
222
|
symbol: string;
|
|
206
223
|
orderId?: string;
|
|
207
224
|
clientOid?: string;
|
|
@@ -212,9 +229,16 @@ export interface CancelOrderItemRequestUTA {
|
|
|
212
229
|
clientOid?: string;
|
|
213
230
|
}
|
|
214
231
|
export interface BatchCancelOrdersRequestUTA {
|
|
215
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
232
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
216
233
|
cancelOrderList: CancelOrderItemRequestUTA[];
|
|
217
234
|
}
|
|
235
|
+
/** Batch cancel orders by symbol (POST /order/cancel-all) */
|
|
236
|
+
export interface BatchCancelOrdersBySymbolRequestUTA {
|
|
237
|
+
tradeType: 'SPOT' | 'FUTURES' | 'MARGIN';
|
|
238
|
+
symbol: string;
|
|
239
|
+
marginMode?: 'CROSS' | 'ISOLATED';
|
|
240
|
+
orderFilter?: 'NORMAL' | 'ADVANCED';
|
|
241
|
+
}
|
|
218
242
|
export interface SetDCPRequestUTA {
|
|
219
243
|
tradeType: 'SPOT' | 'FUTURES' | 'MARGIN';
|
|
220
244
|
timeout: number;
|
|
@@ -228,6 +252,33 @@ export interface GetDCPRequestUTA {
|
|
|
228
252
|
*/
|
|
229
253
|
export interface GetPositionListRequestUTA {
|
|
230
254
|
symbol?: string;
|
|
255
|
+
pageNumber?: number;
|
|
256
|
+
pageSize?: number;
|
|
257
|
+
}
|
|
258
|
+
/** Third-party custody (OES) custodian codes */
|
|
259
|
+
export type ThirdPartyCustodyCustodianUTA = 'BITGO_SG' | 'BITGO_SD' | 'CACTUS' | 'CEFFU';
|
|
260
|
+
/**
|
|
261
|
+
* Get Third-Party Custody Currencies (public)
|
|
262
|
+
* Settlement currencies supported per custodian.
|
|
263
|
+
*/
|
|
264
|
+
export interface GetThirdPartyCustodyCurrenciesRequestUTA {
|
|
265
|
+
/** If omitted, returns all custodian rows */
|
|
266
|
+
custodian?: ThirdPartyCustodyCustodianUTA;
|
|
267
|
+
/** If omitted, all currencies for the selected custodian(s) */
|
|
268
|
+
currency?: string;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Get Third-Party Custody Account Currency Limits (private)
|
|
272
|
+
* Remaining OES custody quota per custodian/currency.
|
|
273
|
+
*/
|
|
274
|
+
export interface GetThirdPartyCustodyQuotaRequestUTA {
|
|
275
|
+
/**
|
|
276
|
+
* If sub-account API key is used, this parameter is ignored; only the
|
|
277
|
+
* custodian bound to the sub-account is returned (per API docs).
|
|
278
|
+
*/
|
|
279
|
+
custodian?: ThirdPartyCustodyCustodianUTA;
|
|
280
|
+
/** If omitted, limits for all currencies under the custodian */
|
|
281
|
+
currency?: string;
|
|
231
282
|
}
|
|
232
283
|
export interface GetPositionsHistoryRequestUTA {
|
|
233
284
|
symbol?: string;
|
|
@@ -236,6 +287,14 @@ export interface GetPositionsHistoryRequestUTA {
|
|
|
236
287
|
lastId?: number;
|
|
237
288
|
pageSize?: number;
|
|
238
289
|
}
|
|
290
|
+
/** Settled funding fee history (private) */
|
|
291
|
+
export interface GetPrivateFundingFeeHistoryRequestUTA {
|
|
292
|
+
symbol?: string;
|
|
293
|
+
startAt?: number;
|
|
294
|
+
endAt?: number;
|
|
295
|
+
lastId?: number;
|
|
296
|
+
pageSize?: number;
|
|
297
|
+
}
|
|
239
298
|
export interface GetAccountPositionTiersRequestUTA {
|
|
240
299
|
symbol: string;
|
|
241
300
|
tradeType?: 'FUTURES' | 'MARGIN';
|
|
@@ -37,7 +37,7 @@ export interface BrokerSubAccountApi {
|
|
|
37
37
|
label: string;
|
|
38
38
|
apiKey: string;
|
|
39
39
|
apiVersion: number;
|
|
40
|
-
permissions: ('General' | 'Spot' | 'Futures')[];
|
|
40
|
+
permissions: ('General' | 'Spot' | 'Margin' | 'Futures' | 'InnerTransfer' | 'Transfer' | 'Earn')[];
|
|
41
41
|
ipWhitelist: string[];
|
|
42
42
|
createdAt: number;
|
|
43
43
|
}
|
|
@@ -52,7 +52,8 @@ export interface AccountHFMarginTransactions {
|
|
|
52
52
|
amount: string;
|
|
53
53
|
fee: string;
|
|
54
54
|
balance: string;
|
|
55
|
-
|
|
55
|
+
/** Migrating from MARGIN_V2/ISOLATED_V2 to MARGIN/ISOLATED per SPOT Margin HF migration */
|
|
56
|
+
accountType: 'MARGIN' | 'ISOLATED' | 'MARGIN_V2' | 'ISOLATED_V2';
|
|
56
57
|
bizType: 'TRANSFER' | 'MARGIN_EXCHANGE' | 'ISOLATED_EXCHANGE' | 'LIQUIDATION' | 'ASSERT_RETURN';
|
|
57
58
|
direction: 'out' | 'in';
|
|
58
59
|
createdAt: string;
|
|
@@ -211,4 +212,5 @@ export interface ApiKeyInfo {
|
|
|
211
212
|
createdAt: number;
|
|
212
213
|
expiredAt?: number | null;
|
|
213
214
|
thirdPartyApp?: string;
|
|
215
|
+
siteType?: 'global' | 'turkey' | 'australia' | 'europe' | 'thailand';
|
|
214
216
|
}
|
|
@@ -174,6 +174,12 @@ export interface GetCurrentFundingRateResponseUTA {
|
|
|
174
174
|
fundingTime: number;
|
|
175
175
|
fundingRateCap: number;
|
|
176
176
|
fundingRateFloor: number;
|
|
177
|
+
/** Current funding settlement interval (ms); as of 2026.04.19 */
|
|
178
|
+
currentGranularity: number;
|
|
179
|
+
/** New interval after change (ms); as of 2026.04.19 */
|
|
180
|
+
newGranularity: number;
|
|
181
|
+
/** When newGranularity takes effect (ms); as of 2026.04.19 */
|
|
182
|
+
newGranularityStartTime: number;
|
|
177
183
|
}
|
|
178
184
|
export interface FundingRateHistoryItemUTA {
|
|
179
185
|
fundingRate: number;
|
|
@@ -183,6 +189,43 @@ export interface GetHistoryFundingRateResponseUTA {
|
|
|
183
189
|
symbol: string;
|
|
184
190
|
list: FundingRateHistoryItemUTA[];
|
|
185
191
|
}
|
|
192
|
+
export interface ModifyMarginCrossLeverageResponseUTA {
|
|
193
|
+
currency?: string;
|
|
194
|
+
leverage?: string;
|
|
195
|
+
}
|
|
196
|
+
/** One row from Get Leverage (UTA) — margin uses currency, futures uses symbol */
|
|
197
|
+
export interface GetLeverageItemUTA {
|
|
198
|
+
leverage: string;
|
|
199
|
+
marginMode: string;
|
|
200
|
+
currency?: string;
|
|
201
|
+
symbol?: string;
|
|
202
|
+
}
|
|
203
|
+
export interface PrivateFundingFeeHistoryItemUTA {
|
|
204
|
+
symbol: string;
|
|
205
|
+
marginMode: 'CROSS' | 'ISOLATED';
|
|
206
|
+
fundingRate: string;
|
|
207
|
+
markPrice: string;
|
|
208
|
+
size: string;
|
|
209
|
+
positionValue: string;
|
|
210
|
+
fundingFee: string;
|
|
211
|
+
settleCurrency: string;
|
|
212
|
+
settlementTime: number;
|
|
213
|
+
}
|
|
214
|
+
export interface GetPrivateFundingFeeHistoryResponseUTA {
|
|
215
|
+
lastId: number;
|
|
216
|
+
items: PrivateFundingFeeHistoryItemUTA[];
|
|
217
|
+
}
|
|
218
|
+
export interface GetBorrowingRatesAndLimitsResponseUTA {
|
|
219
|
+
currentRateHourly: string;
|
|
220
|
+
currentRateDaily: string;
|
|
221
|
+
borrowLimitTotal: string;
|
|
222
|
+
borrowLimitTotalHold: string;
|
|
223
|
+
borrowLimitHold: string;
|
|
224
|
+
interestFreeBorrowLimit: string;
|
|
225
|
+
}
|
|
226
|
+
export interface BorrowableCurrencyUTA {
|
|
227
|
+
currency: string;
|
|
228
|
+
}
|
|
186
229
|
export interface GetCrossMarginConfigResponseUTA {
|
|
187
230
|
maxLeverage: number;
|
|
188
231
|
alertRiskRatio: string;
|
|
@@ -203,6 +246,8 @@ export interface AccountCurrencyUTA {
|
|
|
203
246
|
available: string;
|
|
204
247
|
balance: string;
|
|
205
248
|
equity: string;
|
|
249
|
+
/** Potential borrow reserved by open orders (UTA; as of 2026.04.19) */
|
|
250
|
+
potentialBorrow?: string;
|
|
206
251
|
liability?: string;
|
|
207
252
|
totalCrossMargin?: string;
|
|
208
253
|
crossPosMargin?: string;
|
|
@@ -321,7 +366,7 @@ export interface DepositAddressUTA {
|
|
|
321
366
|
* Order Response Types
|
|
322
367
|
*/
|
|
323
368
|
export interface PlaceOrderResponseUTA {
|
|
324
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
369
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
325
370
|
orderId: string;
|
|
326
371
|
clientOid: string;
|
|
327
372
|
/** Timestamp when system completes order request in nanoseconds. Classic mode not supported */
|
|
@@ -339,11 +384,11 @@ export interface BatchPlaceOrderItemResponseUTA {
|
|
|
339
384
|
msg?: string;
|
|
340
385
|
}
|
|
341
386
|
export interface BatchPlaceOrderResponseUTA {
|
|
342
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
387
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
343
388
|
items: BatchPlaceOrderItemResponseUTA[];
|
|
344
389
|
}
|
|
345
390
|
export interface OrderDetailsUTA {
|
|
346
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
391
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
347
392
|
orderId: string;
|
|
348
393
|
clientOid: string;
|
|
349
394
|
/**
|
|
@@ -404,12 +449,12 @@ export interface GetOpenOrderListResponseUTA {
|
|
|
404
449
|
pageSize?: number;
|
|
405
450
|
totalNum?: number;
|
|
406
451
|
totalPage?: number;
|
|
407
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
452
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
408
453
|
items: OrderDetailsUTA[];
|
|
409
454
|
}
|
|
410
455
|
export interface GetOrderHistoryResponseUTA {
|
|
411
456
|
lastId: number;
|
|
412
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
457
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
413
458
|
items: OrderDetailsUTA[];
|
|
414
459
|
}
|
|
415
460
|
export interface TradeHistoryItemUTA {
|
|
@@ -435,11 +480,11 @@ export interface TradeHistoryItemUTA {
|
|
|
435
480
|
}
|
|
436
481
|
export interface GetTradeHistoryResponseUTA {
|
|
437
482
|
lastId: number;
|
|
438
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
483
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
439
484
|
items: TradeHistoryItemUTA[];
|
|
440
485
|
}
|
|
441
486
|
export interface CancelOrderResponseUTA {
|
|
442
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
487
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
443
488
|
orderId?: string;
|
|
444
489
|
clientOid?: string;
|
|
445
490
|
/** Timestamp when system completes order cancellation request (nanoseconds). Only for unified accounts */
|
|
@@ -454,9 +499,26 @@ export interface BatchCancelOrderItemResponseUTA {
|
|
|
454
499
|
ts?: number;
|
|
455
500
|
}
|
|
456
501
|
export interface BatchCancelOrdersResponseUTA {
|
|
457
|
-
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS';
|
|
502
|
+
tradeType: 'SPOT' | 'FUTURES' | 'ISOLATED' | 'CROSS' | 'MARGIN';
|
|
458
503
|
items: BatchCancelOrderItemResponseUTA[];
|
|
459
504
|
}
|
|
505
|
+
/** Batch cancel by symbol - Classic response (orderId list) */
|
|
506
|
+
export interface BatchCancelOrdersBySymbolItemClassicUTA {
|
|
507
|
+
orderId: string;
|
|
508
|
+
}
|
|
509
|
+
/** Batch cancel by symbol - UTA response (full result per order) */
|
|
510
|
+
export interface BatchCancelOrdersBySymbolItemUTA {
|
|
511
|
+
code?: string;
|
|
512
|
+
msg?: string;
|
|
513
|
+
orderId?: string;
|
|
514
|
+
ts?: number;
|
|
515
|
+
clientOid?: string | null;
|
|
516
|
+
}
|
|
517
|
+
export interface BatchCancelOrdersBySymbolResponseUTA {
|
|
518
|
+
tradeType: 'SPOT' | 'FUTURES' | 'MARGIN';
|
|
519
|
+
ts?: number;
|
|
520
|
+
items: BatchCancelOrdersBySymbolItemClassicUTA[] | BatchCancelOrdersBySymbolItemUTA[];
|
|
521
|
+
}
|
|
460
522
|
export interface DCPResponseUTA {
|
|
461
523
|
tradeType: 'SPOT' | 'FUTURES' | 'MARGIN';
|
|
462
524
|
symbol: string[];
|
|
@@ -482,6 +544,8 @@ export interface PositionUTA {
|
|
|
482
544
|
maintenanceMargin: string;
|
|
483
545
|
/** Timestamp when position was first opened (nanoseconds, standardized as of 2026.01.12) */
|
|
484
546
|
creationTime: number;
|
|
547
|
+
/** Estimated liquidation price (as of 2026.04.09) */
|
|
548
|
+
liquidationPrice: string;
|
|
485
549
|
}
|
|
486
550
|
export interface PositionHistoryItemUTA {
|
|
487
551
|
closeId: string;
|
|
@@ -506,6 +570,19 @@ export interface GetPositionsHistoryResponseUTA {
|
|
|
506
570
|
items: PositionHistoryItemUTA[];
|
|
507
571
|
lastId?: number;
|
|
508
572
|
}
|
|
573
|
+
/** Row from Get Third-Party Custody Currencies */
|
|
574
|
+
export interface ThirdPartyCustodyCurrencyUTA {
|
|
575
|
+
custodian: string;
|
|
576
|
+
currency: string;
|
|
577
|
+
precision: number;
|
|
578
|
+
}
|
|
579
|
+
/** Row from Get Third-Party Custody Account Currency Limits */
|
|
580
|
+
export interface ThirdPartyCustodyQuotaUTA {
|
|
581
|
+
custodian: string;
|
|
582
|
+
currency: string;
|
|
583
|
+
/** Remaining custodial quota (shared across custodian sub-accounts under master) */
|
|
584
|
+
custodyQuota: string;
|
|
585
|
+
}
|
|
509
586
|
export interface PositionTierUTA {
|
|
510
587
|
symbol: string;
|
|
511
588
|
tier: number;
|
|
@@ -36,7 +36,7 @@ export declare class BrokerClient extends BaseRestClient {
|
|
|
36
36
|
*
|
|
37
37
|
* This interface supports the creation of Broker sub-account APIKEY.
|
|
38
38
|
* Supports up to 20 IPs in the whitelist.
|
|
39
|
-
*
|
|
39
|
+
* Permissions: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn.
|
|
40
40
|
* Label must be between 4 and 32 characters.
|
|
41
41
|
*/
|
|
42
42
|
createSubAccountApi(params: CreateBrokerSubAccountApiRequest): Promise<APISuccessResponse<CreateBrokerSubAccountApiResponse>>;
|
|
@@ -52,7 +52,7 @@ export declare class BrokerClient extends BaseRestClient {
|
|
|
52
52
|
*
|
|
53
53
|
* This interface supports modifying the Broker's sub-account APIKEY.
|
|
54
54
|
* Supports up to 20 IPs in the whitelist.
|
|
55
|
-
*
|
|
55
|
+
* Permissions: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn.
|
|
56
56
|
* Label must be between 4 and 32 characters.
|
|
57
57
|
*/
|
|
58
58
|
updateSubAccountApi(params: UpdateBrokerSubAccountApiRequest): Promise<APISuccessResponse<BrokerSubAccountApi>>;
|
package/dist/mjs/BrokerClient.js
CHANGED
|
@@ -39,7 +39,7 @@ export class BrokerClient extends BaseRestClient {
|
|
|
39
39
|
*
|
|
40
40
|
* This interface supports the creation of Broker sub-account APIKEY.
|
|
41
41
|
* Supports up to 20 IPs in the whitelist.
|
|
42
|
-
*
|
|
42
|
+
* Permissions: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn.
|
|
43
43
|
* Label must be between 4 and 32 characters.
|
|
44
44
|
*/
|
|
45
45
|
createSubAccountApi(params) {
|
|
@@ -59,7 +59,7 @@ export class BrokerClient extends BaseRestClient {
|
|
|
59
59
|
*
|
|
60
60
|
* This interface supports modifying the Broker's sub-account APIKEY.
|
|
61
61
|
* Supports up to 20 IPs in the whitelist.
|
|
62
|
-
*
|
|
62
|
+
* Permissions: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn.
|
|
63
63
|
* Label must be between 4 and 32 characters.
|
|
64
64
|
*/
|
|
65
65
|
updateSubAccountApi(params) {
|
package/dist/mjs/SpotClient.d.ts
CHANGED
|
@@ -93,13 +93,13 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
93
93
|
/**
|
|
94
94
|
* Get Account - Cross Margin
|
|
95
95
|
*
|
|
96
|
-
* Request
|
|
96
|
+
* Request cross margin account info. Preferred queryType: MARGIN. MARGIN_V2 phased out gradually.
|
|
97
97
|
*/
|
|
98
98
|
getMarginBalance(params?: GetMarginBalanceRequest): Promise<APISuccessResponse<MarginBalance>>;
|
|
99
99
|
/**
|
|
100
100
|
* Get Account - Isolated Margin
|
|
101
101
|
*
|
|
102
|
-
* Request
|
|
102
|
+
* Request isolated margin account info. Preferred queryType: ISOLATED. ISOLATED_V2 phased out gradually.
|
|
103
103
|
*/
|
|
104
104
|
getIsolatedMarginBalance(params?: GetIsolatedMarginBalanceRequest): Promise<APISuccessResponse<IsolatedMarginBalance[]>>;
|
|
105
105
|
/**
|
|
@@ -299,12 +299,14 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
299
299
|
* Get Transfer Quotas
|
|
300
300
|
*
|
|
301
301
|
* This endpoint returns the transferable balance of a specified account.
|
|
302
|
+
* Preferred type: MARGIN, ISOLATED. V2 (MARGIN_V2, ISOLATED_V2) phased out gradually.
|
|
302
303
|
*/
|
|
303
304
|
getTransferable(params: GetTransferableRequest): Promise<APISuccessResponse<TransferableFunds>>;
|
|
304
305
|
/**
|
|
305
306
|
* Flex Transfer
|
|
306
307
|
*
|
|
307
|
-
*
|
|
308
|
+
* Transfers between master/sub accounts and inner transfers.
|
|
309
|
+
* Preferred account types: MARGIN, ISOLATED. For non-INTERNAL type, use MARGIN/ISOLATED (not MARGIN_V2/ISOLATED_V2).
|
|
308
310
|
*/
|
|
309
311
|
submitFlexTransfer(params: FlexTransferRequest): Promise<APISuccessResponse<{
|
|
310
312
|
orderId: string;
|
|
@@ -1501,8 +1503,9 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
1501
1503
|
* DEPRECATED
|
|
1502
1504
|
*/
|
|
1503
1505
|
/**
|
|
1504
|
-
* @deprecated
|
|
1505
|
-
*
|
|
1506
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1507
|
+
* Use getMarginBalance() instead.
|
|
1508
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1506
1509
|
*/
|
|
1507
1510
|
getMarginBalances(): Promise<APISuccessResponse<{
|
|
1508
1511
|
debtRatio: string;
|
|
@@ -1672,13 +1675,15 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
1672
1675
|
* DEPRECATED
|
|
1673
1676
|
*/
|
|
1674
1677
|
/**
|
|
1675
|
-
* @deprecated
|
|
1676
|
-
*
|
|
1678
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1679
|
+
* Use submitHFMarginOrder() instead.
|
|
1680
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1677
1681
|
*/
|
|
1678
1682
|
submitMarginOrder(params: SubmitMarginOrderRequest): Promise<APISuccessResponse<SubmitMarginOrderResponse>>;
|
|
1679
1683
|
/**
|
|
1680
|
-
* @deprecated
|
|
1681
|
-
*
|
|
1684
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1685
|
+
* Use submitHFMarginOrderTest() instead.
|
|
1686
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1682
1687
|
*/
|
|
1683
1688
|
submitMarginOrderTest(): Promise<any>;
|
|
1684
1689
|
/**
|
|
@@ -1687,15 +1692,17 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
1687
1692
|
* DEPRECATED
|
|
1688
1693
|
*/
|
|
1689
1694
|
/**
|
|
1690
|
-
* @deprecated
|
|
1691
|
-
*
|
|
1695
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1696
|
+
* Use getIsolatedMarginBalance() instead.
|
|
1697
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1692
1698
|
*/
|
|
1693
1699
|
getIsolatedMarginAccounts(params?: {
|
|
1694
1700
|
balanceCurrency?: 'USDT' | 'KCS' | 'BTC';
|
|
1695
1701
|
}): Promise<APISuccessResponse<IsolatedMarginAccountInfo>>;
|
|
1696
1702
|
/**
|
|
1697
|
-
* @deprecated
|
|
1698
|
-
*
|
|
1703
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1704
|
+
* Use getIsolatedMarginBalance() instead.
|
|
1705
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1699
1706
|
*/
|
|
1700
1707
|
getIsolatedMarginAccount(params: {
|
|
1701
1708
|
symbol: string;
|
package/dist/mjs/SpotClient.js
CHANGED
|
@@ -129,7 +129,7 @@ export class SpotClient extends BaseRestClient {
|
|
|
129
129
|
/**
|
|
130
130
|
* Get Account - Cross Margin
|
|
131
131
|
*
|
|
132
|
-
* Request
|
|
132
|
+
* Request cross margin account info. Preferred queryType: MARGIN. MARGIN_V2 phased out gradually.
|
|
133
133
|
*/
|
|
134
134
|
getMarginBalance(params) {
|
|
135
135
|
return this.getPrivate('api/v3/margin/accounts', params);
|
|
@@ -137,7 +137,7 @@ export class SpotClient extends BaseRestClient {
|
|
|
137
137
|
/**
|
|
138
138
|
* Get Account - Isolated Margin
|
|
139
139
|
*
|
|
140
|
-
* Request
|
|
140
|
+
* Request isolated margin account info. Preferred queryType: ISOLATED. ISOLATED_V2 phased out gradually.
|
|
141
141
|
*/
|
|
142
142
|
getIsolatedMarginBalance(params) {
|
|
143
143
|
return this.getPrivate('api/v3/isolated/accounts', params);
|
|
@@ -350,6 +350,7 @@ export class SpotClient extends BaseRestClient {
|
|
|
350
350
|
* Get Transfer Quotas
|
|
351
351
|
*
|
|
352
352
|
* This endpoint returns the transferable balance of a specified account.
|
|
353
|
+
* Preferred type: MARGIN, ISOLATED. V2 (MARGIN_V2, ISOLATED_V2) phased out gradually.
|
|
353
354
|
*/
|
|
354
355
|
getTransferable(params) {
|
|
355
356
|
return this.getPrivate('api/v1/accounts/transferable', params);
|
|
@@ -357,7 +358,8 @@ export class SpotClient extends BaseRestClient {
|
|
|
357
358
|
/**
|
|
358
359
|
* Flex Transfer
|
|
359
360
|
*
|
|
360
|
-
*
|
|
361
|
+
* Transfers between master/sub accounts and inner transfers.
|
|
362
|
+
* Preferred account types: MARGIN, ISOLATED. For non-INTERNAL type, use MARGIN/ISOLATED (not MARGIN_V2/ISOLATED_V2).
|
|
361
363
|
*/
|
|
362
364
|
submitFlexTransfer(params) {
|
|
363
365
|
return this.postPrivate('api/v3/accounts/universal-transfer', params);
|
|
@@ -1623,8 +1625,9 @@ export class SpotClient extends BaseRestClient {
|
|
|
1623
1625
|
* DEPRECATED
|
|
1624
1626
|
*/
|
|
1625
1627
|
/**
|
|
1626
|
-
* @deprecated
|
|
1627
|
-
*
|
|
1628
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1629
|
+
* Use getMarginBalance() instead.
|
|
1630
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1628
1631
|
*/
|
|
1629
1632
|
getMarginBalances() {
|
|
1630
1633
|
return this.getPrivate('api/v1/margin/account');
|
|
@@ -1796,15 +1799,17 @@ export class SpotClient extends BaseRestClient {
|
|
|
1796
1799
|
* DEPRECATED
|
|
1797
1800
|
*/
|
|
1798
1801
|
/**
|
|
1799
|
-
* @deprecated
|
|
1800
|
-
*
|
|
1802
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1803
|
+
* Use submitHFMarginOrder() instead.
|
|
1804
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1801
1805
|
*/
|
|
1802
1806
|
submitMarginOrder(params) {
|
|
1803
1807
|
return this.postPrivate('api/v1/margin/order', params);
|
|
1804
1808
|
}
|
|
1805
1809
|
/**
|
|
1806
|
-
* @deprecated
|
|
1807
|
-
*
|
|
1810
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1811
|
+
* Use submitHFMarginOrderTest() instead.
|
|
1812
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1808
1813
|
*/
|
|
1809
1814
|
submitMarginOrderTest() {
|
|
1810
1815
|
return this.postPrivate('api/v1/margin/order/test');
|
|
@@ -1815,15 +1820,17 @@ export class SpotClient extends BaseRestClient {
|
|
|
1815
1820
|
* DEPRECATED
|
|
1816
1821
|
*/
|
|
1817
1822
|
/**
|
|
1818
|
-
* @deprecated
|
|
1819
|
-
*
|
|
1823
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1824
|
+
* Use getIsolatedMarginBalance() instead.
|
|
1825
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1820
1826
|
*/
|
|
1821
1827
|
getIsolatedMarginAccounts(params) {
|
|
1822
1828
|
return this.getPrivate('api/v1/isolated/accounts', params);
|
|
1823
1829
|
}
|
|
1824
1830
|
/**
|
|
1825
|
-
* @deprecated
|
|
1826
|
-
*
|
|
1831
|
+
* @deprecated SPOT Margin LF endpoint no longer available (2026.03.04).
|
|
1832
|
+
* Use getIsolatedMarginBalance() instead.
|
|
1833
|
+
* @see https://www.kucoin.com/announcement/kucoin-margin-notice-250702
|
|
1827
1834
|
*/
|
|
1828
1835
|
getIsolatedMarginAccount(params) {
|
|
1829
1836
|
return this.getPrivate(`api/v1/isolated/account/${params.symbol}`);
|