Skip to content

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 ​

ts
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 ​

ParameterTypeDescription
restClientOptions?RestClientOptionsoptions to configure REST API connectivity
networkOptions?AxiosRequestConfigHTTP networking options for axios

Returns ​

UnifiedAPIClient

Inherited from ​

BaseRestClient.constructor

Methods ​

addSubAccount() ​

ts
addSubAccount(params: AddSubAccountRequestUTA): Promise<APISuccessResponse<AddSubAccountResponseUTA>>;

Add Sub-Account (UTA) Create a sub-account. Added 2026.05.15.

Parameters ​

ParameterType
paramsAddSubAccountRequestUTA

Returns ​

Promise<APISuccessResponse<AddSubAccountResponseUTA>>


addSubAccountApi() ​

ts
addSubAccountApi(params: AddSubAccountApiRequestUTA): Promise<APISuccessResponse<AddSubAccountApiResponseUTA>>;

Add Sub-Account API (UTA) Create an API key for a sub-account. Added 2026.05.15.

Parameters ​

ParameterType
paramsAddSubAccountApiRequestUTA

Returns ​

Promise<APISuccessResponse<AddSubAccountApiResponseUTA>>


amendOrder() ​

ts
amendOrder(params: AmendOrderRequestUTA): Promise<APISuccessResponse<AmendOrderResponseUTA>>;

Amend Order Modify price, size, or TP/SL trigger prices. Futures only. Provide orderId or clientOid.

Parameters ​

ParameterType
paramsAmendOrderRequestUTA

Returns ​

Promise<APISuccessResponse<AmendOrderResponseUTA>>


batchCancelOrders() ​

ts
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 ​

ParameterTypeDefault value
paramsBatchCancelOrdersRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<BatchCancelOrdersResponseUTA>>


batchCancelOrdersBySymbol() ​

ts
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 ​

ParameterType
paramsBatchCancelOrdersBySymbolRequestUTA

Returns ​

Promise<APISuccessResponse<BatchCancelOrdersBySymbolResponseUTA>>


batchModifyMarginMode() ​

ts
batchModifyMarginMode(params: BatchModifyMarginModeRequestUTA): Promise<APISuccessResponse<BatchModifyMarginModeResponseUTA>>;

Batch Modify Margin Mode (UTA) Batch modify the margin mode for futures positions.

Parameters ​

ParameterType
paramsBatchModifyMarginModeRequestUTA

Returns ​

Promise<APISuccessResponse<BatchModifyMarginModeResponseUTA>>


batchPlaceOrder() ​

ts
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 ​

ParameterTypeDefault value
paramsBatchPlaceOrderRequestUTAundefined
accountMode?"classic" | "unified"'classic'

Returns ​

Promise<APISuccessResponse<BatchPlaceOrderResponseUTA>>


cancelOrder() ​

ts
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 ​

ParameterTypeDefault value
paramsCancelOrderRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<CancelOrderResponseUTA>>


cancelWithdrawal() ​

ts
cancelWithdrawal(params?: object): Promise<APISuccessResponse<string | null>>;

Cancel Withdrawal (UTA) Cancel a withdrawal request in PROCESSING status. Added 2026.05.15.

Parameters ​

ParameterType
params?{ withdrawalId?: string; }
params.withdrawalId?string

Returns ​

Promise<APISuccessResponse<string | null>>


deletePrivate() ​

ts
deletePrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


flexTransfer() ​

ts
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 ​

ParameterType
paramsFlexTransferRequestUTA

Returns ​

Promise<APISuccessResponse<FlexTransferResponseUTA>>


get() ​

