kucoin-api 2.3.5 → 2.3.6

package/dist/mjs/UnifiedAPIClient.d.ts

@@ -1,9 +1,9 @@
 import { AxiosRequestConfig } from 'axios';
 import { BaseRestClient } from './lib/BaseRestClient.js';
 import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
-import { GetAnnouncementsRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetHistoryFundingRateRequestUTA, GetKlinesRequestUTA, GetOrderBookRequestUTA, GetServiceStatusRequestUTA, GetSymbolRequestUTA, GetTickerRequestUTA, GetTradesRequestUTA } from './types/request/uta-types.js';
+import { BatchCancelOrdersRequestUTA, BatchPlaceOrderRequestUTA, CancelOrderRequestUTA, FlexTransferRequestUTA, GetAccountLedgerRequestUTA, GetAccountPositionTiersRequestUTA, GetAnnouncementsRequestUTA, GetClassicAccountRequestUTA, GetCurrencyRequestUTA, GetCurrentFundingRateRequestUTA, GetDCPRequestUTA, GetDepositAddressRequestUTA, GetFeeRateRequestUTA, GetHistoryFundingRateRequestUTA, GetInterestHistoryRequestUTA, GetKlinesRequestUTA, GetOpenOrderListRequestUTA, GetOrderBookRequestUTA, GetOrderDetailsRequestUTA, GetOrderHistoryRequestUTA, GetPositionListRequestUTA, GetPositionsHistoryRequestUTA, GetServiceStatusRequestUTA, GetSubAccountRequestUTA, GetSymbolRequestUTA, GetTickerRequestUTA, GetTradeHistoryRequestUTA, GetTradesRequestUTA, GetTransferQuotasRequestUTA, ModifyLeverageRequestUTA, PlaceOrderRequestUTA, SetAccountModeRequestUTA, SetDCPRequestUTA, SetSubAccountTransferPermissionRequestUTA } from './types/request/uta-types.js';
 import { APISuccessResponse } from './types/response/shared.types.js';
-import { GetAnnouncementsResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetHistoryFundingRateResponseUTA, GetKlinesResponseUTA, GetOrderBookResponseUTA, GetServiceStatusResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradesResponseUTA } from './types/response/uta-types.js';
+import { BatchCancelOrdersResponseUTA, BatchPlaceOrderResponseUTA, CancelOrderResponseUTA, DCPResponseUTA, DepositAddressUTA, FlexTransferResponseUTA, GetAccountLedgerResponseClassicUTA, GetAccountLedgerResponseUTA, GetAccountModeResponseUTA, GetAccountOverviewResponseUTA, GetAnnouncementsResponseUTA, GetClassicAccountResponseUTA, GetCrossMarginConfigResponseUTA, GetCurrencyResponseUTA, GetCurrentFundingRateResponseUTA, GetFeeRateResponseUTA, GetHistoryFundingRateResponseUTA, GetInterestHistoryResponseUTA, GetKlinesResponseUTA, GetOpenOrderListResponseUTA, GetOrderBookResponseUTA, GetOrderHistoryResponseUTA, GetPositionsHistoryResponseUTA, GetServiceStatusResponseUTA, GetSubAccountResponseUTA, GetSymbolResponseUTA, GetTickerResponseUTA, GetTradeHistoryResponseUTA, GetTradesResponseUTA, GetTransferQuotasResponseUTA, OrderDetailsUTA, PlaceOrderResponseUTA, PositionTierUTA, PositionUTA, SubAccountTransferPermissionUTA } from './types/response/uta-types.js';
 /**
  * Unified Trading Account Client
  *
@@ -74,4 +74,195 @@ export declare class UnifiedAPIClient extends BaseRestClient {
      * Get the service status.
      */
     getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;
