kucoin-api 2.6.2 → 2.6.4
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 -3
- package/dist/cjs/BrokerClient.d.ts +12 -2
- package/dist/cjs/BrokerClient.js +14 -0
- package/dist/cjs/BrokerClient.js.map +1 -1
- package/dist/cjs/UnifiedAPIClient.d.ts +23 -8
- package/dist/cjs/UnifiedAPIClient.js +104 -71
- package/dist/cjs/UnifiedAPIClient.js.map +1 -1
- package/dist/cjs/types/request/broker.types.d.ts +13 -0
- package/dist/cjs/types/request/uta-types.d.ts +62 -7
- package/dist/cjs/types/response/broker.types.d.ts +21 -0
- package/dist/cjs/types/response/futures.types.d.ts +4 -0
- package/dist/cjs/types/response/spot-trading.d.ts +4 -0
- package/dist/cjs/types/response/uta-types.d.ts +125 -27
- package/dist/cjs/types/websockets/ws-events.d.ts +63 -0
- package/dist/mjs/BrokerClient.d.ts +12 -2
- package/dist/mjs/BrokerClient.js +14 -0
- package/dist/mjs/BrokerClient.js.map +1 -1
- package/dist/mjs/UnifiedAPIClient.d.ts +23 -8
- package/dist/mjs/UnifiedAPIClient.js +104 -71
- package/dist/mjs/UnifiedAPIClient.js.map +1 -1
- package/dist/mjs/types/request/broker.types.d.ts +13 -0
- package/dist/mjs/types/request/uta-types.d.ts +62 -7
- package/dist/mjs/types/response/broker.types.d.ts +21 -0
- package/dist/mjs/types/response/futures.types.d.ts +4 -0
- package/dist/mjs/types/response/spot-trading.d.ts +4 -0
- package/dist/mjs/types/response/uta-types.d.ts +125 -27
- package/dist/mjs/types/websockets/ws-events.d.ts +63 -0
- package/llms.txt +733 -245
- package/package.json +13 -5
package/README.md
CHANGED
|
@@ -19,9 +19,6 @@
|
|
|
19
19
|
|
|
20
20
|
[1]: https://www.npmjs.com/package/kucoin-api
|
|
21
21
|
|
|
22
|
-
> [!TIP]
|
|
23
|
-
> Upcoming change: As part of the Siebly.io brand, this SDK is now hosted under our [Siebly.io GitHub organisation](https://github.com/sieblyio). The migration is seamless and requires no user changes.
|
|
24
|
-
|
|
25
22
|
Updated & performant JavaScript & Node.js SDK for the KuCoin REST APIs and WebSockets:
|
|
26
23
|
|
|
27
24
|
- Professional, robust & performant KuCoin SDK with extensive production use in live trading environments.
|
|
@@ -47,6 +44,7 @@ Updated & performant JavaScript & Node.js SDK for the KuCoin REST APIs and WebSo
|
|
|
47
44
|
- Proxy support via axios integration.
|
|
48
45
|
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
|
|
49
46
|
- QuickStart Guide: [Kucoin JavaScript QuickStart Guide](https://siebly.io/sdk/kucoin/javascript)
|
|
47
|
+
- KuCoin JavaScript Tutorial: [KuCoin JavaScript REST API and WebSocket Tutorial](https://siebly.io/sdk/kucoin/javascript/tutorial)
|
|
50
48
|
|
|
51
49
|
## Table of Contents
|
|
52
50
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
2
2
|
import { RestClientType } from './lib/requestUtils.js';
|
|
3
|
-
import { BrokerTransferRequest, CreateBrokerSubAccountApiRequest, DeleteBrokerSubAccountApiRequest, FastApiWithdrawApplyRequest, GetBrokerDepositListRequest, GetBrokerInfoRequest, GetBrokerSubAccountApisRequest, GetBrokerSubAccountsRequest, UpdateBrokerSubAccountApiRequest } from './types/request/broker.types.js';
|
|
4
|
-
import { BrokerDepositRecord, BrokerInfo, BrokerSubAccountApi, BrokerTransferHistory, BrokerWithdrawalRecord, CreateBrokerSubAccountApiResponse, CreateBrokerSubAccountResponse, FastApiWithdrawApplyResponse, GetBrokerSubAccountsResponse } from './types/response/broker.types.js';
|
|
3
|
+
import { BrokerTransferRequest, CreateBrokerSubAccountApiRequest, DeleteBrokerSubAccountApiRequest, FastApiWithdrawApplyRequest, GetBrokerDepositListRequest, GetBrokerInfoRequest, GetBrokerMarkupFeeRequest, GetBrokerSubAccountApisRequest, GetBrokerSubAccountsRequest, SetBrokerMarkupFeeRequest, UpdateBrokerSubAccountApiRequest } from './types/request/broker.types.js';
|
|
4
|
+
import { BrokerDepositRecord, BrokerInfo, BrokerSubAccountApi, BrokerTransferHistory, BrokerWithdrawalRecord, CreateBrokerSubAccountApiResponse, CreateBrokerSubAccountResponse, FastApiWithdrawApplyResponse, GetBrokerMarkupFeeResponse, GetBrokerSubAccountsResponse, SetBrokerMarkupFeeResponse } from './types/response/broker.types.js';
|
|
5
5
|
import { APISuccessResponse } from './types/response/shared.types.js';
|
|
6
6
|
/**
|
|
7
7
|
*
|
|
@@ -180,4 +180,14 @@ export declare class BrokerClient extends BaseRestClient {
|
|
|
180
180
|
* Initial request returns 2FA factors; resubmit with validation to complete withdrawal.
|
|
181
181
|
*/
|
|
182
182
|
applyFastWithdrawal(params: FastApiWithdrawApplyRequest): Promise<APISuccessResponse<FastApiWithdrawApplyResponse>>;
|
|
183
|
+
/**
|
|
184
|
+
* Set Markup Fee
|
|
185
|
+
* Maker and taker markup must be set together. Both 0 cancels markup.
|
|
186
|
+
*/
|
|
187
|
+
setMarkupFee(params: SetBrokerMarkupFeeRequest): Promise<APISuccessResponse<SetBrokerMarkupFeeResponse>>;
|
|
188
|
+
/**
|
|
189
|
+
* Get Markup Fee
|
|
190
|
+
* Default markup plus optional per-UID items.
|
|
191
|
+
*/
|
|
192
|
+
getMarkupFee(params?: GetBrokerMarkupFeeRequest): Promise<APISuccessResponse<GetBrokerMarkupFeeResponse>>;
|
|
183
193
|
}
|
package/dist/cjs/BrokerClient.js
CHANGED
|
@@ -193,6 +193,20 @@ class BrokerClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
193
193
|
applyFastWithdrawal(params) {
|
|
194
194
|
return this.postPrivate('api/v2/broker/withdrawal', params);
|
|
195
195
|
}
|
|
196
|
+
/**
|
|
197
|
+
* Set Markup Fee
|
|
198
|
+
* Maker and taker markup must be set together. Both 0 cancels markup.
|
|
199
|
+
*/
|
|
200
|
+
setMarkupFee(params) {
|
|
201
|
+
return this.postPrivate('api/v1/broker/nd/mark-up', params);
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Get Markup Fee
|
|
205
|
+
* Default markup plus optional per-UID items.
|
|
206
|
+
*/
|
|
207
|
+
getMarkupFee(params) {
|
|
208
|
+
return this.getPrivate('api/v1/broker/nd/mark-up', params);
|
|
209
|
+
}
|
|
196
210
|
}
|
|
197
211
|
exports.BrokerClient = BrokerClient;
|
|
198
212
|
//# sourceMappingURL=BrokerClient.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BrokerClient.js","sourceRoot":"","sources":["../../src/BrokerClient.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AACzD,2DAA8E;
|
|
1
|
+
{"version":3,"file":"BrokerClient.js","sourceRoot":"","sources":["../../src/BrokerClient.ts"],"names":[],"mappings":";;;AAAA,+DAAyD;AACzD,2DAA8E;AA6B9E;;GAEG;AACH,MAAa,YAAa,SAAQ,kCAAc;IAC9C,aAAa;QACX,OAAO,uCAAqB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,MAEhB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CACjB,MAAwC;QAExC,OAAO,IAAI,CAAC,aAAa,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAA6B;QAK1C,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,kBAAkB,CAAC,MAElB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CACT,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,MAGV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,MAEb;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,MAIf;QAKC,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CACjB,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAlQD,oCAkQC"}
|
|
@@ -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, GetCallAuctionInfoRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetDepositHistoryRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetInterestRateIndexRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountListRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalHistoryRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetKcsFeeDeductionRequestUTA, SetSubAccountsRateLimitRequestUTA, SetSubAccountTransferPermissionRequestUTA, SubmitWithdrawRequestUTA } from './types/request/uta-types.js';
|
|
3
|
+
import type { AddSubAccountApiRequestUTA, AddSubAccountRequestUTA, AmendOrderRequestUTA, BatchCancelOrdersBySymbolRequestUTA, BatchCancelOrdersRequestUTA, BatchModifyMarginModeRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetBorrowingRatesAndLimitsRequestUTA, GetCallAuctionInfoRequestUTA, GetClassicAccountRequestUTA, GetCurrenciesRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetDepositHistoryRequestUTA, GetFeeRateRequestUTA, GetFiatPriceRequestUTA, GetHistoryFundingRateRequestUTA, GetIndexPriceRequestUTA, GetInterestHistoryRequestUTA, GetInterestRateIndexRequestUTA, GetKlinesRequestUTA, GetLeverageRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetPrivateFundingFeeHistoryRequestUTA, GetRateLimitRequestUTA, GetServiceStatusRequestUTA, GetSubAccountListRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetThirdPartyCustodyCurrenciesRequestUTA, GetThirdPartyCustodyQuotaRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, GetWithdrawalHistoryRequestUTA, GetWithdrawalQuotasRequestUTA, ModifyIsolatedFuturesMarginRequestUTA, ModifyLeverageRequestUTA, ModifyMarginCrossLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetKcsFeeDeductionRequestUTA, 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, GetCallAuctionInfoResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetDepositHistoryResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetInterestRateIndexResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountListResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTradeStatisticsResponseUTA, GetTransferQuotasResponseUTA, GetWithdrawalHistoryResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetKcsFeeDeductionResponseUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
5
|
+
import type { AddSubAccountApiResponseUTA, AddSubAccountResponseUTA, AmendOrderResponseUTA, ApiKeyInfoUTA, BatchCancelOrdersBySymbolResponseUTA, BatchCancelOrdersResponseUTA, BatchModifyMarginModeResponseUTA, BatchPlaceOrderResponseUTA, BorrowableCurrencyUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetBorrowingRatesAndLimitsResponseUTA, GetCallAuctionInfoResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrenciesResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetDepositHistoryResponseUTA, GetFeeRateResponseUTA, GetFiatPriceResponseUTA, GetHistoryFundingRateResponseUTA, GetIndexPriceResponseUTA, GetInterestHistoryResponseUTA, GetInterestRateIndexResponseUTA, GetKlinesResponseUTA, GetLeverageItemUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetPrivateFundingFeeHistoryResponseUTA, GetRateLimitCapResponseUTA, GetRateLimitResponseUTA, GetServiceStatusResponseUTA, GetSubAccountListResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTradeStatisticsResponseUTA, GetTransferQuotasResponseUTA, GetWithdrawalHistoryResponseUTA, KYCRegionUTA, ModifyIsolatedFuturesMarginResponseUTA, ModifyMarginCrossLeverageResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SetKcsFeeDeductionResponseUTA, SetSubAccountsRateLimitResponseUTA, SubAccountTransferPermissionUTA, SubmitWithdrawResponseUTA, ThirdPartyCustodyCurrencyUTA, ThirdPartyCustodyQuotaUTA, WithdrawalQuotasUTA } from './types/response/uta-types.js';
|
|
6
6
|
/**
|
|
7
7
|
* Unified Trading Account Client
|
|
8
8
|
*
|
|
@@ -26,7 +26,12 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
26
26
|
* Get Currency
|
|
27
27
|
* Request the currency details of a specified currency via this endpoint.
|
|
28
28
|
*/
|
|
29
|
-
getCurrency(params
|
|
29
|
+
getCurrency(params: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;
|
|
30
|
+
/**
|
|
31
|
+
* Get Currencies
|
|
32
|
+
* Currency and chain-level deposit/withdrawal configuration.
|
|
33
|
+
*/
|
|
34
|
+
getCurrencies(params?: GetCurrenciesRequestUTA): Promise<APISuccessResponse<GetCurrenciesResponseUTA>>;
|
|
30
35
|
/**
|
|
31
36
|
* Get Third-Party Custody Currencies
|
|
32
37
|
* Query settlement currencies supported by third-party (OES) custodian institutions.
|
|
@@ -57,11 +62,16 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
57
62
|
* Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
|
|
58
63
|
*/
|
|
59
64
|
getKlines(params: GetKlinesRequestUTA): Promise<APISuccessResponse<GetKlinesResponseUTA>>;
|
|
65
|
+
/**
|
|
66
|
+
* Get Index Price
|
|
67
|
+
* Index price snapshots (updated once per second).
|
|
68
|
+
*/
|
|
69
|
+
getIndexPrice(params: GetIndexPriceRequestUTA): Promise<APISuccessResponse<GetIndexPriceResponseUTA>>;
|
|
60
70
|
/**
|
|
61
71
|
* Get Current Funding Rate
|
|
62
72
|
* Get current Futures funding fee rate.
|
|
63
73
|
*/
|
|
64
|
-
getCurrentFundingRate(params
|
|
74
|
+
getCurrentFundingRate(params?: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<GetCurrentFundingRateResponseUTA | GetCurrentFundingRateResponseUTA[]>>;
|
|
65
75
|
/**
|
|
66
76
|
* Get History Funding Rate
|
|
67
77
|
* Query the Futures funding rate at each settlement time point within a certain time range.
|
|
@@ -91,7 +101,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
91
101
|
* Get Fiat Price (UTA)
|
|
92
102
|
* Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
|
|
93
103
|
*/
|
|
94
|
-
getFiatPrice(params
|
|
104
|
+
getFiatPrice(params: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;
|
|
95
105
|
/**
|
|
96
106
|
* Get Interest Rate Index (UTA)
|
|
97
107
|
* Interest rate index records by symbol. Added 2026.07.17.
|
|
@@ -203,7 +213,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
203
213
|
* Modify Leverage Margin Cross (UTA)
|
|
204
214
|
* Update leverage for a currency in UTA cross margin.
|
|
205
215
|
*/
|
|
206
|
-
modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: 'unified'): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;
|
|
216
|
+
modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;
|
|
207
217
|
/**
|
|
208
218
|
* Get Leverage (UTA)
|
|
209
219
|
* Query leverage for MARGIN (currency) or FUTURES (symbol).
|
|
@@ -213,7 +223,7 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
213
223
|
* Get Deposit Address
|
|
214
224
|
* Return a deposit address; when both currency and chain are provided,
|
|
215
225
|
* the address will be created if it does not exist.
|
|
216
|
-
* URL unified to GET /api/ua/
|
|
226
|
+
* URL unified to GET /api/ua/v2/asset/deposit/address as of 2026.01.17.
|
|
217
227
|
*/
|
|
218
228
|
getDepositAddress(params: GetDepositAddressRequestUTA): Promise<APISuccessResponse<DepositAddressUTA[]>>;
|
|
219
229
|
/**
|
|
@@ -309,10 +319,15 @@ export declare class UnifiedAPIClient extends BaseRestClient {
|
|
|
309
319
|
* Note: closeOrder supported for closing futures position by symbol.
|
|
310
320
|
*/
|
|
311
321
|
placeOrder(params: PlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<PlaceOrderResponseUTA>>;
|
|
322
|
+
/**
|
|
323
|
+
* Amend Order
|
|
324
|
+
* Modify price, size, or TP/SL trigger prices. Futures only. Provide orderId or clientOid.
|
|
325
|
+
*/
|
|
326
|
+
amendOrder(params: AmendOrderRequestUTA): Promise<APISuccessResponse<AmendOrderResponseUTA>>;
|
|
312
327
|
/**
|
|
313
328
|
* Batch Place Order (Classic)
|
|
314
329
|
* This interface can be used for placing batch orders.
|
|
315
|
-
* URL changed to /api/ua/
|
|
330
|
+
* URL changed to /api/ua/v2/{accountMode}/order/place-batch as of 2026.01.17.
|
|
316
331
|
* Note: timeInForce supports 'RPI' value for Futures as of 2025.01.02.
|
|
317
332
|
*/
|
|
318
333
|
batchPlaceOrder(params: BatchPlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>;
|