ts
get(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


getAccount() ​

ts
getAccount(): Promise<APISuccessResponse<GetClassicAccountResponseUTA>>;

Get Account (UTA) Get information for Unified Trading Account.

Returns ​

Promise<APISuccessResponse<GetClassicAccountResponseUTA>>


getAccountLedger() ​

ts
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 ​

ParameterType
paramsGetAccountLedgerRequestUTA

Returns ​

Promise<APISuccessResponse< | GetAccountLedgerResponseUTA | GetAccountLedgerResponseClassicUTA>>


getAccountMode() ​

ts
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() ​

ts
getAccountOverview(): Promise<APISuccessResponse<GetAccountOverviewResponseUTA>>;

Get Account Overview (UTA) Get account overview for Unified Trading Account.

Returns ​

Promise<APISuccessResponse<GetAccountOverviewResponseUTA>>


getAccountPositionTiers() ​

ts
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 ​

ParameterTypeDefault value
paramsGetAccountPositionTiersRequestUTAundefined
accountMode?"classic" | "unified"'classic'

Returns ​

Promise<APISuccessResponse<PositionTierUTA[]>>

Deprecated ​

Use getClassicAccountPositionTiers or getUnifiedAccountPositionTiers.


getAllRateLimit() ​

ts
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() ​

ts
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 ​

ParameterType
params?GetAnnouncementsRequestUTA

Returns ​

Promise<APISuccessResponse<GetAnnouncementsResponseUTA>>


getApiKeyInfo() ​

ts
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() ​

ts
getBorrowableCurrencies(): Promise<APISuccessResponse<BorrowableCurrencyUTA[]>>;

Get Borrowable Currencies List of borrowable currencies (UTA / public).

Returns ​

Promise<APISuccessResponse<BorrowableCurrencyUTA[]>>


getBorrowingRatesAndLimits() ​

ts
getBorrowingRatesAndLimits(params: GetBorrowingRatesAndLimitsRequestUTA): Promise<APISuccessResponse<GetBorrowingRatesAndLimitsResponseUTA>>;

Get Borrowing Rates and Limits Hourly/daily rates and borrow limits (UTA).

Parameters ​

ParameterType
paramsGetBorrowingRatesAndLimitsRequestUTA

Returns ​

Promise<APISuccessResponse<GetBorrowingRatesAndLimitsResponseUTA>>


getCallAuctionInfo() ​

ts
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 ​

ParameterType
paramsGetCallAuctionInfoRequestUTA

Returns ​

Promise<APISuccessResponse<GetCallAuctionInfoResponseUTA>>


getClassicAccount() ​

ts
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 ​

ParameterType
paramsGetClassicAccountRequestUTA

Returns ​

Promise<APISuccessResponse<GetClassicAccountResponseUTA>>


getClassicAccountPositionTiers() ​

ts
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 ​

ParameterType
paramsGetAccountPositionTiersRequestUTA

Returns ​

Promise<APISuccessResponse<PositionTierUTA[]>>


getClassicOpenOrderList() ​

ts
getClassicOpenOrderList(params: GetOpenOrderListRequestUTA): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;

Get Classic Open Order List Open orders on the classic account.

Parameters ​

ParameterType
paramsGetOpenOrderListRequestUTA

Returns ​

Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>


getClassicOrderDetails() ​

ts
getClassicOrderDetails(params: GetOrderDetailsRequestUTA): Promise<APISuccessResponse<OrderDetailsUTA>>;

Get Classic Order Details Single order details on the classic account.

Parameters ​

ParameterType
paramsGetOrderDetailsRequestUTA

Returns ​

Promise<APISuccessResponse<OrderDetailsUTA>>


getClassicOrderHistory() ​

ts
getClassicOrderHistory(params: GetOrderHistoryRequestUTA): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;

Get Classic Order History Order history on the classic account.

Parameters ​

ParameterType
paramsGetOrderHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>


getClassicTradeHistory() ​

ts
getClassicTradeHistory(params: GetTradeHistoryRequestUTA): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;

Get Classic Trade History Trade execution history on the classic account.

Parameters ​

ParameterType
paramsGetTradeHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>


getClientIPAddress() ​

ts
getClientIPAddress(): Promise<APISuccessResponse<string>>;

Get Client IP Address Get the client side IP address. Added 2026.07.01.

Returns ​

Promise<APISuccessResponse<string>>


getClientType() ​

ts
getClientType(): RestClientType;

Defines the client type (affecting how requests & signatures behave)

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getCrossMarginConfig() ​

ts
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() ​

ts
getCurrencies(params?: GetCurrenciesRequestUTA): Promise<APISuccessResponse<GetCurrenciesResponseUTA>>;

Get Currencies Currency and chain-level deposit/withdrawal configuration.

Parameters ​

ParameterType
params?GetCurrenciesRequestUTA

Returns ​

Promise<APISuccessResponse<GetCurrenciesResponseUTA>>


getCurrency() ​

ts
getCurrency(params: GetCurrencyRequestUTA): Promise<APISuccessResponse<GetCurrencyResponseUTA>>;

Get Currency Request the currency details of a specified currency via this endpoint.

Parameters ​

ParameterType
paramsGetCurrencyRequestUTA

Returns ​

Promise<APISuccessResponse<GetCurrencyResponseUTA>>


getCurrentFundingRate() ​

ts
getCurrentFundingRate(params?: GetCurrentFundingRateRequestUTA): Promise<APISuccessResponse<
  | GetCurrentFundingRateResponseUTA
| GetCurrentFundingRateResponseUTA[]>>;

Get Current Funding Rate Get current Futures funding fee rate.

Parameters ​

ParameterType
params?GetCurrentFundingRateRequestUTA

Returns ​

Promise<APISuccessResponse< | GetCurrentFundingRateResponseUTA | GetCurrentFundingRateResponseUTA[]>>


getDCP() ​

ts
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 ​

ParameterType
paramsGetDCPRequestUTA

Returns ​

Promise<APISuccessResponse<DCPResponseUTA>>


getDepositAddress() ​

ts
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 ​

ParameterType
paramsGetDepositAddressRequestUTA

Returns ​

Promise<APISuccessResponse<DepositAddressUTA[]>>


getDepositHistory() ​

ts
getDepositHistory(params?: GetDepositHistoryRequestUTA): Promise<APISuccessResponse<GetDepositHistoryResponseUTA>>;

Get Deposit History (UTA) Paginated deposit records. Added 2026.08.03.

Parameters ​

ParameterType
params?GetDepositHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetDepositHistoryResponseUTA>>


getFeeRate() ​

ts
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 ​

ParameterType
paramsGetFeeRateRequestUTA

Returns ​

Promise<APISuccessResponse<GetFeeRateResponseUTA>>


getFiatPrice() ​

ts
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 ​

ParameterType
paramsGetFiatPriceRequestUTA

Returns ​

Promise<APISuccessResponse<GetFiatPriceResponseUTA>>


getHistoryFundingRate() ​

ts
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 ​

ParameterType
paramsGetHistoryFundingRateRequestUTA

Returns ​

Promise<APISuccessResponse<GetHistoryFundingRateResponseUTA>>


getIndexPrice() ​

ts
getIndexPrice(params: GetIndexPriceRequestUTA): Promise<APISuccessResponse<GetIndexPriceResponseUTA>>;

Get Index Price Index price snapshots (updated once per second).

Parameters ​

ParameterType
paramsGetIndexPriceRequestUTA

Returns ​

Promise<APISuccessResponse<GetIndexPriceResponseUTA>>


getInterestHistory() ​

ts
getInterestHistory(params: GetInterestHistoryRequestUTA): Promise<APISuccessResponse<GetInterestHistoryResponseUTA>>;

Get Interest History (UTA) Request the interest records via this endpoint.

Parameters ​

ParameterType
paramsGetInterestHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetInterestHistoryResponseUTA>>


getInterestRateIndex() ​

ts
getInterestRateIndex(params: GetInterestRateIndexRequestUTA): Promise<APISuccessResponse<GetInterestRateIndexResponseUTA>>;

Get Interest Rate Index (UTA) Interest rate index records by symbol. Added 2026.07.17.

Parameters ​

ParameterType
paramsGetInterestRateIndexRequestUTA

Returns ​

Promise<APISuccessResponse<GetInterestRateIndexResponseUTA>>


getKlines() ​

ts
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 ​

ParameterType
paramsGetKlinesRequestUTA

Returns ​

Promise<APISuccessResponse<GetKlinesResponseUTA>>


getKYCRegions() ​

ts
getKYCRegions(): Promise<APISuccessResponse<KYCRegionUTA[]>>;

Get KYC Regions (UTA) Obtain the list of KYC regions. Added 2026.05.15.

Returns ​

Promise<APISuccessResponse<KYCRegionUTA[]>>


getLeverage() ​

ts
getLeverage(params: GetLeverageRequestUTA): Promise<APISuccessResponse<GetLeverageItemUTA[]>>;

Get Leverage (UTA) Query leverage for MARGIN (currency) or FUTURES (symbol).

Parameters ​

ParameterType
paramsGetLeverageRequestUTA

Returns ​

Promise<APISuccessResponse<GetLeverageItemUTA[]>>


getOpenOrderList() ​

ts
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 ​

ParameterTypeDefault value
paramsGetOpenOrderListRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>

Deprecated ​

Use getClassicOpenOrderList or getUnifiedOpenOrderList.


getOrderBook() ​

ts
getOrderBook(params: GetOrderBookRequestUTA): Promise<APISuccessResponse<GetOrderBookResponseUTA>>;

Get OrderBook Query order book depth information (aggregated by price).

Parameters ​

ParameterType
paramsGetOrderBookRequestUTA

Returns ​

Promise<APISuccessResponse<GetOrderBookResponseUTA>>


getOrderDetails() ​

ts
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 ​

ParameterTypeDefault value
paramsGetOrderDetailsRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<OrderDetailsUTA>>

Deprecated ​

Use getClassicOrderDetails or getUnifiedOrderDetails.


getOrderHistory() ​

ts
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 ​

ParameterTypeDefault value
paramsGetOrderHistoryRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>

Deprecated ​

Use getClassicOrderHistory or getUnifiedOrderHistory.


getPositionList() ​

ts
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 ​

ParameterType
params?GetPositionListRequestUTA

Returns ​

Promise<APISuccessResponse<PositionUTA[]>>


getPositionsHistory() ​

ts
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 ​

ParameterType
params?GetPositionsHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetPositionsHistoryResponseUTA>>


getPrivate() ​

ts
getPrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getPrivateFundingFeeHistory() ​

ts
getPrivateFundingFeeHistory(params?: GetPrivateFundingFeeHistoryRequestUTA): Promise<APISuccessResponse<GetPrivateFundingFeeHistoryResponseUTA>>;

Get Private Funding Fee History Settled funding fee records for the current account.

Parameters ​

ParameterType
params?GetPrivateFundingFeeHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetPrivateFundingFeeHistoryResponseUTA>>


getRateLimit() ​

ts
getRateLimit(params: GetRateLimitRequestUTA): Promise<APISuccessResponse<GetRateLimitResponseUTA>>;

Get API Rate Limit (UTA) Query UTA API rate limit for specified UIDs. Added 2026.06.05.

Parameters ​

ParameterType
paramsGetRateLimitRequestUTA

Returns ​

Promise<APISuccessResponse<GetRateLimitResponseUTA>>


getRateLimitCap() ​

ts
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() ​

ts
getServiceStatus(params: GetServiceStatusRequestUTA): Promise<APISuccessResponse<GetServiceStatusResponseUTA>>;

Get Service Status Get the service status.

Parameters ​

ParameterType
paramsGetServiceStatusRequestUTA

Returns ​

Promise<APISuccessResponse<GetServiceStatusResponseUTA>>


getSubAccount() ​

ts
getSubAccount(params?: GetSubAccountRequestUTA): Promise<APISuccessResponse<GetSubAccountResponseUTA>>;

Get Sub Account Request sub account info via this endpoint.

Parameters ​

ParameterType
params?GetSubAccountRequestUTA

Returns ​

Promise<APISuccessResponse<GetSubAccountResponseUTA>>


getSubAccountList() ​

ts
getSubAccountList(params?: GetSubAccountListRequestUTA): Promise<APISuccessResponse<GetSubAccountListResponseUTA>>;

Get Sub-account List (UTA) Paginated list of sub-accounts. Added 2026.08.03.

Parameters ​

ParameterType
params?GetSubAccountListRequestUTA

Returns ​

Promise<APISuccessResponse<GetSubAccountListResponseUTA>>


getSymbols() ​

ts
getSymbols(params: GetSymbolRequestUTA): Promise<APISuccessResponse<GetSymbolResponseUTA>>;

Get Symbol Request a list of available currency pairs for trading via this endpoint.

Parameters ​

ParameterType
paramsGetSymbolRequestUTA

Returns ​

Promise<APISuccessResponse<GetSymbolResponseUTA>>


getThirdPartyCustodyCurrencies() ​

ts
getThirdPartyCustodyCurrencies(params?: GetThirdPartyCustodyCurrenciesRequestUTA): Promise<APISuccessResponse<ThirdPartyCustodyCurrencyUTA[]>>;

Get Third-Party Custody Currencies Query settlement currencies supported by third-party (OES) custodian institutions.

Parameters ​

ParameterType
params?GetThirdPartyCustodyCurrenciesRequestUTA

Returns ​

Promise<APISuccessResponse<ThirdPartyCustodyCurrencyUTA[]>>


getThirdPartyCustodyQuota() ​

ts
getThirdPartyCustodyQuota(params?: GetThirdPartyCustodyQuotaRequestUTA): Promise<APISuccessResponse<ThirdPartyCustodyQuotaUTA[]>>;

Get Third-Party Custody Account Currency Limits OES remaining custody quota per custodian and settlement currency.

Parameters ​

ParameterType
params?GetThirdPartyCustodyQuotaRequestUTA

Returns ​

Promise<APISuccessResponse<ThirdPartyCustodyQuotaUTA[]>>


getTickers() ​

ts
getTickers(params: GetTickerRequestUTA): Promise<APISuccessResponse<GetTickerResponseUTA>>;

Get Ticker Request market tickers for the trading pairs in the market (including 24h volume).

Parameters ​

ParameterType
paramsGetTickerRequestUTA

Returns ​

Promise<APISuccessResponse<GetTickerResponseUTA>>


getTradeHistory() ​

ts
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 ​

ParameterTypeDefault value
paramsGetTradeHistoryRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>

Deprecated ​

Use getClassicTradeHistory or getUnifiedTradeHistory.


getTrades() ​

ts
getTrades(params: GetTradesRequestUTA): Promise<APISuccessResponse<GetTradesResponseUTA>>;

Get Trades Request via this endpoint to get the latest 100 public trades of the specified symbol.

Parameters ​

ParameterType
paramsGetTradesRequestUTA

Returns ​

Promise<APISuccessResponse<GetTradesResponseUTA>>


getTradeStatistics() ​

ts
getTradeStatistics(): Promise<APISuccessResponse<GetTradeStatisticsResponseUTA>>;

Platform 24h Market Statistics (UTA) Spot and futures 24h turnover. Added 2026.07.17.

Returns ​

Promise<APISuccessResponse<GetTradeStatisticsResponseUTA>>


getTransferQuotas() ​

ts
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 ​

ParameterType
paramsGetTransferQuotasRequestUTA

Returns ​

Promise<APISuccessResponse<GetTransferQuotasResponseUTA>>


getUnifiedAccountPositionTiers() ​

ts
getUnifiedAccountPositionTiers(params: GetAccountPositionTiersRequestUTA): Promise<APISuccessResponse<PositionTierUTA[]>>;

Get Unified Account Position Tiers Unified account position tiers (risk limit).

Parameters ​

ParameterType
paramsGetAccountPositionTiersRequestUTA

Returns ​

Promise<APISuccessResponse<PositionTierUTA[]>>


getUnifiedOpenOrderList() ​

ts
getUnifiedOpenOrderList(params: GetOpenOrderListRequestUTA): Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>;

Get Unified Open Order List Open orders on the unified account.

Parameters ​

ParameterType
paramsGetOpenOrderListRequestUTA

Returns ​

Promise<APISuccessResponse<GetOpenOrderListResponseUTA>>


getUnifiedOrderDetails() ​

ts
getUnifiedOrderDetails(params: GetOrderDetailsRequestUTA): Promise<APISuccessResponse<OrderDetailsUTA>>;

Get Unified Order Details Single order details on the unified account.

Parameters ​

ParameterType
paramsGetOrderDetailsRequestUTA

Returns ​

Promise<APISuccessResponse<OrderDetailsUTA>>


getUnifiedOrderHistory() ​

ts
getUnifiedOrderHistory(params: GetOrderHistoryRequestUTA): Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>;

Get Unified Order History Order history on the unified account.

Parameters ​

ParameterType
paramsGetOrderHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetOrderHistoryResponseUTA>>


getUnifiedTradeHistory() ​

ts
getUnifiedTradeHistory(params: GetTradeHistoryRequestUTA): Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>;

Get Unified Trade History Trade execution history on the unified account.

Parameters ​

ParameterType
paramsGetTradeHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetTradeHistoryResponseUTA>>


getWithdrawalHistory() ​

ts
getWithdrawalHistory(params?: GetWithdrawalHistoryRequestUTA): Promise<APISuccessResponse<GetWithdrawalHistoryResponseUTA>>;

Get Withdrawal History (UTA) Paginated withdrawal records. Added 2026.08.03.

Parameters ​

ParameterType
params?GetWithdrawalHistoryRequestUTA

Returns ​

Promise<APISuccessResponse<GetWithdrawalHistoryResponseUTA>>


getWithdrawalQuotas() ​

ts
getWithdrawalQuotas(params: GetWithdrawalQuotasRequestUTA): Promise<APISuccessResponse<WithdrawalQuotasUTA>>;

Get Withdrawal Quotas (UTA) Obtain withdrawal quota information for a currency. Added 2026.05.15.

Parameters ​

ParameterType
paramsGetWithdrawalQuotasRequestUTA

Returns ​

Promise<APISuccessResponse<WithdrawalQuotasUTA>>


hasAccessToken() ​

ts
hasAccessToken(): boolean;

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


modifyClassicMarginCrossLeverage() ​

ts
modifyClassicMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;

Modify Classic Leverage Margin Cross Update cross-margin leverage on the classic account.

Parameters ​

ParameterType
paramsModifyMarginCrossLeverageRequestUTA

Returns ​

Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>


modifyIsolatedFuturesMargin() ​

ts
modifyIsolatedFuturesMargin(params: ModifyIsolatedFuturesMarginRequestUTA): Promise<APISuccessResponse<ModifyIsolatedFuturesMarginResponseUTA>>;

Modify Isolated Futures Margin (UTA) Extract or add margin for an isolated futures position.

Parameters ​

ParameterType
paramsModifyIsolatedFuturesMarginRequestUTA

Returns ​

Promise<APISuccessResponse<ModifyIsolatedFuturesMarginResponseUTA>>


modifyLeverage() ​

ts
modifyLeverage(params: ModifyLeverageRequestUTA): Promise<APISuccessResponse<null>>;

Modify Leverage (UTA) This interface supports modify leverage of the specified symbol.

Parameters ​

ParameterType
paramsModifyLeverageRequestUTA

Returns ​

Promise<APISuccessResponse<null>>


modifyMarginCrossLeverage() ​

ts
modifyMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA, accountMode?: "classic" | "unified"): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;

