Class: UnifiedAPIClient
Unified Trading Account REST client for market data, account balances, positions and trading. Use UTA request types and verify the account requirements of each method.
Extends
BaseRestClient
Constructors
Constructor
new UnifiedAPIClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): UnifiedAPIClient;Create an instance of the REST client. Pass API credentials in the object in the first parameter.
Parameters
| Parameter | Type | Description |
|---|---|---|
restClientOptions? | RestClientOptions | options to configure REST API connectivity |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
UnifiedAPIClient
Inherited from
BaseRestClient.constructor
Methods
addSubAccount()
addSubAccount(params: AddSubAccountRequestUTA): Promise<APISuccessResponse<AddSubAccountResponseUTA>>;Add Sub-Account (UTA) Create a sub-account. Added 2026.05.15.
Parameters
| Parameter | Type |
|---|---|
params | AddSubAccountRequestUTA |
Returns
Promise<APISuccessResponse<AddSubAccountResponseUTA>>
addSubAccountApi()
addSubAccountApi(params: AddSubAccountApiRequestUTA): Promise<APISuccessResponse<AddSubAccountApiResponseUTA>>;Add Sub-Account API (UTA) Create an API key for a sub-account. Added 2026.05.15.
Parameters
| Parameter | Type |
|---|---|
params | AddSubAccountApiRequestUTA |
Returns
Promise<APISuccessResponse<AddSubAccountApiResponseUTA>>
amendOrder()
amendOrder(params: AmendOrderRequestUTA): Promise<APISuccessResponse<AmendOrderResponseUTA>>;Amend Order Modify price, size, or TP/SL trigger prices. Futures only. Provide orderId or clientOid.
Parameters
| Parameter | Type |
|---|---|
params | AmendOrderRequestUTA |
Returns
Promise<APISuccessResponse<AmendOrderResponseUTA>>
batchCancelOrders()
batchCancelOrders(params: BatchCancelOrdersRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<BatchCancelOrdersResponseUTA>>;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.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | BatchCancelOrdersRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<BatchCancelOrdersResponseUTA>>
batchCancelOrdersBySymbol()
batchCancelOrdersBySymbol(params: BatchCancelOrdersBySymbolRequestUTA): Promise<APISuccessResponse<BatchCancelOrdersBySymbolResponseUTA>>;Batch Cancel Orders By Symbol Cancels orders in batch by symbol. UTA only. Supports SPOT (non-margin), FUTURES, and MARGIN (Spot-Margin as of 2026.05.15).
Parameters
| Parameter | Type |
|---|---|
params | BatchCancelOrdersBySymbolRequestUTA |
Returns
Promise<APISuccessResponse<BatchCancelOrdersBySymbolResponseUTA>>
batchModifyMarginMode()
batchModifyMarginMode(params: BatchModifyMarginModeRequestUTA): Promise<APISuccessResponse<BatchModifyMarginModeResponseUTA>>;Batch Modify Margin Mode (UTA) Batch modify the margin mode for futures positions.
Parameters
| Parameter | Type |
|---|---|
params | BatchModifyMarginModeRequestUTA |
Returns
Promise<APISuccessResponse<BatchModifyMarginModeResponseUTA>>
batchPlaceOrder()
batchPlaceOrder(params: BatchPlaceOrderRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>;Batch Place Order (Classic) This interface can be used for placing batch orders. URL changed to /api/ua/v2/{accountMode}/order/place-batch as of 2026.01.17. Note: timeInForce supports 'RPI' value for Futures as of 2025.01.02.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | BatchPlaceOrderRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'classic' |
Returns
Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>
cancelOrder()
cancelOrder(params: CancelOrderRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<CancelOrderResponseUTA>>;Cancel Order This interface can be used to cancel orders. Note: ts (timestamp in nanoseconds) only effective for unified account mode.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | CancelOrderRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<CancelOrderResponseUTA>>
cancelWithdrawal()
cancelWithdrawal(params?: object): Promise<APISuccessResponse<string | null>>;Cancel Withdrawal (UTA) Cancel a withdrawal request in PROCESSING status. Added 2026.05.15.
Parameters
| Parameter | Type |
|---|---|
params? | { withdrawalId?: string; } |
params.withdrawalId? | string |
Returns
Promise<APISuccessResponse<string | null>>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
flexTransfer()
flexTransfer(params: FlexTransferRequestUTA): Promise<APISuccessResponse<FlexTransferResponseUTA>>;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.
Parameters
| Parameter | Type |
|---|---|
params | FlexTransferRequestUTA |
Returns
Promise<APISuccessResponse<FlexTransferResponseUTA>>
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
getAccount()
getAccount(): Promise<APISuccessResponse<GetClassicAccountResponseUTA>>;Get Account (UTA) Get information for Unified Trading Account.
Returns
Promise<APISuccessResponse<GetClassicAccountResponseUTA>>
getAccountLedger()
getAccountLedger(params: GetAccountLedgerRequestUTA): Promise<APISuccessResponse<
| GetAccountLedgerResponseUTA
| GetAccountLedgerResponseClassicUTA>>;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. Note: amount is always returned as a positive number as of 2026.04.28; use direction (IN/OUT) to determine flow.
Parameters
| Parameter | Type |
|---|---|
params | GetAccountLedgerRequestUTA |
Returns
Promise<APISuccessResponse< | GetAccountLedgerResponseUTA | GetAccountLedgerResponseClassicUTA>>
getAccountMode()
getAccountMode(): Promise<APISuccessResponse<GetAccountModeResponseUTA>>;Get Account Mode This interface supports query the list of unified and classic sub-accounts and current account mode.
Returns
Promise<APISuccessResponse<GetAccountModeResponseUTA>>
getAccountOverview()
getAccountOverview(): Promise<APISuccessResponse<GetAccountOverviewResponseUTA>>;Get Account Overview (UTA) Get account overview for Unified Trading Account.
Returns
Promise<APISuccessResponse<GetAccountOverviewResponseUTA>>
getAccountPositionTiers()
getAccountPositionTiers(params: GetAccountPositionTiersRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<PositionTierUTA[]>>;Get Account Position Tiers Request account position tiers (risk limit) info. Note: Currently only queries of classic - futures isolated margin are supported.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | GetAccountPositionTiersRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'classic' |
Returns
Promise<APISuccessResponse<PositionTierUTA[]>>
Deprecated
Use getClassicAccountPositionTiers or getUnifiedAccountPositionTiers.
getAllRateLimit()
getAllRateLimit(): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;Get All API Rate Limit (UTA) Query UTA API rate limit for all accounts under the master. Added 2026.06.05.
Returns
Promise<APISuccessResponse<GetRateLimitResponseUTA>>
getAnnouncements()
getAnnouncements(params?: GetAnnouncementsRequestUTA): Promise<APISuccessResponse<GetAnnouncementsResponseUTA>>;Get Announcements This interface can obtain the latest news announcements, and the default page search is for announcements within a month.
Parameters
| Parameter | Type |
|---|---|
params? | GetAnnouncementsRequestUTA |
Returns
Promise<APISuccessResponse<GetAnnouncementsResponseUTA>>
getApiKeyInfo()
getApiKeyInfo(): Promise<APISuccessResponse<ApiKeyInfoUTA>>;Get API Key Info (UTA) Get the API key information for the key used to call this endpoint. Works for both master and sub user API keys. Added 2026.05.15.
Returns
Promise<APISuccessResponse<ApiKeyInfoUTA>>
getBorrowableCurrencies()
getBorrowableCurrencies(): Promise<APISuccessResponse<BorrowableCurrencyUTA[]>>;Get Borrowable Currencies List of borrowable currencies (UTA / public).
Returns
Promise<APISuccessResponse<BorrowableCurrencyUTA[]>>
getBorrowingRatesAndLimits()
getBorrowingRatesAndLimits(params: GetBorrowingRatesAndLimitsRequestUTA): Promise<APISuccessResponse<GetBorrowingRatesAndLimitsResponseUTA>>;Get Borrowing Rates and Limits Hourly/daily rates and borrow limits (UTA).
Parameters
| Parameter | Type |
|---|---|
params | GetBorrowingRatesAndLimitsRequestUTA |
Returns
Promise<APISuccessResponse<GetBorrowingRatesAndLimitsResponseUTA>>
getCallAuctionInfo()
getCallAuctionInfo(params: GetCallAuctionInfoRequestUTA): Promise<APISuccessResponse<GetCallAuctionInfoResponseUTA>>;Get Call Auction Info (UTA) Estimated price/size and bid/ask ranges during call auction. Added 2026.07.17.
Parameters
| Parameter | Type |
|---|---|
params | GetCallAuctionInfoRequestUTA |
Returns
Promise<APISuccessResponse<GetCallAuctionInfoResponseUTA>>
getClassicAccount()
getClassicAccount(params: GetClassicAccountRequestUTA): Promise<APISuccessResponse<GetClassicAccountResponseUTA>>;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.
Parameters
| Parameter | Type |
|---|---|
params | GetClassicAccountRequestUTA |
Returns
Promise<APISuccessResponse<GetClassicAccountResponseUTA>>
getClassicAccountPositionTiers()
getClassicAccountPositionTiers(params: GetAccountPositionTiersRequestUTA): Promise<APISuccessResponse<PositionTierUTA[]>>;Get Classic Account Position Tiers Classic account position tiers (risk limit). Note: Currently only queries of classic - futures isolated margin are supported.
Parameters
| Parameter | Type |
|---|---|
params | GetAccountPositionTiersRequestUTA |
Returns
Promise<APISuccessResponse<PositionTierUTA[]>>
getClassicOpenOrderList()
getClassicOpenOrderList(params: GetOpenOrderListRequestUTA): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;Get Classic Open Order List Open orders on the classic account.
Parameters
| Parameter | Type |
|---|---|
params | GetOpenOrderListRequestUTA |
Returns
Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>
getClassicOrderDetails()
getClassicOrderDetails(params: GetOrderDetailsRequestUTA): Promise<APISuccessResponse<OrderDetailsUTA>>;Get Classic Order Details Single order details on the classic account.
Parameters
| Parameter | Type |
|---|---|
params | GetOrderDetailsRequestUTA |
Returns
Promise<APISuccessResponse<OrderDetailsUTA>>
getClassicOrderHistory()
getClassicOrderHistory(params: GetOrderHistoryRequestUTA): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;Get Classic Order History Order history on the classic account.
Parameters
| Parameter | Type |
|---|---|
params | GetOrderHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>
getClassicTradeHistory()
getClassicTradeHistory(params: GetTradeHistoryRequestUTA): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;Get Classic Trade History Trade execution history on the classic account.
Parameters
| Parameter | Type |
|---|---|
params | GetTradeHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>
getClientIPAddress()
getClientIPAddress(): Promise<APISuccessResponse<string>>;Get Client IP Address Get the client side IP address. Added 2026.07.01.
Returns
Promise<APISuccessResponse<string>>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getCrossMarginConfig()
getCrossMarginConfig(): Promise<APISuccessResponse<GetCrossMarginConfigResponseUTA>>;Get Cross Margin Config Request the configure info of the 'spot cross margin' via this endpoint.
Returns
Promise<APISuccessResponse<GetCrossMarginConfigResponseUTA>>
getCurrencies()
getCurrencies(params?: GetCurrenciesRequestUTA): Promise<APISuccessResponse<GetCurrenciesResponseUTA>>;Get Currencies Currency and chain-level deposit/withdrawal configuration.
Parameters
| Parameter | Type |
|---|---|
params? | GetCurrenciesRequestUTA |
Returns
Promise<APISuccessResponse<GetCurrenciesResponseUTA>>
getCurrency()
getCurrency(params: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;Get Currency Request the currency details of a specified currency via this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | GetCurrencyRequestUTA |
Returns
Promise<APISuccessResponse<GetCurrencyResponseUTA>>
getCurrentFundingRate()
getCurrentFundingRate(params?: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<
| GetCurrentFundingRateResponseUTA
| GetCurrentFundingRateResponseUTA[]>>;Get Current Funding Rate Get current Futures funding fee rate.
Parameters
| Parameter | Type |
|---|---|
params? | GetCurrentFundingRateRequestUTA |
Returns
Promise<APISuccessResponse< | GetCurrentFundingRateResponseUTA | GetCurrentFundingRateResponseUTA[]>>
getDCP()
getDCP(params: GetDCPRequestUTA): 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.
Parameters
| Parameter | Type |
|---|---|
params | GetDCPRequestUTA |
Returns
Promise<APISuccessResponse<DCPResponseUTA>>
getDepositAddress()
getDepositAddress(params: GetDepositAddressRequestUTA): Promise<APISuccessResponse<DepositAddressUTA[]>>;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/v2/asset/deposit/address as of 2026.01.17.
Parameters
| Parameter | Type |
|---|---|
params | GetDepositAddressRequestUTA |
Returns
Promise<APISuccessResponse<DepositAddressUTA[]>>
getDepositHistory()
getDepositHistory(params?: GetDepositHistoryRequestUTA): Promise<APISuccessResponse<GetDepositHistoryResponseUTA>>;Get Deposit History (UTA) Paginated deposit records. Added 2026.08.03.
Parameters
| Parameter | Type |
|---|---|
params? | GetDepositHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetDepositHistoryResponseUTA>>
getFeeRate()
getFeeRate(params: GetFeeRateRequestUTA): Promise<APISuccessResponse<GetFeeRateResponseUTA>>;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.
Parameters
| Parameter | Type |
|---|---|
params | GetFeeRateRequestUTA |
Returns
Promise<APISuccessResponse<GetFeeRateResponseUTA>>
getFiatPrice()
getFiatPrice(params: GetFiatPriceRequestUTA): Promise<APISuccessResponse<GetFiatPriceResponseUTA>>;Get Fiat Price (UTA) Request the fiat price of currencies for available trading pairs. Added 2026.07.01.
Parameters
| Parameter | Type |
|---|---|
params | GetFiatPriceRequestUTA |
Returns
Promise<APISuccessResponse<GetFiatPriceResponseUTA>>
getHistoryFundingRate()
getHistoryFundingRate(params: GetHistoryFundingRateRequestUTA): Promise<APISuccessResponse<GetHistoryFundingRateResponseUTA>>;Get History Funding Rate Query the Futures funding rate at each settlement time point within a certain time range.
Parameters
| Parameter | Type |
|---|---|
params | GetHistoryFundingRateRequestUTA |
Returns
Promise<APISuccessResponse<GetHistoryFundingRateResponseUTA>>
getIndexPrice()
getIndexPrice(params: GetIndexPriceRequestUTA): Promise<APISuccessResponse<GetIndexPriceResponseUTA>>;Get Index Price Index price snapshots (updated once per second).
Parameters
| Parameter | Type |
|---|---|
params | GetIndexPriceRequestUTA |
Returns
Promise<APISuccessResponse<GetIndexPriceResponseUTA>>
getInterestHistory()
getInterestHistory(params: GetInterestHistoryRequestUTA): Promise<APISuccessResponse<GetInterestHistoryResponseUTA>>;Get Interest History (UTA) Request the interest records via this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | GetInterestHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetInterestHistoryResponseUTA>>
getInterestRateIndex()
getInterestRateIndex(params: GetInterestRateIndexRequestUTA): Promise<APISuccessResponse<GetInterestRateIndexResponseUTA>>;Get Interest Rate Index (UTA) Interest rate index records by symbol. Added 2026.07.17.
Parameters
| Parameter | Type |
|---|---|
params | GetInterestRateIndexRequestUTA |
Returns
Promise<APISuccessResponse<GetInterestRateIndexResponseUTA>>
getKlines()
getKlines(params: GetKlinesRequestUTA): Promise<APISuccessResponse<GetKlinesResponseUTA>>;Get Klines Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
Parameters
| Parameter | Type |
|---|---|
params | GetKlinesRequestUTA |
Returns
Promise<APISuccessResponse<GetKlinesResponseUTA>>
getKYCRegions()
getKYCRegions(): Promise<APISuccessResponse<KYCRegionUTA[]>>;Get KYC Regions (UTA) Obtain the list of KYC regions. Added 2026.05.15.
Returns
Promise<APISuccessResponse<KYCRegionUTA[]>>
getLeverage()
getLeverage(params: GetLeverageRequestUTA): Promise<APISuccessResponse<GetLeverageItemUTA[]>>;Get Leverage (UTA) Query leverage for MARGIN (currency) or FUTURES (symbol).
Parameters
| Parameter | Type |
|---|---|
params | GetLeverageRequestUTA |
Returns
Promise<APISuccessResponse<GetLeverageItemUTA[]>>
getOpenOrderList()
getOpenOrderList(params: GetOpenOrderListRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;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.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | GetOpenOrderListRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>
Deprecated
Use getClassicOpenOrderList or getUnifiedOpenOrderList.
getOrderBook()
getOrderBook(params: GetOrderBookRequestUTA): Promise<APISuccessResponse<GetOrderBookResponseUTA>>;Get OrderBook Query order book depth information (aggregated by price).
Parameters
| Parameter | Type |
|---|---|
params | GetOrderBookRequestUTA |
Returns
Promise<APISuccessResponse<GetOrderBookResponseUTA>>
getOrderDetails()
getOrderDetails(params: GetOrderDetailsRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<OrderDetailsUTA>>;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.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | GetOrderDetailsRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<OrderDetailsUTA>>
Deprecated
Use getClassicOrderDetails or getUnifiedOrderDetails.
getOrderHistory()
getOrderHistory(params: GetOrderHistoryRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;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.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | GetOrderHistoryRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>
Deprecated
Use getClassicOrderHistory or getUnifiedOrderHistory.
getPositionList()
getPositionList(params?: GetPositionListRequestUTA): Promise<APISuccessResponse<PositionUTA[]>>;Get Position List (UTA) Get the position details of all open positions. Note: creationTime standardized to nanoseconds as of 2026.01.12. Note: pageNumber, pageSize query params and liquidationPrice in each position (as of 2026.04.09). Note: adlPercentage added 2026.05.15. Note: positionMargin and riskRatio added in latest UTA update.
Parameters
| Parameter | Type |
|---|---|
params? | GetPositionListRequestUTA |
Returns
Promise<APISuccessResponse<PositionUTA[]>>
getPositionsHistory()
getPositionsHistory(params?: GetPositionsHistoryRequestUTA): Promise<APISuccessResponse<GetPositionsHistoryResponseUTA>>;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.
Parameters
| Parameter | Type |
|---|---|
params? | GetPositionsHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetPositionsHistoryResponseUTA>>
getPrivate()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getPrivateFundingFeeHistory()
getPrivateFundingFeeHistory(params?: GetPrivateFundingFeeHistoryRequestUTA): Promise<APISuccessResponse<GetPrivateFundingFeeHistoryResponseUTA>>;Get Private Funding Fee History Settled funding fee records for the current account.
Parameters
| Parameter | Type |
|---|---|
params? | GetPrivateFundingFeeHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetPrivateFundingFeeHistoryResponseUTA>>
getRateLimit()
getRateLimit(params: GetRateLimitRequestUTA): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;Get API Rate Limit (UTA) Query UTA API rate limit for specified UIDs. Added 2026.06.05.
Parameters
| Parameter | Type |
|---|---|
params | GetRateLimitRequestUTA |
Returns
Promise<APISuccessResponse<GetRateLimitResponseUTA>>
getRateLimitCap()
getRateLimitCap(): Promise<APISuccessResponse<GetRateLimitCapResponseUTA>>;Get API Rate Limit Cap (UTA) Query the master account UTA API rate limit cap and allocation. Added 2026.06.05.
Returns
Promise<APISuccessResponse<GetRateLimitCapResponseUTA>>
getServiceStatus()
getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;Get Service Status Get the service status.
Parameters
| Parameter | Type |
|---|---|
params | GetServiceStatusRequestUTA |
Returns
Promise<APISuccessResponse<GetServiceStatusResponseUTA>>
getSubAccount()
getSubAccount(params?: GetSubAccountRequestUTA): Promise<APISuccessResponse<GetSubAccountResponseUTA>>;Get Sub Account Request sub account info via this endpoint.
Parameters
| Parameter | Type |
|---|---|
params? | GetSubAccountRequestUTA |
Returns
Promise<APISuccessResponse<GetSubAccountResponseUTA>>
getSubAccountList()
getSubAccountList(params?: GetSubAccountListRequestUTA): Promise<APISuccessResponse<GetSubAccountListResponseUTA>>;Get Sub-account List (UTA) Paginated list of sub-accounts. Added 2026.08.03.
Parameters
| Parameter | Type |
|---|---|
params? | GetSubAccountListRequestUTA |
Returns
Promise<APISuccessResponse<GetSubAccountListResponseUTA>>
getSymbols()
getSymbols(params: GetSymbolRequestUTA): Promise<APISuccessResponse<GetSymbolResponseUTA>>;Get Symbol Request a list of available currency pairs for trading via this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | GetSymbolRequestUTA |
Returns
Promise<APISuccessResponse<GetSymbolResponseUTA>>
getThirdPartyCustodyCurrencies()
getThirdPartyCustodyCurrencies(params?: GetThirdPartyCustodyCurrenciesRequestUTA): Promise<APISuccessResponse<ThirdPartyCustodyCurrencyUTA[]>>;Get Third-Party Custody Currencies Query settlement currencies supported by third-party (OES) custodian institutions.
Parameters
| Parameter | Type |
|---|---|
params? | GetThirdPartyCustodyCurrenciesRequestUTA |
Returns
Promise<APISuccessResponse<ThirdPartyCustodyCurrencyUTA[]>>
getThirdPartyCustodyQuota()
getThirdPartyCustodyQuota(params?: GetThirdPartyCustodyQuotaRequestUTA): Promise<APISuccessResponse<ThirdPartyCustodyQuotaUTA[]>>;Get Third-Party Custody Account Currency Limits OES remaining custody quota per custodian and settlement currency.
Parameters
| Parameter | Type |
|---|---|
params? | GetThirdPartyCustodyQuotaRequestUTA |
Returns
Promise<APISuccessResponse<ThirdPartyCustodyQuotaUTA[]>>
getTickers()
getTickers(params: GetTickerRequestUTA): Promise<APISuccessResponse<GetTickerResponseUTA>>;Get Ticker Request market tickers for the trading pairs in the market (including 24h volume).
Parameters
| Parameter | Type |
|---|---|
params | GetTickerRequestUTA |
Returns
Promise<APISuccessResponse<GetTickerResponseUTA>>
getTradeHistory()
getTradeHistory(params: GetTradeHistoryRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;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.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | GetTradeHistoryRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>
Deprecated
Use getClassicTradeHistory or getUnifiedTradeHistory.
getTrades()
getTrades(params: GetTradesRequestUTA): Promise<APISuccessResponse<GetTradesResponseUTA>>;Get Trades Request via this endpoint to get the latest 100 public trades of the specified symbol.
Parameters
| Parameter | Type |
|---|---|
params | GetTradesRequestUTA |
Returns
Promise<APISuccessResponse<GetTradesResponseUTA>>
getTradeStatistics()
getTradeStatistics(): Promise<APISuccessResponse<GetTradeStatisticsResponseUTA>>;Platform 24h Market Statistics (UTA) Spot and futures 24h turnover. Added 2026.07.17.
Returns
Promise<APISuccessResponse<GetTradeStatisticsResponseUTA>>
getTransferQuotas()
getTransferQuotas(params: GetTransferQuotasRequestUTA): Promise<APISuccessResponse<GetTransferQuotasResponseUTA>>;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. Note: UNIFIED accountType supported as of latest UTA update.
Parameters
| Parameter | Type |
|---|---|
params | GetTransferQuotasRequestUTA |
Returns
Promise<APISuccessResponse<GetTransferQuotasResponseUTA>>
getUnifiedAccountPositionTiers()
getUnifiedAccountPositionTiers(params: GetAccountPositionTiersRequestUTA): Promise<APISuccessResponse<PositionTierUTA[]>>;Get Unified Account Position Tiers Unified account position tiers (risk limit).
Parameters
| Parameter | Type |
|---|---|
params | GetAccountPositionTiersRequestUTA |
Returns
Promise<APISuccessResponse<PositionTierUTA[]>>
getUnifiedOpenOrderList()
getUnifiedOpenOrderList(params: GetOpenOrderListRequestUTA): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;Get Unified Open Order List Open orders on the unified account.
Parameters
| Parameter | Type |
|---|---|
params | GetOpenOrderListRequestUTA |
Returns
Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>
getUnifiedOrderDetails()
getUnifiedOrderDetails(params: GetOrderDetailsRequestUTA): Promise<APISuccessResponse<OrderDetailsUTA>>;Get Unified Order Details Single order details on the unified account.
Parameters
| Parameter | Type |
|---|---|
params | GetOrderDetailsRequestUTA |
Returns
Promise<APISuccessResponse<OrderDetailsUTA>>
getUnifiedOrderHistory()
getUnifiedOrderHistory(params: GetOrderHistoryRequestUTA): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;Get Unified Order History Order history on the unified account.
Parameters
| Parameter | Type |
|---|---|
params | GetOrderHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>
getUnifiedTradeHistory()
getUnifiedTradeHistory(params: GetTradeHistoryRequestUTA): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;Get Unified Trade History Trade execution history on the unified account.
Parameters
| Parameter | Type |
|---|---|
params | GetTradeHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>
getWithdrawalHistory()
getWithdrawalHistory(params?: GetWithdrawalHistoryRequestUTA): Promise<APISuccessResponse<GetWithdrawalHistoryResponseUTA>>;Get Withdrawal History (UTA) Paginated withdrawal records. Added 2026.08.03.
Parameters
| Parameter | Type |
|---|---|
params? | GetWithdrawalHistoryRequestUTA |
Returns
Promise<APISuccessResponse<GetWithdrawalHistoryResponseUTA>>
getWithdrawalQuotas()
getWithdrawalQuotas(params: GetWithdrawalQuotasRequestUTA): Promise<APISuccessResponse<WithdrawalQuotasUTA>>;Get Withdrawal Quotas (UTA) Obtain withdrawal quota information for a currency. Added 2026.05.15.
Parameters
| Parameter | Type |
|---|---|
params | GetWithdrawalQuotasRequestUTA |
Returns
Promise<APISuccessResponse<WithdrawalQuotasUTA>>
hasAccessToken()
hasAccessToken(): boolean;Returns
boolean
Inherited from
BaseRestClient.hasAccessToken
modifyClassicMarginCrossLeverage()
modifyClassicMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;Modify Classic Leverage Margin Cross Update cross-margin leverage on the classic account.
Parameters
| Parameter | Type |
|---|---|
params | ModifyMarginCrossLeverageRequestUTA |
Returns
Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>
modifyIsolatedFuturesMargin()
modifyIsolatedFuturesMargin(params: ModifyIsolatedFuturesMarginRequestUTA): Promise<APISuccessResponse<ModifyIsolatedFuturesMarginResponseUTA>>;Modify Isolated Futures Margin (UTA) Extract or add margin for an isolated futures position.
Parameters
| Parameter | Type |
|---|---|
params | ModifyIsolatedFuturesMarginRequestUTA |
Returns
Promise<APISuccessResponse<ModifyIsolatedFuturesMarginResponseUTA>>
modifyLeverage()
modifyLeverage(params: ModifyLeverageRequestUTA): Promise<APISuccessResponse<null>>;Modify Leverage (UTA) This interface supports modify leverage of the specified symbol.
Parameters
| Parameter | Type |
|---|---|
params | ModifyLeverageRequestUTA |
Returns
Promise<APISuccessResponse<null>>
modifyMarginCrossLeverage()
modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;Modify Leverage Margin Cross (UTA) Update leverage for a currency in UTA cross margin.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | ModifyMarginCrossLeverageRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>
Deprecated
Use modifyClassicMarginCrossLeverage or modifyUnifiedMarginCrossLeverage.
modifyUnifiedMarginCrossLeverage()
modifyUnifiedMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;Modify Unified Leverage Margin Cross Update cross-margin leverage on the unified account.
Parameters
| Parameter | Type |
|---|---|
params | ModifyMarginCrossLeverageRequestUTA |
Returns
Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>
placeOrder()
placeOrder(params: PlaceOrderRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<PlaceOrderResponseUTA>>;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 is sent in the request body (incl. MARGIN as of 2026.04.19). Note: closeOrder supported for closing futures position by symbol.
Parameters
| Parameter | Type | Default value |
|---|---|---|
params | PlaceOrderRequestUTA | undefined |
accountMode? | "classic" | "unified" | 'unified' |
Returns
Promise<APISuccessResponse<PlaceOrderResponseUTA>>
post()
post(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(
endpoint: string,
params?: any,
internalReqContext?: InternalRequestContext
): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
internalReqContext? | InternalRequestContext |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
setAccessToken()
setAccessToken(newAccessToken: string): void;Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
setAccountMode()
setAccountMode(params: SetAccountModeRequestUTA): Promise<APISuccessResponse<null>>;Set Account Mode This interface supports set account mode to UTA.
Parameters
| Parameter | Type |
|---|---|
params | SetAccountModeRequestUTA |
Returns
Promise<APISuccessResponse<null>>
setDCP()
setDCP(params: SetDCPRequestUTA): Promise<APISuccessResponse<DCPResponseUTA>>;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.
Parameters
| Parameter | Type |
|---|---|
params | SetDCPRequestUTA |
Returns
Promise<APISuccessResponse<DCPResponseUTA>>
setKcsFeeDeduction()
setKcsFeeDeduction(params: SetKcsFeeDeductionRequestUTA): Promise<APISuccessResponse<SetKcsFeeDeductionResponseUTA>>;KCS Fee Deduction Management (UTA) Enable or disable KCS fee deduction. Added 2026.08.03.
Parameters
| Parameter | Type |
|---|---|
params | SetKcsFeeDeductionRequestUTA |
Returns
Promise<APISuccessResponse<SetKcsFeeDeductionResponseUTA>>
setSubAccountsRateLimit()
setSubAccountsRateLimit(params: SetSubAccountsRateLimitRequestUTA): Promise<APISuccessResponse<SetSubAccountsRateLimitResponseUTA>>;Set Sub Accounts API Rate Limit (UTA) Set UTA API rate limits for sub-accounts. Added 2026.06.05.
Parameters
| Parameter | Type |
|---|---|
params | SetSubAccountsRateLimitRequestUTA |
Returns
Promise<APISuccessResponse<SetSubAccountsRateLimitResponseUTA>>
setSubAccountTransferPermission()
setSubAccountTransferPermission(params: SetSubAccountTransferPermissionRequestUTA): Promise<APISuccessResponse<SubAccountTransferPermissionUTA[]>>;Set Sub Account Transfer Permission This endpoint supports setting whether the specified sub-account needs to open the SUB_TO_SUB transfer permission.
Parameters
| Parameter | Type |
|---|---|
params | SetSubAccountTransferPermissionRequestUTA |
Returns
Promise<APISuccessResponse<SubAccountTransferPermissionUTA[]>>
submitWithdraw()
submitWithdraw(params: SubmitWithdrawRequestUTA): Promise<APISuccessResponse<SubmitWithdrawResponseUTA>>;Withdraw (UTA) Withdraw the specified currency. Added 2026.05.15.
Parameters
| Parameter | Type |
|---|---|
params | SubmitWithdrawRequestUTA |
Returns
Promise<APISuccessResponse<SubmitWithdrawResponseUTA>>