kucoin-api 2.5.4 → 2.6.0
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/dist/cjs/UnifiedAPIClient.d.ts +32 -2
- package/dist/cjs/UnifiedAPIClient.js +42 -0
- package/dist/cjs/UnifiedAPIClient.js.map +1 -1
- package/dist/cjs/types/request/uta-types.d.ts +17 -0
- package/dist/cjs/types/response/spot-funding.d.ts +13 -2
- package/dist/cjs/types/response/uta-types.d.ts +37 -1
- package/dist/cjs/types/websockets/ws-events.d.ts +101 -0
- package/dist/mjs/UnifiedAPIClient.d.ts +32 -2
- package/dist/mjs/UnifiedAPIClient.js +42 -0
- package/dist/mjs/UnifiedAPIClient.js.map +1 -1
- package/dist/mjs/types/request/uta-types.d.ts +17 -0
- package/dist/mjs/types/response/spot-funding.d.ts +13 -2
- package/dist/mjs/types/response/uta-types.d.ts +37 -1
- package/dist/mjs/types/websockets/ws-events.d.ts +101 -0
- package/llms.txt +3613 -3286
- package/package.json +1 -1
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
2
2
|
import type { RestClientType } from './lib/requestUtils.js';
|
|
3
|
-
import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetFeeRateRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetServiceStatusRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
|
|
3
|
+
import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetSubAccountsRateLimitRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
|
|
4
4
|
import type { APISuccessResponse } from './types/response/shared.types.js';
|
|
5
|
-
import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetFeeRateResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetServiceStatusResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTransferQuotasResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
5
|
+
import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTransferQuotasResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
6
6
|
/**
|
|
7
7
|
* Unified Trading Account Client
|
|
8
8
|
*
|
|
@@ -82,6 +82,16 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
82
82
|
* Get the service status.
|
|
83
83
|
*/
|
|
84
84
|
getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;
|
|
85
|
+
/**
|
|
86
|
+
* Get Client IP Address
|
|
87
|
+
* Get the client side IP address. Added 2026.07.01.
|
|
88
|
+
*/
|
|
89
|
+
getClientIPAddress(): Promise<APISuccessResponse<string>>;
|
|
90
|
+
/**
|
|
91
|
+
* Get Fiat Price (UTA)
|
|
92
|
+
* Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
|
|
93
|
+
*/
|
|
94
|
+
getFiatPrice(params?: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;
|
|
85
95
|
/**
|
|
86
96
|
*
|
|
87
97
|
* REST - Unified Trading Account - Account
|
|
@@ -197,6 +207,26 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
197
207
|
* Obtain the list of KYC regions. Added 2026.05.15.
|
|
198
208
|
*/
|
|
199
209
|
getKYCRegions(): Promise<APISuccessResponse<KYCRegionUTA[]>>;
|
|
210
|
+
/**
|
|
211
|
+
* Get API Rate Limit (UTA)
|
|
212
|
+
* Query UTA API rate limit for specified UIDs. Added 2026.06.05.
|
|
213
|
+
*/
|
|
214
|
+
getRateLimit(params: GetRateLimitRequestUTA): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;
|
|
215
|
+
/**
|
|
216
|
+
* Get All API Rate Limit (UTA)
|
|
217
|
+
* Query UTA API rate limit for all accounts under the master. Added 2026.06.05.
|
|
218
|
+
*/
|
|
219
|
+
getAllRateLimit(): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;
|
|
220
|
+
/**
|
|
221
|
+
* Get API Rate Limit Cap (UTA)
|
|
222
|
+
* Query the master account UTA API rate limit cap and allocation. Added 2026.06.05.
|
|
223
|
+
*/
|
|
224
|
+
getRateLimitCap(): Promise<APISuccessResponse<GetRateLimitCapResponseUTA>>;
|
|
225
|
+
/**
|
|
226
|
+
* Set Sub Accounts API Rate Limit (UTA)
|
|
227
|
+
* Set UTA API rate limits for sub-accounts. Added 2026.06.05.
|
|
228
|
+
*/
|
|
229
|
+
setSubAccountsRateLimit(params: SetSubAccountsRateLimitRequestUTA): Promise<APISuccessResponse<SetSubAccountsRateLimitResponseUTA>>;
|
|
200
230
|
/**
|
|
201
231
|
* Add Sub-Account (UTA)
|
|
202
232
|
* Create a sub-account. Added 2026.05.15.
|
|
@@ -110,6 +110,20 @@ class UnifiedAPIClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
110
110
|
getServiceStatus(params) {
|
|
111
111
|
return this.get('api/ua/v1/server/status', params);
|
|
112
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
* Get Client IP Address
|
|
115
|
+
* Get the client side IP address. Added 2026.07.01.
|
|
116
|
+
*/
|
|
117
|
+
getClientIPAddress() {
|
|
118
|
+
return this.get('api/ua/v1/user/my-ip');
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Get Fiat Price (UTA)
|
|
122
|
+
* Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
|
|
123
|
+
*/
|
|
124
|
+
getFiatPrice(params) {
|
|
125
|
+
return this.get('api/ua/v1/market/fiat-price', params);
|
|
126
|
+
}
|
|
113
127
|
/**
|
|
114
128
|
*
|
|
115
129
|
* REST - Unified Trading Account - Account
|
|
@@ -263,6 +277,34 @@ class UnifiedAPIClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
263
277
|
getKYCRegions() {
|
|
264
278
|
return this.get('api/ua/v1/user/kyc-region');
|
|
265
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
* Get API Rate Limit (UTA)
|
|
282
|
+
* Query UTA API rate limit for specified UIDs. Added 2026.06.05.
|
|
283
|
+
*/
|
|
284
|
+
getRateLimit(params) {
|
|
285
|
+
return this.getPrivate('api/ua/v1/rate-limit/query', params);
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Get All API Rate Limit (UTA)
|
|
289
|
+
* Query UTA API rate limit for all accounts under the master. Added 2026.06.05.
|
|
290
|
+
*/
|
|
291
|
+
getAllRateLimit() {
|
|
292
|
+
return this.getPrivate('api/ua/v1/rate-limit/query-all');
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Get API Rate Limit Cap (UTA)
|
|
296
|
+
* Query the master account UTA API rate limit cap and allocation. Added 2026.06.05.
|
|
297
|
+
*/
|
|
298
|
+
getRateLimitCap() {
|
|
299
|
+
return this.getPrivate('api/ua/v1/rate-limit/query-cap');
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* Set Sub Accounts API Rate Limit (UTA)
|
|
303
|
+
* Set UTA API rate limits for sub-accounts. Added 2026.06.05.
|
|
304
|
+
*/
|
|
305
|
+
setSubAccountsRateLimit(params) {
|
|
306
|
+
return this.postPrivate('api/ua/v1/rate-limit/set', params);
|
|
307
|
+
}
|
|
266
308
|
/**
|
|
267
309
|
* Add Sub-Account (UTA)
|
|
268
310
|
* Create a sub-account. Added 2026.05.15.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AAKzD,2DAG+B;
|
|
1
|
+
{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AAKzD,2DAG+B;AAgH/B;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,kCAAc;IAClD,aAAa;QACX,OAAO,uCAAqB,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,gBAAgB,CACd,MAAmC;QAEnC,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,8BAA8B,CAC5B,MAAiD;QAEjD,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,UAAU,CACR,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,UAAU,CACR,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAGlB,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,uBAAuB;QAGrB,OAAO,IAAI,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAGhB,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,MAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,+BAA+B,CAC7B,MAAiD;QAEjD,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,UAAU,CACR,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CACd,MAAkC;QAMlC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAChB,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,0BAA0B,CACxB,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA2C,EAC3C,cAAyB,SAAS;QAElC,OAAO,IAAI,CAAC,WAAW,CACrB,aAAa,WAAW,uCAAuC,EAC/D,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,uBAAuB,CACrB,MAAyC;QAEzC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,MAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,mBAAmB,CACjB,MAAqC;QAErC,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,MAEhB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;;;;;;OAQG;IACH,UAAU,CACR,MAA4B,EAC5B,cAAqC,SAAS;QAE9C,MAAM,EAAE,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC5C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,0BAA0B,SAAS,EAAE;YAC/D,CAAC,CAAC,aAAa,WAAW,cAAc,CAAC;QAE7C,MAAM,kBAAkB,GAA2B;YACjD,iBAAiB,EAAE,IAAA,qCAAmB,EAAC,MAAM,CAAC;gBAC5C,CAAC,CAAC,uCAAqB,CAAC,IAAI;gBAC5B,CAAC,CAAC,uCAAqB,CAAC,OAAO;SAClC,CAAC;QAEF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,EACH,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,EAC5B,kBAAkB,CACnB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,gCAAgC,MAAM,CAAC,SAAS,EAAE;YAC5E,CAAC,CAAC,aAAa,WAAW,oBAAoB,CAAC;QAEnD,MAAM,kBAAkB,GAA2B;YACjD,iBAAiB,EAAE,IAAA,qCAAmB,EAAC,MAAM,CAAC;gBAC5C,CAAC,CAAC,uCAAqB,CAAC,IAAI;gBAC5B,CAAC,CAAC,uCAAqB,CAAC,OAAO;SAClC,CAAC;QAEF,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,eAAe,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,MAAkC,EAClC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,MAA6B,EAC7B,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,2BAA2B,MAAM,CAAC,SAAS,EAAE;YACvE,CAAC,CAAC,aAAa,WAAW,eAAe,CAAC;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC,EACnC,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,iCAAiC,MAAM,CAAC,SAAS,EAAE;YAC7E,CAAC,CAAC,aAAa,WAAW,qBAAqB,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA2C;QAE3C,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,MAAwB;QAExB,OAAO,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,MAAwB;QAExB,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;IACH,eAAe,CACb,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,2BAA2B,CACzB,MAA6C;QAE7C,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,2BAA2B,CACzB,MAA8C;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAAyC,EACzC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;CACF;AA5tBD,4CA4tBC"}
|
|
@@ -36,6 +36,23 @@ export interface GetOrderBookRequestUTA {
|
|
|
36
36
|
*/
|
|
37
37
|
rpiFilter?: 0 | 1;
|
|
38
38
|
}
|
|
39
|
+
export interface GetFiatPriceRequestUTA {
|
|
40
|
+
/** Fiat base currency, e.g. USD, EUR. Default USD */
|
|
41
|
+
base?: string;
|
|
42
|
+
/** Comma-separated crypto symbols, e.g. BTC,ETH. Default returns all */
|
|
43
|
+
currencies?: string;
|
|
44
|
+
}
|
|
45
|
+
export interface GetRateLimitRequestUTA {
|
|
46
|
+
/** Comma-separated UIDs to query */
|
|
47
|
+
uids: string;
|
|
48
|
+
}
|
|
49
|
+
export interface SetSubAccountsRateLimitItemUTA {
|
|
50
|
+
uid: string;
|
|
51
|
+
rate: number;
|
|
52
|
+
}
|
|
53
|
+
export interface SetSubAccountsRateLimitRequestUTA {
|
|
54
|
+
list: SetSubAccountsRateLimitItemUTA[];
|
|
55
|
+
}
|
|
39
56
|
export interface GetKlinesRequestUTA {
|
|
40
57
|
tradeType: 'SPOT' | 'FUTURES';
|
|
41
58
|
symbol: string;
|
|
@@ -74,12 +74,16 @@ export interface HistoricalDepositItem {
|
|
|
74
74
|
amount: string;
|
|
75
75
|
walletTxId: string;
|
|
76
76
|
isInner: boolean;
|
|
77
|
-
status:
|
|
77
|
+
status: DepositStatus;
|
|
78
78
|
}
|
|
79
|
+
export type DepositStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE' | 'PRE_SUCCESS' | 'WAIT_TRM_MGT' | 'TRM_MGT_REJECTED' | 'ROLLBACKING' | 'ROLLBACK' | 'WAIT_RISK_MGT' | 'RISK_MGT_REJECTED';
|
|
79
80
|
export interface DepositItem {
|
|
81
|
+
id?: string;
|
|
80
82
|
currency?: string;
|
|
81
83
|
chain?: string;
|
|
82
|
-
status?:
|
|
84
|
+
status?: DepositStatus;
|
|
85
|
+
subStatus?: string | null;
|
|
86
|
+
url?: string | null;
|
|
83
87
|
address?: string;
|
|
84
88
|
memo?: string;
|
|
85
89
|
isInner?: boolean;
|
|
@@ -90,6 +94,13 @@ export interface DepositItem {
|
|
|
90
94
|
updatedAt?: number;
|
|
91
95
|
remark?: string;
|
|
92
96
|
arrears?: boolean;
|
|
97
|
+
needSubmitWht?: boolean | null;
|
|
98
|
+
/** Min number for balance confirmation (as of 2026.07.01) */
|
|
99
|
+
preConfirms?: number;
|
|
100
|
+
/** Confirmation number for balance unlock (as of 2026.07.01) */
|
|
101
|
+
confirms?: number;
|
|
102
|
+
/** Current deposit confirmation number (as of 2026.07.01) */
|
|
103
|
+
currentConfirms?: number;
|
|
93
104
|
}
|
|
94
105
|
export interface Deposits {
|
|
95
106
|
currentPage: number;
|
|
@@ -119,7 +119,17 @@ export interface TickerUTA {
|
|
|
119
119
|
lastPrice: string;
|
|
120
120
|
open: string;
|
|
121
121
|
size: string;
|
|
122
|
-
|
|
122
|
+
/** Absolute price change over 24h (as of 2026.07.01) */
|
|
123
|
+
priceChange?: string;
|
|
124
|
+
/** Relative price change over 24h, e.g. 0.0036 = 0.36% (as of 2026.07.01) */
|
|
125
|
+
priceChangePercent?: string;
|
|
126
|
+
/** Index price (Futures tickers; as of 2026.07.01) */
|
|
127
|
+
indexPrice?: string;
|
|
128
|
+
/** Mark price (Futures tickers; as of 2026.07.01) */
|
|
129
|
+
markPrice?: string;
|
|
130
|
+
}
|
|
131
|
+
/** Fiat prices keyed by currency symbol (UTA Get Fiat Price) */
|
|
132
|
+
export type GetFiatPriceResponseUTA = Record<string, string>;
|
|
123
133
|
export interface GetTickerResponseUTA {
|
|
124
134
|
tradeType: string;
|
|
125
135
|
/** Timestamp in nanoseconds (as of 2026.01.12) */
|
|
@@ -246,6 +256,8 @@ export interface AccountCurrencyUTA {
|
|
|
246
256
|
available: string;
|
|
247
257
|
balance: string;
|
|
248
258
|
equity: string;
|
|
259
|
+
/** Platform-level margin collateral status (as of 2026.07.01) */
|
|
260
|
+
collateralStatus?: string;
|
|
249
261
|
/** Potential borrow reserved by open orders (UTA; as of 2026.04.19) */
|
|
250
262
|
potentialBorrow?: string;
|
|
251
263
|
liability?: string;
|
|
@@ -672,3 +684,27 @@ export interface BatchModifyMarginModeResponseUTA {
|
|
|
672
684
|
export interface ModifyIsolatedFuturesMarginResponseUTA {
|
|
673
685
|
ts: number;
|
|
674
686
|
}
|
|
687
|
+
export interface RateLimitItemUTA {
|
|
688
|
+
uid: string;
|
|
689
|
+
rate: number;
|
|
690
|
+
}
|
|
691
|
+
export interface GetRateLimitResponseUTA {
|
|
692
|
+
list: RateLimitItemUTA[];
|
|
693
|
+
}
|
|
694
|
+
export interface GetRateLimitCapResponseUTA {
|
|
695
|
+
vipLevel: number;
|
|
696
|
+
mainRateLimit: number;
|
|
697
|
+
subRateLimit: number;
|
|
698
|
+
allocatedQuota: number;
|
|
699
|
+
remainingQuota: number;
|
|
700
|
+
defaultQuota: number;
|
|
701
|
+
}
|
|
702
|
+
export interface SetSubAccountsRateLimitResultUTA {
|
|
703
|
+
uid: string;
|
|
704
|
+
rate: number;
|
|
705
|
+
code: string;
|
|
706
|
+
msg: string;
|
|
707
|
+
}
|
|
708
|
+
export interface SetSubAccountsRateLimitResponseUTA {
|
|
709
|
+
items: SetSubAccountsRateLimitResultUTA[];
|
|
710
|
+
}
|
|
@@ -9,3 +9,104 @@ export interface MessageEventLike<TDataType = string> {
|
|
|
9
9
|
data: TDataType;
|
|
10
10
|
}
|
|
11
11
|
export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
|
|
12
|
+
/**
|
|
13
|
+
* UTA WebSocket private balance push (`channel: balance`).
|
|
14
|
+
* Field `cS` added 2026.07.01 (platform-level margin collateral status).
|
|
15
|
+
* @see https://www.kucoin.com/docs-new/3470231w0
|
|
16
|
+
*/
|
|
17
|
+
export interface WsUTABalancePushData {
|
|
18
|
+
U: number | string;
|
|
19
|
+
a: string;
|
|
20
|
+
b: string;
|
|
21
|
+
c: string;
|
|
22
|
+
e?: string;
|
|
23
|
+
h: string;
|
|
24
|
+
l?: string;
|
|
25
|
+
/** Platform-level margin collateral status (UNIFIED balance pushes) */
|
|
26
|
+
cS?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface WsUTABalancePush {
|
|
29
|
+
P: number;
|
|
30
|
+
T: string;
|
|
31
|
+
d: WsUTABalancePushData;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* UTA WebSocket private position push (`channel: position` / `positionAll`).
|
|
35
|
+
* Fields `pM` and `r` added 2026.06.03; `adl` added 2026.05.15.
|
|
36
|
+
* @see https://www.kucoin.com/docs-new/3470233w0
|
|
37
|
+
*/
|
|
38
|
+
export interface WsUTAPositionPushData {
|
|
39
|
+
O?: number;
|
|
40
|
+
U: number;
|
|
41
|
+
l?: string;
|
|
42
|
+
q: string;
|
|
43
|
+
s: string;
|
|
44
|
+
bP?: string;
|
|
45
|
+
eP?: string;
|
|
46
|
+
iM?: string;
|
|
47
|
+
lP?: string;
|
|
48
|
+
mM: string;
|
|
49
|
+
/** Mark price */
|
|
50
|
+
mP?: string;
|
|
51
|
+
pV?: string;
|
|
52
|
+
pi?: string;
|
|
53
|
+
mmr?: string;
|
|
54
|
+
mtM?: string;
|
|
55
|
+
rPL?: string;
|
|
56
|
+
uPL?: string;
|
|
57
|
+
/** Margin occupied by the futures position (as of 2026.06.03) */
|
|
58
|
+
pM?: string;
|
|
59
|
+
/** Isolated futures risk ratio, e.g. 0.65 = 65% (as of 2026.06.03) */
|
|
60
|
+
r?: string;
|
|
61
|
+
/** ADL ranking percentile, e.g. 0.46 = 46% (as of 2026.05.15) */
|
|
62
|
+
adl?: string;
|
|
63
|
+
}
|
|
64
|
+
export interface WsUTAPositionPush {
|
|
65
|
+
P: number;
|
|
66
|
+
T: string;
|
|
67
|
+
d: WsUTAPositionPushData;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* UTA WebSocket public Funding Fee channel (`channel: fundingFee`, FUTURES).
|
|
71
|
+
* Added 2026.07.01.
|
|
72
|
+
*/
|
|
73
|
+
export interface WsUTAFundingFeePublicPush {
|
|
74
|
+
T: string;
|
|
75
|
+
P: number;
|
|
76
|
+
d: {
|
|
77
|
+
s: string;
|
|
78
|
+
fR?: string;
|
|
79
|
+
fT?: number;
|
|
80
|
+
M?: number;
|
|
81
|
+
[key: string]: string | number | boolean | undefined;
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* UTA WebSocket public Mark Price channel (`channel: markPrice`, FUTURES).
|
|
86
|
+
* Added 2026.07.01.
|
|
87
|
+
*/
|
|
88
|
+
export interface WsUTAMarkPricePublicPush {
|
|
89
|
+
T: string;
|
|
90
|
+
P: number;
|
|
91
|
+
d: {
|
|
92
|
+
s: string;
|
|
93
|
+
mP?: string;
|
|
94
|
+
M?: number;
|
|
95
|
+
[key: string]: string | number | boolean | undefined;
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Classic futures WebSocket `/contract/positionAll` funding fee settlement push.
|
|
100
|
+
* `symbol` added to `data` field 2026.07.01.
|
|
101
|
+
* @see https://www.kucoin.com/docs-new/3470088w0
|
|
102
|
+
*/
|
|
103
|
+
export interface WsClassicFuturesFundingFeeSettlement {
|
|
104
|
+
topic: string;
|
|
105
|
+
subject: 'funding.begin' | 'funding.end';
|
|
106
|
+
data: {
|
|
107
|
+
symbol: string;
|
|
108
|
+
fundingTime: number;
|
|
109
|
+
fundingRate: number;
|
|
110
|
+
timestamp: number;
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
2
2
|
import type { RestClientType } from './lib/requestUtils.js';
|
|
3
|
-
import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetFeeRateRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetServiceStatusRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
|
|
3
|
+
import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetSubAccountsRateLimitRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
|
|
4
4
|
import type { APISuccessResponse } from './types/response/shared.types.js';
|
|
5
|
-
import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetFeeRateResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetServiceStatusResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTransferQuotasResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
5
|
+
import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTransferQuotasResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
6
6
|
/**
|
|
7
7
|
* Unified Trading Account Client
|
|
8
8
|
*
|
|
@@ -82,6 +82,16 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
82
82
|
* Get the service status.
|
|
83
83
|
*/
|
|
84
84
|
getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;
|
|
85
|
+
/**
|
|
86
|
+
* Get Client IP Address
|
|
87
|
+
* Get the client side IP address. Added 2026.07.01.
|
|
88
|
+
*/
|
|
89
|
+
getClientIPAddress(): Promise<APISuccessResponse<string>>;
|
|
90
|
+
/**
|
|
91
|
+
* Get Fiat Price (UTA)
|
|
92
|
+
* Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
|
|
93
|
+
*/
|
|
94
|
+
getFiatPrice(params?: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;
|
|
85
95
|
/**
|
|
86
96
|
*
|
|
87
97
|
* REST - Unified Trading Account - Account
|
|
@@ -197,6 +207,26 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
197
207
|
* Obtain the list of KYC regions. Added 2026.05.15.
|
|
198
208
|
*/
|
|
199
209
|
getKYCRegions(): Promise<APISuccessResponse<KYCRegionUTA[]>>;
|
|
210
|
+
/**
|
|
211
|
+
* Get API Rate Limit (UTA)
|
|
212
|
+
* Query UTA API rate limit for specified UIDs. Added 2026.06.05.
|
|
213
|
+
*/
|
|
214
|
+
getRateLimit(params: GetRateLimitRequestUTA): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;
|
|
215
|
+
/**
|
|
216
|
+
* Get All API Rate Limit (UTA)
|
|
217
|
+
* Query UTA API rate limit for all accounts under the master. Added 2026.06.05.
|
|
218
|
+
*/
|
|
219
|
+
getAllRateLimit(): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;
|
|
220
|
+
/**
|
|
221
|
+
* Get API Rate Limit Cap (UTA)
|
|
222
|
+
* Query the master account UTA API rate limit cap and allocation. Added 2026.06.05.
|
|
223
|
+
*/
|
|
224
|
+
getRateLimitCap(): Promise<APISuccessResponse<GetRateLimitCapResponseUTA>>;
|
|
225
|
+
/**
|
|
226
|
+
* Set Sub Accounts API Rate Limit (UTA)
|
|
227
|
+
* Set UTA API rate limits for sub-accounts. Added 2026.06.05.
|
|
228
|
+
*/
|
|
229
|
+
setSubAccountsRateLimit(params: SetSubAccountsRateLimitRequestUTA): Promise<APISuccessResponse<SetSubAccountsRateLimitResponseUTA>>;
|
|
200
230
|
/**
|
|
201
231
|
* Add Sub-Account (UTA)
|
|
202
232
|
* Create a sub-account. Added 2026.05.15.
|
|
@@ -107,6 +107,20 @@ export class UnifiedAPIClient extends BaseRestClient {
|
|
|
107
107
|
getServiceStatus(params) {
|
|
108
108
|
return this.get('api/ua/v1/server/status', params);
|
|
109
109
|
}
|
|
110
|
+
/**
|
|
111
|
+
* Get Client IP Address
|
|
112
|
+
* Get the client side IP address. Added 2026.07.01.
|
|
113
|
+
*/
|
|
114
|
+
getClientIPAddress() {
|
|
115
|
+
return this.get('api/ua/v1/user/my-ip');
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Get Fiat Price (UTA)
|
|
119
|
+
* Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
|
|
120
|
+
*/
|
|
121
|
+
getFiatPrice(params) {
|
|
122
|
+
return this.get('api/ua/v1/market/fiat-price', params);
|
|
123
|
+
}
|
|
110
124
|
/**
|
|
111
125
|
*
|
|
112
126
|
* REST - Unified Trading Account - Account
|
|
@@ -260,6 +274,34 @@ export class UnifiedAPIClient extends BaseRestClient {
|
|
|
260
274
|
getKYCRegions() {
|
|
261
275
|
return this.get('api/ua/v1/user/kyc-region');
|
|
262
276
|
}
|
|
277
|
+
/**
|
|
278
|
+
* Get API Rate Limit (UTA)
|
|
279
|
+
* Query UTA API rate limit for specified UIDs. Added 2026.06.05.
|
|
280
|
+
*/
|
|
281
|
+
getRateLimit(params) {
|
|
282
|
+
return this.getPrivate('api/ua/v1/rate-limit/query', params);
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* Get All API Rate Limit (UTA)
|
|
286
|
+
* Query UTA API rate limit for all accounts under the master. Added 2026.06.05.
|
|
287
|
+
*/
|
|
288
|
+
getAllRateLimit() {
|
|
289
|
+
return this.getPrivate('api/ua/v1/rate-limit/query-all');
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Get API Rate Limit Cap (UTA)
|
|
293
|
+
* Query the master account UTA API rate limit cap and allocation. Added 2026.06.05.
|
|
294
|
+
*/
|
|
295
|
+
getRateLimitCap() {
|
|
296
|
+
return this.getPrivate('api/ua/v1/rate-limit/query-cap');
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* Set Sub Accounts API Rate Limit (UTA)
|
|
300
|
+
* Set UTA API rate limits for sub-accounts. Added 2026.06.05.
|
|
301
|
+
*/
|
|
302
|
+
setSubAccountsRateLimit(params) {
|
|
303
|
+
return this.postPrivate('api/ua/v1/rate-limit/set', params);
|
|
304
|
+
}
|
|
263
305
|
/**
|
|
264
306
|
* Add Sub-Account (UTA)
|
|
265
307
|
* Create a sub-account. Added 2026.05.15.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAKzD,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAKzD,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,uBAAuB,CAAC;AAgH/B;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAClD,aAAa;QACX,OAAO,qBAAqB,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,gBAAgB,CACd,MAAmC;QAEnC,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,8BAA8B,CAC5B,MAAiD;QAEjD,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,UAAU,CACR,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,UAAU,CACR,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAA2B;QAE3B,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAGlB,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,uBAAuB;QAGrB,OAAO,IAAI,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAGhB,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,MAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,+BAA+B,CAC7B,MAAiD;QAEjD,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,UAAU,CACR,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CACd,MAAkC;QAMlC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAChB,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,0BAA0B,CACxB,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA2C,EAC3C,cAAyB,SAAS;QAElC,OAAO,IAAI,CAAC,WAAW,CACrB,aAAa,WAAW,uCAAuC,EAC/D,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,uBAAuB,CACrB,MAAyC;QAEzC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,MAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,mBAAmB,CACjB,MAAqC;QAErC,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,MAEhB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA4C;QAE5C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;;;;;;OAQG;IACH,UAAU,CACR,MAA4B,EAC5B,cAAqC,SAAS;QAE9C,MAAM,EAAE,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;QAC5C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,0BAA0B,SAAS,EAAE;YAC/D,CAAC,CAAC,aAAa,WAAW,cAAc,CAAC;QAE7C,MAAM,kBAAkB,GAA2B;YACjD,iBAAiB,EAAE,mBAAmB,CAAC,MAAM,CAAC;gBAC5C,CAAC,CAAC,qBAAqB,CAAC,IAAI;gBAC5B,CAAC,CAAC,qBAAqB,CAAC,OAAO;SAClC,CAAC;QAEF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,EACH,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,EAC5B,kBAAkB,CACnB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,gCAAgC,MAAM,CAAC,SAAS,EAAE;YAC5E,CAAC,CAAC,aAAa,WAAW,oBAAoB,CAAC;QAEnD,MAAM,kBAAkB,GAA2B;YACjD,iBAAiB,EAAE,mBAAmB,CAAC,MAAM,CAAC;gBAC5C,CAAC,CAAC,qBAAqB,CAAC,IAAI;gBAC5B,CAAC,CAAC,qBAAqB,CAAC,OAAO;SAClC,CAAC;QAEF,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,eAAe,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,MAAkC,EAClC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACb,MAAiC,EACjC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,MAA6B,EAC7B,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,2BAA2B,MAAM,CAAC,SAAS,EAAE;YACvE,CAAC,CAAC,aAAa,WAAW,eAAe,CAAC;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC,EACnC,cAAqC,SAAS;QAE9C,MAAM,GAAG,GACP,WAAW,KAAK,SAAS;YACvB,CAAC,CAAC,aAAa,WAAW,iCAAiC,MAAM,CAAC,SAAS,EAAE;YAC7E,CAAC,CAAC,aAAa,WAAW,qBAAqB,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,yBAAyB,CACvB,MAA2C;QAE3C,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,MAAwB;QAExB,OAAO,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,MAAwB;QAExB,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;IACH,eAAe,CACb,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,2BAA2B,CACzB,MAA6C;QAE7C,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,2BAA2B,CACzB,MAA8C;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAAyC,EACzC,cAAqC,SAAS;QAE9C,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,WAAW,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;CACF"}
|
|
@@ -36,6 +36,23 @@ export interface GetOrderBookRequestUTA {
|
|
|
36
36
|
*/
|
|
37
37
|
rpiFilter?: 0 | 1;
|
|
38
38
|
}
|
|
39
|
+
export interface GetFiatPriceRequestUTA {
|
|
40
|
+
/** Fiat base currency, e.g. USD, EUR. Default USD */
|
|
41
|
+
base?: string;
|
|
42
|
+
/** Comma-separated crypto symbols, e.g. BTC,ETH. Default returns all */
|
|
43
|
+
currencies?: string;
|
|
44
|
+
}
|
|
45
|
+
export interface GetRateLimitRequestUTA {
|
|
46
|
+
/** Comma-separated UIDs to query */
|
|
47
|
+
uids: string;
|
|
48
|
+
}
|
|
49
|
+
export interface SetSubAccountsRateLimitItemUTA {
|
|
50
|
+
uid: string;
|
|
51
|
+
rate: number;
|
|
52
|
+
}
|
|
53
|
+
export interface SetSubAccountsRateLimitRequestUTA {
|
|
54
|
+
list: SetSubAccountsRateLimitItemUTA[];
|
|
55
|
+
}
|
|
39
56
|
export interface GetKlinesRequestUTA {
|
|
40
57
|
tradeType: 'SPOT' | 'FUTURES';
|
|
41
58
|
symbol: string;
|
|
@@ -74,12 +74,16 @@ export interface HistoricalDepositItem {
|
|
|
74
74
|
amount: string;
|
|
75
75
|
walletTxId: string;
|
|
76
76
|
isInner: boolean;
|
|
77
|
-
status:
|
|
77
|
+
status: DepositStatus;
|
|
78
78
|
}
|
|
79
|
+
export type DepositStatus = 'PROCESSING' | 'SUCCESS' | 'FAILURE' | 'PRE_SUCCESS' | 'WAIT_TRM_MGT' | 'TRM_MGT_REJECTED' | 'ROLLBACKING' | 'ROLLBACK' | 'WAIT_RISK_MGT' | 'RISK_MGT_REJECTED';
|
|
79
80
|
export interface DepositItem {
|
|
81
|
+
id?: string;
|
|
80
82
|
currency?: string;
|
|
81
83
|
chain?: string;
|
|
82
|
-
status?:
|
|
84
|
+
status?: DepositStatus;
|
|
85
|
+
subStatus?: string | null;
|
|
86
|
+
url?: string | null;
|
|
83
87
|
address?: string;
|
|
84
88
|
memo?: string;
|
|
85
89
|
isInner?: boolean;
|
|
@@ -90,6 +94,13 @@ export interface DepositItem {
|
|
|
90
94
|
updatedAt?: number;
|
|
91
95
|
remark?: string;
|
|
92
96
|
arrears?: boolean;
|
|
97
|
+
needSubmitWht?: boolean | null;
|
|
98
|
+
/** Min number for balance confirmation (as of 2026.07.01) */
|
|
99
|
+
preConfirms?: number;
|
|
100
|
+
/** Confirmation number for balance unlock (as of 2026.07.01) */
|
|
101
|
+
confirms?: number;
|
|
102
|
+
/** Current deposit confirmation number (as of 2026.07.01) */
|
|
103
|
+
currentConfirms?: number;
|
|
93
104
|
}
|
|
94
105
|
export interface Deposits {
|
|
95
106
|
currentPage: number;
|
|
@@ -119,7 +119,17 @@ export interface TickerUTA {
|
|
|
119
119
|
lastPrice: string;
|
|
120
120
|
open: string;
|
|
121
121
|
size: string;
|
|
122
|
-
|
|
122
|
+
/** Absolute price change over 24h (as of 2026.07.01) */
|
|
123
|
+
priceChange?: string;
|
|
124
|
+
/** Relative price change over 24h, e.g. 0.0036 = 0.36% (as of 2026.07.01) */
|
|
125
|
+
priceChangePercent?: string;
|
|
126
|
+
/** Index price (Futures tickers; as of 2026.07.01) */
|
|
127
|
+
indexPrice?: string;
|
|
128
|
+
/** Mark price (Futures tickers; as of 2026.07.01) */
|
|
129
|
+
markPrice?: string;
|
|
130
|
+
}
|
|
131
|
+
/** Fiat prices keyed by currency symbol (UTA Get Fiat Price) */
|
|
132
|
+
export type GetFiatPriceResponseUTA = Record<string, string>;
|
|
123
133
|
export interface GetTickerResponseUTA {
|
|
124
134
|
tradeType: string;
|
|
125
135
|
/** Timestamp in nanoseconds (as of 2026.01.12) */
|
|
@@ -246,6 +256,8 @@ export interface AccountCurrencyUTA {
|
|
|
246
256
|
available: string;
|
|
247
257
|
balance: string;
|
|
248
258
|
equity: string;
|
|
259
|
+
/** Platform-level margin collateral status (as of 2026.07.01) */
|
|
260
|
+
collateralStatus?: string;
|
|
249
261
|
/** Potential borrow reserved by open orders (UTA; as of 2026.04.19) */
|
|
250
262
|
potentialBorrow?: string;
|
|
251
263
|
liability?: string;
|
|
@@ -672,3 +684,27 @@ export interface BatchModifyMarginModeResponseUTA {
|
|
|
672
684
|
export interface ModifyIsolatedFuturesMarginResponseUTA {
|
|
673
685
|
ts: number;
|
|
674
686
|
}
|
|
687
|
+
export interface RateLimitItemUTA {
|
|
688
|
+
uid: string;
|
|
689
|
+
rate: number;
|
|
690
|
+
}
|
|
691
|
+
export interface GetRateLimitResponseUTA {
|
|
692
|
+
list: RateLimitItemUTA[];
|
|
693
|
+
}
|
|
694
|
+
export interface GetRateLimitCapResponseUTA {
|
|
695
|
+
vipLevel: number;
|
|
696
|
+
mainRateLimit: number;
|
|
697
|
+
subRateLimit: number;
|
|
698
|
+
allocatedQuota: number;
|
|
699
|
+
remainingQuota: number;
|
|
700
|
+
defaultQuota: number;
|
|
701
|
+
}
|
|
702
|
+
export interface SetSubAccountsRateLimitResultUTA {
|
|
703
|
+
uid: string;
|
|
704
|
+
rate: number;
|
|
705
|
+
code: string;
|
|
706
|
+
msg: string;
|
|
707
|
+
}
|
|
708
|
+
export interface SetSubAccountsRateLimitResponseUTA {
|
|
709
|
+
items: SetSubAccountsRateLimitResultUTA[];
|
|
710
|
+
}
|