Modify Leverage Margin Cross (UTA) Update leverage for a currency in UTA cross margin.

Parameters ​

ParameterTypeDefault value
paramsModifyMarginCrossLeverageRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>

Deprecated ​

Use modifyClassicMarginCrossLeverage or modifyUnifiedMarginCrossLeverage.


modifyUnifiedMarginCrossLeverage() ​

ts
modifyUnifiedMarginCrossLeverage(params: ModifyMarginCrossLeverageRequestUTA): Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>;

Modify Unified Leverage Margin Cross Update cross-margin leverage on the unified account.

Parameters ​

ParameterType
paramsModifyMarginCrossLeverageRequestUTA

Returns ​

Promise<APISuccessResponse<ModifyMarginCrossLeverageResponseUTA>>


placeOrder() ​

ts
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 ​

ParameterTypeDefault value
paramsPlaceOrderRequestUTAundefined
accountMode?"classic" | "unified"'unified'

Returns ​

Promise<APISuccessResponse<PlaceOrderResponseUTA>>


post() ​

ts
post(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

ts
postPrivate(
   endpoint: string, 
   params?: any, 
   internalReqContext?: InternalRequestContext
): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any
internalReqContext?InternalRequestContext

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


setAccountMode() ​

ts
setAccountMode(params: SetAccountModeRequestUTA): Promise<APISuccessResponse<null>>;

Set Account Mode This interface supports set account mode to UTA.

Parameters ​

ParameterType
paramsSetAccountModeRequestUTA

Returns ​

Promise<APISuccessResponse<null>>


setDCP() ​

ts
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 ​

ParameterType
paramsSetDCPRequestUTA

Returns ​

Promise<APISuccessResponse<DCPResponseUTA>>


setKcsFeeDeduction() ​

ts
setKcsFeeDeduction(params: SetKcsFeeDeductionRequestUTA): Promise<APISuccessResponse<SetKcsFeeDeductionResponseUTA>>;

KCS Fee Deduction Management (UTA) Enable or disable KCS fee deduction. Added 2026.08.03.

Parameters ​

ParameterType
paramsSetKcsFeeDeductionRequestUTA

Returns ​

Promise<APISuccessResponse<SetKcsFeeDeductionResponseUTA>>


setSubAccountsRateLimit() ​

ts
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 ​

ParameterType
paramsSetSubAccountsRateLimitRequestUTA

Returns ​

Promise<APISuccessResponse<SetSubAccountsRateLimitResponseUTA>>


setSubAccountTransferPermission() ​

ts
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 ​

ParameterType
paramsSetSubAccountTransferPermissionRequestUTA

Returns ​

Promise<APISuccessResponse<SubAccountTransferPermissionUTA[]>>


submitWithdraw() ​

ts
submitWithdraw(params: SubmitWithdrawRequestUTA): Promise<APISuccessResponse<SubmitWithdrawResponseUTA>>;

Withdraw (UTA) Withdraw the specified currency. Added 2026.05.15.

Parameters ​

ParameterType
paramsSubmitWithdrawRequestUTA

Returns ​

Promise<APISuccessResponse<SubmitWithdrawResponseUTA>>

Built by Siebly. Open source SDKs for exchange APIs.