+    /**
+     *
+     * REST - Unified Trading Account - Account
+     *
+     */
+    /**
+     * Get Account (Classic)
+     * Get information for Classic Account (FUNDING, SPOT, FUTURES, CROSS, ISOLATED).
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    getClassicAccount(params: GetClassicAccountRequestUTA): Promise<APISuccessResponse<GetClassicAccountResponseUTA>>;
+    /**
+     * Get Account (UTA)
+     * Get information for Unified Trading Account.
+     */
+    getAccount(): Promise<APISuccessResponse<GetClassicAccountResponseUTA>>;
+    /**
+     * Get Account Overview (UTA)
+     * Get account overview for Unified Trading Account.
+     */
+    getAccountOverview(): Promise<APISuccessResponse<GetAccountOverviewResponseUTA>>;
+    /**
+     * Get Sub Account
+     * Request sub account info via this endpoint.
+     */
+    getSubAccount(params?: GetSubAccountRequestUTA): Promise<APISuccessResponse<GetSubAccountResponseUTA>>;
+    /**
+     * Get Transfer Quotas
+     * This endpoint returns the transferable balance of a specified account.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    getTransferQuotas(params: GetTransferQuotasRequestUTA): Promise<APISuccessResponse<GetTransferQuotasResponseUTA>>;
+    /**
+     * Flex Transfer
+     * This interface can be used for transfers between master- and sub-accounts and transfers.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    flexTransfer(params: FlexTransferRequestUTA): Promise<APISuccessResponse<FlexTransferResponseUTA>>;
+    /**
+     * Set Sub Account Transfer Permission
+     * This endpoint supports setting whether the specified sub-account needs to open the SUB_TO_SUB transfer permission.
+     */
+    setSubAccountTransferPermission(params: SetSubAccountTransferPermissionRequestUTA): Promise<APISuccessResponse<SubAccountTransferPermissionUTA[]>>;
+    /**
+     * Get Account Mode
+     * This interface supports query the list of unified and classic sub-accounts and current account mode.
+     */
+    getAccountMode(): Promise<APISuccessResponse<GetAccountModeResponseUTA>>;
+    /**
+     * Set Account Mode
+     * This interface supports set account mode to UTA.
+     */
+    setAccountMode(params: SetAccountModeRequestUTA): Promise<APISuccessResponse<null>>;
+    /**
+     * Get Fee Rate
+     * This interface is for the trading pair's actual fee rate.
+     * You can inquire about fee rates of 10 trading pairs each time at most for Spot.
+     * Futures only supports 1 symbol at a time.
+     */
+    getFeeRate(params: GetFeeRateRequestUTA): Promise<APISuccessResponse<GetFeeRateResponseUTA>>;
+    /**
+     * Get Account Ledger
+     * This API endpoint returns all transfer (in and out) records and supports multi-coin queries.
+     * The query results are sorted in descending order by createdAt and ID.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     * Note: direction values unified to uppercase IN/OUT as of 2026.01.17.
+     * Note: For Futures - id changed from Number to String, balance/amount changed from Number to String as of 2026.01.17.
+     * Note: ts standardized to nanoseconds as of 2026.01.12.
+     */
+    getAccountLedger(params: GetAccountLedgerRequestUTA): Promise<APISuccessResponse<GetAccountLedgerResponseUTA | GetAccountLedgerResponseClassicUTA>>;
+    /**
+     * Get Interest History (UTA)
+     * Request the interest records via this endpoint.
+     */
+    getInterestHistory(params: GetInterestHistoryRequestUTA): Promise<APISuccessResponse<GetInterestHistoryResponseUTA>>;
+    /**
+     * Modify Leverage (UTA)
+     * This interface supports modify leverage of the specified symbol.
+     */
+    modifyLeverage(params: ModifyLeverageRequestUTA): Promise<APISuccessResponse<null>>;
+    /**
+     * Get Deposit Address
+     * Return a deposit address; when both currency and chain are provided,
+     * the address will be created if it does not exist.
+     * URL unified to GET /api/ua/v1/asset/deposit/address as of 2026.01.17.
+     */
+    getDepositAddress(params: GetDepositAddressRequestUTA): Promise<APISuccessResponse<DepositAddressUTA[]>>;
+    /**
+     *
+     * REST - Unified Trading Account - Orders
+     *
+     */
+    /**
+     * Place Order
+     * This interface can be used to place orders.
+     * Supports RPI (Retail Price Improvement) orders for Futures as of 2025.01.02.
+     * Note: timeInForce supports 'RPI' value for Futures only (Phase 1).
+     * Note: For Classic mode, tradeType is required in query param.
+     * Note: For Unified mode, tradeType should not be in query param.
+     */
+    placeOrder(params: PlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<PlaceOrderResponseUTA>>;
+    /**
+     * Batch Place Order (Classic)
+     * This interface can be used for placing batch orders.
+     * URL changed to /api/ua/v1/{accountMode}/order/place-batch as of 2026.01.17.
+     * Note: timeInForce supports 'RPI' value for Futures as of 2025.01.02.
+     */
+    batchPlaceOrder(params: BatchPlaceOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>;
+    /**
+     * Get Order Details
+     * This interface can be used getting single order details.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOrderDetails(params: GetOrderDetailsRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<OrderDetailsUTA>>;
+    /**
+     * Get Open Order List
+     * This interface can be used getting open order list.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOpenOrderList(params: GetOpenOrderListRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;
+    /**
+     * Get Order History
+     * This interface can be used for getting order history.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOrderHistory(params: GetOrderHistoryRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;
+    /**
+     * Get Trade History
+     * This interface can be used for getting trade execution history.
+     * Note: executionTime standardized to nanoseconds as of 2026.01.12.
+     * Note: isRpiTrade added for Futures as of 2025.01.02.
+     */
+    getTradeHistory(params: GetTradeHistoryRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;
+    /**
+     * Cancel Order
+     * This interface can be used to cancel orders.
+     * Note: ts (timestamp in nanoseconds) only effective for unified account mode.
+     */
+    cancelOrder(params: CancelOrderRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<CancelOrderResponseUTA>>;
+    /**
+     * Batch Cancel Orders
+     * This interface can be used for batch cancel orders (maximum 20 orders).
+     * Note: tradeType required for Classic accounts only; ignored in UTA (UNIFIED) mode.
+     * Note: ts (timestamp in nanoseconds) not supported for classic accounts.
+     */
+    batchCancelOrders(params: BatchCancelOrdersRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<BatchCancelOrdersResponseUTA>>;
+    /**
+     * Set DCP (Disconnection Protect / Deadman Switch) - Classic Only
+     * Set automatic order cancellation after specified time.
+     * Call this interface to automatically cancel all orders of the set trading pair after the specified time.
+     * Note: Order cancellation delay is between 0 and 10 seconds.
+     * Note: timeout range: -1 (unset) or 5 <= timeout <= 86400 seconds.
+     */
+    setDCP(params: SetDCPRequestUTA): Promise<APISuccessResponse<DCPResponseUTA>>;
+    /**
+     * Get DCP (Disconnection Protect / Deadman Switch) - Classic Only
+     * Get automatic order cancellation settings.
+     * If data is empty, it means DCP is not set.
+     */
+    getDCP(params: GetDCPRequestUTA): Promise<APISuccessResponse<DCPResponseUTA>>;
+    /**
+     *
+     * REST - Unified Trading Account - Positions
+     *
+     */
+    /**
+     * Get Position List (UTA)
+     * Get the position details of all open positions.
+     * Note: creationTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getPositionList(params?: GetPositionListRequestUTA): Promise<APISuccessResponse<PositionUTA[]>>;
+    /**
+     * Get Positions History (UTA)
+     * Query position history information records.
+     * Note: Data retained for up to 3 months.
+     * Note: Each query limited to 7 days time range.
+     * Note: creationTime and closingTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getPositionsHistory(params?: GetPositionsHistoryRequestUTA): Promise<APISuccessResponse<GetPositionsHistoryResponseUTA>>;
+    /**
+     * Get Account Position Tiers
+     * Request account position tiers (risk limit) info.
+     * Note: Currently only queries of classic - futures isolated margin are supported.
+     */
+    getAccountPositionTiers(params: GetAccountPositionTiersRequestUTA, accountMode?: 'classic' | 'unified'): Promise<APISuccessResponse<PositionTierUTA[]>>;
 }

package/dist/mjs/UnifiedAPIClient.js

@@ -97,5 +97,263 @@ export class UnifiedAPIClient extends BaseRestClient {
     getServiceStatus(params) {
         return this.get('api/ua/v1/server/status', params);
     }
+    /**
+     *
+     * REST - Unified Trading Account - Account
+     *
+     */
+    /**
+     * Get Account (Classic)
+     * Get information for Classic Account (FUNDING, SPOT, FUTURES, CROSS, ISOLATED).
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    getClassicAccount(params) {
+        return this.getPrivate('api/ua/v1/account/balance', params);
+    }
+    /**
+     * Get Account (UTA)
+     * Get information for Unified Trading Account.
+     */
+    getAccount() {
+        return this.getPrivate('api/ua/v1/unified/account/balance');
+    }
+    /**
+     * Get Account Overview (UTA)
+     * Get account overview for Unified Trading Account.
+     */
+    getAccountOverview() {
+        return this.getPrivate('api/ua/v1/unified/account/overview');
+    }
+    /**
+     * Get Sub Account
+     * Request sub account info via this endpoint.
+     */
+    getSubAccount(params) {
+        return this.getPrivate('api/ua/v1/sub-account/balance', params);
+    }
+    /**
+     * Get Transfer Quotas
+     * This endpoint returns the transferable balance of a specified account.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    getTransferQuotas(params) {
+        return this.getPrivate('api/ua/v1/account/transfer-quota', params);
+    }
+    /**
+     * Flex Transfer
+     * This interface can be used for transfers between master- and sub-accounts and transfers.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     */
+    flexTransfer(params) {
+        return this.postPrivate('api/ua/v1/account/transfer', params);
+    }
+    /**
+     * Set Sub Account Transfer Permission
+     * This endpoint supports setting whether the specified sub-account needs to open the SUB_TO_SUB transfer permission.
+     */
+    setSubAccountTransferPermission(params) {
+        return this.postPrivate('api/ua/v1/sub-account/canTransferOut', params);
+    }
+    /**
+     * Get Account Mode
+     * This interface supports query the list of unified and classic sub-accounts and current account mode.
+     */
+    getAccountMode() {
+        return this.getPrivate('api/ua/v1/account/mode');
+    }
+    /**
+     * Set Account Mode
+     * This interface supports set account mode to UTA.
+     */
+    setAccountMode(params) {
+        return this.postPrivate('api/ua/v1/account/mode', params);
+    }
+    /**
+     * Get Fee Rate
+     * This interface is for the trading pair's actual fee rate.
+     * You can inquire about fee rates of 10 trading pairs each time at most for Spot.
+     * Futures only supports 1 symbol at a time.
+     */
+    getFeeRate(params) {
+        return this.getPrivate('api/ua/v1/user/fee-rate', params);
+    }
+    /**
+     * Get Account Ledger
+     * This API endpoint returns all transfer (in and out) records and supports multi-coin queries.
+     * The query results are sorted in descending order by createdAt and ID.
+     * Note: AccountType enum value changed from TRADING to SPOT as of 2026.01.17.
+     * Note: direction values unified to uppercase IN/OUT as of 2026.01.17.
+     * Note: For Futures - id changed from Number to String, balance/amount changed from Number to String as of 2026.01.17.
+     * Note: ts standardized to nanoseconds as of 2026.01.12.
+     */
+    getAccountLedger(params) {
+        return this.getPrivate('api/ua/v1/account/ledger', params);
+    }
+    /**
+     * Get Interest History (UTA)
+     * Request the interest records via this endpoint.
+     */
+    getInterestHistory(params) {
+        return this.getPrivate('api/ua/v1/account/interest-history', params);
+    }
+    /**
+     * Modify Leverage (UTA)
+     * This interface supports modify leverage of the specified symbol.
+     */
+    modifyLeverage(params) {
+        return this.postPrivate('api/ua/v1/unified/account/modify-leverage', params);
+    }
+    /**
+     * Get Deposit Address
+     * Return a deposit address; when both currency and chain are provided,
+     * the address will be created if it does not exist.
+     * URL unified to GET /api/ua/v1/asset/deposit/address as of 2026.01.17.
+     */
+    getDepositAddress(params) {
+        return this.getPrivate('api/ua/v1/asset/deposit/address', params);
+    }
+    /**
+     *
+     * REST - Unified Trading Account - Orders
+     *
+     */
+    /**
+     * Place Order
+     * This interface can be used to place orders.
+     * Supports RPI (Retail Price Improvement) orders for Futures as of 2025.01.02.
+     * Note: timeInForce supports 'RPI' value for Futures only (Phase 1).
+     * Note: For Classic mode, tradeType is required in query param.
+     * Note: For Unified mode, tradeType should not be in query param.
+     */
+    placeOrder(params, accountMode = 'unified') {
+        const { tradeType, ...bodyParams } = params;
+        const url = accountMode === 'classic'
+            ? `api/ua/v1/${accountMode}/order/place?tradeType=${tradeType}`
+            : `api/ua/v1/${accountMode}/order/place`;
+        return this.postPrivate(url, bodyParams);
+    }
+    /**
+     * Batch Place Order (Classic)
+     * This interface can be used for placing batch orders.
+     * URL changed to /api/ua/v1/{accountMode}/order/place-batch as of 2026.01.17.
+     * Note: timeInForce supports 'RPI' value for Futures as of 2025.01.02.
+     */
+    batchPlaceOrder(params, accountMode = 'classic') {
+        const url = accountMode === 'classic'
+            ? `api/ua/v1/${accountMode}/order/place-batch?tradeType=${params.tradeType}`
+            : `api/ua/v1/${accountMode}/order/place-batch`;
+        return this.postPrivate(url, params);
+    }
+    /**
+     * Get Order Details
+     * This interface can be used getting single order details.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOrderDetails(params, accountMode = 'unified') {
+        return this.getPrivate(`api/ua/v1/${accountMode}/order/detail`, params);
+    }
+    /**
+     * Get Open Order List
+     * This interface can be used getting open order list.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOpenOrderList(params, accountMode = 'unified') {
+        return this.getPrivate(`api/ua/v1/${accountMode}/order/open-list`, params);
+    }
+    /**
+     * Get Order History
+     * This interface can be used for getting order history.
+     * Note: timeInForce returns 'RPI' value for Futures RPI orders as of 2025.01.02.
+     * Note: status changed from String to Number for UTA as of 2026.01.17.
+     * Note: orderTime/updatedTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getOrderHistory(params, accountMode = 'unified') {
+        return this.getPrivate(`api/ua/v1/${accountMode}/order/history`, params);
+    }
+    /**
+     * Get Trade History
+     * This interface can be used for getting trade execution history.
+     * Note: executionTime standardized to nanoseconds as of 2026.01.12.
+     * Note: isRpiTrade added for Futures as of 2025.01.02.
+     */
+    getTradeHistory(params, accountMode = 'unified') {
+        return this.getPrivate(`api/ua/v1/${accountMode}/order/execution`, params);
+    }
+    /**
+     * Cancel Order
+     * This interface can be used to cancel orders.
+     * Note: ts (timestamp in nanoseconds) only effective for unified account mode.
+     */
+    cancelOrder(params, accountMode = 'unified') {
+        const url = accountMode === 'classic'
+            ? `api/ua/v1/${accountMode}/order/cancel?tradeType=${params.tradeType}`
+            : `api/ua/v1/${accountMode}/order/cancel`;
+        return this.postPrivate(url, params);
+    }
+    /**
+     * Batch Cancel Orders
+     * This interface can be used for batch cancel orders (maximum 20 orders).
+     * Note: tradeType required for Classic accounts only; ignored in UTA (UNIFIED) mode.
+     * Note: ts (timestamp in nanoseconds) not supported for classic accounts.
+     */
+    batchCancelOrders(params, accountMode = 'unified') {
+        const url = accountMode === 'classic'
+            ? `api/ua/v1/${accountMode}/order/cancel-batch?tradeType=${params.tradeType}`
+            : `api/ua/v1/${accountMode}/order/cancel-batch`;
+        return this.postPrivate(url, params);
+    }
+    /**
+     * Set DCP (Disconnection Protect / Deadman Switch) - Classic Only
+     * Set automatic order cancellation after specified time.
+     * Call this interface to automatically cancel all orders of the set trading pair after the specified time.
+     * Note: Order cancellation delay is between 0 and 10 seconds.
+     * Note: timeout range: -1 (unset) or 5 <= timeout <= 86400 seconds.
+     */
+    setDCP(params) {
+        return this.postPrivate('api/ua/v1/dcp/set', params);
+    }
+    /**
+     * Get DCP (Disconnection Protect / Deadman Switch) - Classic Only
+     * Get automatic order cancellation settings.
+     * If data is empty, it means DCP is not set.
+     */
+    getDCP(params) {
+        return this.getPrivate('api/ua/v1/dcp/query', params);
+    }
+    /**
+     *
+     * REST - Unified Trading Account - Positions
+     *
+     */
+    /**
+     * Get Position List (UTA)
+     * Get the position details of all open positions.
+     * Note: creationTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getPositionList(params) {
+        return this.getPrivate('api/ua/v1/unified/position/open-list', params);
+    }
+    /**
+     * Get Positions History (UTA)
+     * Query position history information records.
+     * Note: Data retained for up to 3 months.
+     * Note: Each query limited to 7 days time range.
+     * Note: creationTime and closingTime standardized to nanoseconds as of 2026.01.12.
+     */
+    getPositionsHistory(params) {
+        return this.getPrivate('api/ua/v1/position/history', params);
+    }
+    /**
+     * Get Account Position Tiers
+     * Request account position tiers (risk limit) info.
+     * Note: Currently only queries of classic - futures isolated margin are supported.
+     */
+    getAccountPositionTiers(params, accountMode = 'classic') {
+        return this.getPrivate(`api/ua/v1/${accountMode}/position/tiers`, params);
+    }
 }
 //# sourceMappingURL=UnifiedAPIClient.js.map

package/dist/mjs/UnifiedAPIClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AA4B/B;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAClD,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,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,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,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;CACF"}
+{"version":3,"file":"UnifiedAPIClient.js","sourceRoot":"","sources":["../../src/UnifiedAPIClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AA4E/B;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAClD,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,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,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,gBAAgB,CACd,MAAkC;QAElC,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACrD,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;;;;OAIG;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;;;;;;;;OAQG;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,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;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;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAC3C,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;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvC,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;;;;;;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;;;;OAIG;IACH,eAAe,CACb,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,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"}

package/dist/mjs/types/request/futures.types.d.ts

@@ -110,7 +110,13 @@ export interface Order {
     size?: number;
     qty?: string;
     valueQty?: string;
-    timeInForce?: 'GTC' | 'IOC';
+    /**
+     * Time in Force. Added 'RPI' as of 2025.01.02
+     * - GTC: Good Till Cancel (default)
+     * - IOC: Immediate Or Cancel
+     * - RPI: Retail Price Improvement Order (Phase 1: Futures only)
+     */
+    timeInForce?: 'GTC' | 'IOC' | 'RPI';
     postOnly?: boolean;
     hidden?: boolean;
     iceberg?: boolean;
@@ -136,7 +142,13 @@ export interface SLTPOrder {
     size?: number;
     qty?: string;
     valueQty?: string;
-    timeInForce?: 'GTC' | 'IOC';
+    /**
+     * Time in Force. Added 'RPI' as of 2025.01.02
+     * - GTC: Good Till Cancel (default)
+     * - IOC: Immediate Or Cancel
+     * - RPI: Retail Price Improvement Order (Phase 1: Futures only)
+     */
+    timeInForce?: 'GTC' | 'IOC' | 'RPI';
     postOnly?: boolean;
     hidden?: boolean;
     iceberg?: boolean;
@@ -240,7 +252,13 @@ export interface CopyTradeOrderRequest {
     positionSide?: 'BOTH' | 'LONG' | 'SHORT';
     price?: string;
     size: number;
-    timeInForce?: 'GTC' | 'IOC';
+    /**
+     * Time in Force. Added 'RPI' as of 2025.01.02
+     * - GTC: Good Till Cancel (default)
+     * - IOC: Immediate Or Cancel
+     * - RPI: Retail Price Improvement Order (Phase 1: Futures only)
+     */
+    timeInForce?: 'GTC' | 'IOC' | 'RPI';
     postOnly?: boolean;
     hidden?: boolean;
     iceberg?: boolean;