Skip to content

Class: SpotClient ​

REST client for HTX Spot market data, trading and account operations.

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

ts
new SpotClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): SpotClient;

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 ​

SpotClient

Inherited from ​

BaseRestClient.constructor

Methods ​

batchCancelOpenOrders() ​

ts
batchCancelOpenOrders(params?: SpotV1OrderBatchCancelOpenOrdersReq): Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelOpenOrdersResult>>;

Cancel Multiple Orders by Criteria

Cancel up to 100 orders matching account-id, symbol, types, side. Submit only; verify via order status. Signature required. Trade permission. Rate: 50/2s.

Parameters ​

ParameterType
params?SpotV1OrderBatchCancelOpenOrdersReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelOpenOrdersResult>>


batchCancelOrders() ​

ts
batchCancelOrders(params: object): Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelResult>>;

Cancel Multiple Orders by IDs

Cancel by order-ids or client-order-ids (max 50). Prefer order-ids. Signature required. Trade permission. Rate: 50/2s.

Parameters ​

ParameterType
params{ "client-order-ids"?: string[]; "order-ids"?: string[]; }
params.client-order-ids?string[]
params.order-ids?string[]

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelResult>>


cancelAllOrders() ​

ts
cancelAllOrders(params?: object): Promise<SpotAPISuccessResponse<null>>;

Cancel All Spot Orders

Cancel all open spot orders. Pass symbol for specific pair(s), comma-separated; omit for all. Signature required. Trade permission. Rate: 1/2s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<null>>


cancelConditionalOrders() ​

ts
cancelConditionalOrders(params: object): Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancellationResult>>;

Cancel Conditional Orders (before triggering)

Only cancels conditional orders that have not triggered yet. Max 50 orders. Signature required. Trade permission. Rate: 20/2s.

Parameters ​

ParameterType
params{ clientOrderIds: string[]; }
params.clientOrderIdsstring[]

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancellationResult>>


cancelOrderByClientId() ​

ts
cancelOrderByClientId(params: object): Promise<SpotAPISuccessResponse<number>>;

Request cancellation using a client order ID. Prefer cancelOrderById when the exchange order ID is available. Confirm final status and reconcile any fills after submitting cancellation.

Parameters ​

ParameterType
params{ "client-order-id": string; }
params.client-order-idstring

Returns ​

Promise<SpotAPISuccessResponse<number>>


cancelOrderById() ​

ts
cancelOrderById(params: object): Promise<SpotAPISuccessResponse<string>>;

Cancel Order by Order ID

Submits cancel request. Verify via order status or match result. Signature required. Trade permission. Rate: 100/2s.

Parameters ​

ParameterType
params{ orderId: string; symbol?: string; }
params.orderIdstring
params.symbol?string

Returns ​

Promise<SpotAPISuccessResponse<string>>

See ​

Spot order management


cancelWithdraw() ​

ts
cancelWithdraw(params: object): Promise<SpotAPISuccessResponse<number>>;

Cancel Withdraw Request

Cancel withdraw by transfer id. Parent user only. Withdraw permission. Rate: 20/2s.

Parameters ​

ParameterType
params{ withdrawId: number; }
params.withdrawIdnumber

Returns ​

Promise<SpotAPISuccessResponse<number>>


createSubUser() ​

ts
createSubUser(params: object): Promise<SpotAPISuccessResponse<SpotSubUserCreationResult[]>>;

Create Sub Users

Create sub users, max 50 at a time. Signature required. Trade permission.

Parameters ​

ParameterTypeDescription
params{ subAccountType?: string; userList: object[]; }-
params.subAccountType?stringGENERAL (default), CONTACT, GRID, FIRE-BLOCK
params.userListobject[]Sub users to create, max 50

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserCreationResult[]>>


createSubUserApiKey() ​

ts
createSubUserApiKey(params: SpotSubUserApiKeyCreationReq): Promise<SpotAPISuccessResponse<SpotSubUserApiKeyCreationResult>>;

Create Sub User API Key

Create API key for sub user. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotSubUserApiKeyCreationReq

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserApiKeyCreationResult>>


deleteSubUserApiKey() ​

ts
deleteSubUserApiKey(params: object): Promise<SpotAPISuccessResponse<null>>;

Delete Sub User API Key

Delete sub user's API key. Signature required. Trade permission.

Parameters ​

ParameterType
params{ accessKey: string; subUid: number; }
params.accessKeystring
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<null>>


earnRedeem() ​

ts
earnRedeem(params: SpotEarnRedeemReq): Promise<SpotAPISuccessResponse<SpotEarnRedeemResult>>;

Earn Redemption

Redeem Earn product. Signature required. Trade permission. Arrival may be delayed.

Parameters ​

ParameterType
paramsSpotEarnRedeemReq

Returns ​

Promise<SpotAPISuccessResponse<SpotEarnRedeemResult>>


earnSubscribe() ​

ts
earnSubscribe(params: SpotEarnSubscribeReq): Promise<SpotAPISuccessResponse<SpotEarnSubscribeResult>>;

Earn Subscription

Subscribe to Earn product. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotEarnSubscribeReq

Returns ​

Promise<SpotAPISuccessResponse<SpotEarnSubscribeResult>>


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Misc Utility Methods

Returns ​

string


get24hMarketSummary() ​

ts
get24hMarketSummary(params: object): Promise<SpotAPISuccessResponse<SpotDetailTick, "tick">>;

Get the Last 24h Market Summary

Returns 24h trading summary for a symbol. No signature required.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<SpotAPISuccessResponse<SpotDetailTick, "tick">>


getAccountBalance() ​

ts
getAccountBalance(params: object): Promise<SpotAPISuccessResponse<SpotAccountBalance>>;

Get Account Balance of a Specific Account

Returns balance for account specified by account id. Signature required. OTC not supported.

Parameters ​

ParameterType
params{ accountId: string | number; }
params.accountIdstring | number

Returns ​

Promise<SpotAPISuccessResponse<SpotAccountBalance>>

See ​

Read Spot balances


getAccountHistory() ​

ts
getAccountHistory(params: SpotGetAccountHistoryReq): Promise<object & Record<"data", SpotAccountHistory[]> & object>;

Get Account History

Returns amount changes of specified account. Signature required. Max 1h query window, 30 days range.

Parameters ​

ParameterType
paramsSpotGetAccountHistoryReq

Returns ​

Promise<object & Record<"data", SpotAccountHistory[]> & object>


getAccountLedger() ​

ts
getAccountLedger(params?: SpotGetAccountLedgerReq): Promise<object & Record<"data", SpotV2AccountLedger[]> & object>;

Get Account Ledger

Returns amount changes (phase 1: transfer only). Max 10-day window, 180 days range. Signature required.

Parameters ​

ParameterType
params?SpotGetAccountLedgerReq

Returns ​

Promise<object & Record<"data", SpotV2AccountLedger[]> & object>


getAccountOverviewInfo() ​

ts
getAccountOverviewInfo(): Promise<SpotAPISuccessResponse<SpotV1AccountOverviewInfo>>;

Get Deductible Currency Overview

Query asset that can be used to deduct fees. Signature required. Read permission. Rate: 5/s.

Returns ​

Promise<SpotAPISuccessResponse<SpotV1AccountOverviewInfo>>


getAccounts() ​

ts
getAccounts(): Promise<SpotAPISuccessResponse<SpotAccount[]>>;

Get all Accounts of the Current User

Returns list of accounts owned by this API user. Signature required.

Returns ​

Promise<SpotAPISuccessResponse<SpotAccount[]>>


getAccountSwitchUserInfo() ​

ts
getAccountSwitchUserInfo(): Promise<SpotAPISuccessResponse<SpotV1AccountSwitchUserInfo>>;

Get User Deduction Info

Query point card vs HTX deduction settings. Signature required. Read permission. Rate: 5/s.

Returns ​

Promise<SpotAPISuccessResponse<SpotV1AccountSwitchUserInfo>>


getAccountValuation() ​

ts
getAccountValuation(params?: object): Promise<SpotAPISuccessResponse<SpotV2AccountValuation>>;

Get The Total Valuation of Platform Assets

Returns total asset valuation in BTC or fiat. Signature required.

Parameters ​

ParameterType
params?{ accountType?: string; valuationCurrency?: string; }
params.accountType?string
params.valuationCurrency?string

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AccountValuation>>


getAssetValuation() ​

ts
getAssetValuation(params?: SpotGetAssetValuationReq): Promise<SpotAPISuccessResponse<SpotV2AssetValuation>>;

Get Asset Valuation

Returns valuation of total assets in BTC or fiat. Signature required.

Parameters ​

ParameterType
params?SpotGetAssetValuationReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AssetValuation>>


getBrokerAccountCapitalSnapshot() ​

ts
getBrokerAccountCapitalSnapshot(params: SpotBrokerAccountCapitalSnapshotReq): Promise<SpotAPISuccessResponse<SpotBrokerAccountCapitalSnapshot[]>>;

Get Account Capital Snapshot

Request account asset snapshot. Signature required. Read permission. Rate: 100/2s.

Parameters ​

ParameterType
paramsSpotBrokerAccountCapitalSnapshotReq

Returns ​

Promise<SpotAPISuccessResponse<SpotBrokerAccountCapitalSnapshot[]>>


getBrokerSubUserFeeRate() ​

ts
getBrokerSubUserFeeRate(params: object): Promise<SpotAPISuccessResponse<SpotBrokerSubUserFeeRate>>;

Get Broker Sub-Account Fee Rate

Query sub-account commission/fee rate. Signature required. Read permission. Rate: 100/2s.

Parameters ​

ParameterTypeDescription
params{ bizType: string; subUId: string; }-
params.bizTypestring1 Spot, 2 U-standard linear, 3 Coin-Margined swap
params.subUIdstringSub-account id (user_id, UID minus last digit)

Returns ​

Promise<SpotAPISuccessResponse<SpotBrokerSubUserFeeRate>>


getBrokerUserRebateStatus() ​

ts
getBrokerUserRebateStatus(params: object): Promise<SpotAPISuccessResponse<SpotBrokerUserRebateStatus>>;

Check User Rebate Eligibility

Check whether user meets rebate conditions. API brokers only. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterTypeDescription
params{ queryUid: string; }-
params.queryUidstringUser UID to check

Returns ​

Promise<SpotAPISuccessResponse<SpotBrokerUserRebateStatus>>


getChainsInfo() ​

ts
getChainsInfo(params?: SpotGetChainsReq): Promise<SpotAPISuccessResponse<SpotV1ChainInfo[]>>;

Get Chains Information (V1)

Returns chain info per currency. No signature required. Pass show-desc, currency, and/or ts for incremental updates.

Parameters ​

ParameterType
params?SpotGetChainsReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1ChainInfo[]>>


getClientType() ​

ts
getClientType(): RestClientType;

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

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getConditionalOrder() ​

ts
getConditionalOrder(params: object): Promise<SpotAPISuccessResponse<SpotV2AlgoOrder>>;

Query a Specific Conditional Order

By clientOrderId. Covers created, triggered, canceled, rejected. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params{ clientOrderId: string; }
params.clientOrderIdstring

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AlgoOrder>>


getConditionalOrderHistory() ​

ts
getConditionalOrderHistory(params?: SpotV2AlgoOrdersHistoryReq): Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>;

Query Conditional Order History

Returns canceled/rejected/triggered conditional orders. For triggered, use Trading section for latest status. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params?SpotV2AlgoOrdersHistoryReq

Returns ​

Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>


getCrossMarginBalance() ​

ts
getCrossMarginBalance(params?: object): Promise<SpotAPISuccessResponse<SpotCrossMarginAccountBalance>>;

Get the Balance of the Margin Loan Account (Cross)

Returns single account object. Signature required. Read permission. Rate: 2/2s.

Parameters ​

ParameterType
params?{ "sub-uid"?: number; }
params.sub-uid?number

Returns ​

Promise<SpotAPISuccessResponse<SpotCrossMarginAccountBalance>>


getCrossMarginLimit() ​

ts
getCrossMarginLimit(params?: object): Promise<SpotAPISuccessResponse<SpotMarginLimit[]>>;

Obtain Leverage Position Limit (Cross)

Returns position limit at user level per currency. Signature required. Read permission. Rate: 2/2s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginLimit[]>>


getCrossMarginLoanInfo() ​

ts
getCrossMarginLoanInfo(): Promise<SpotAPISuccessResponse<SpotMarginLoanInfoCurrency[]>>;

Get Loan Interest Rate and Quota (Cross)

Returns loan interest rates and quota per currency. No params. Signature required. Read permission. Rate: 2/2s.

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginLoanInfoCurrency[]>>


getCrossMarginLoanOrders() ​

ts
getCrossMarginLoanOrders(params?: SpotCrossMarginLoanOrdersReq): Promise<SpotAPISuccessResponse<SpotCrossMarginLoanOrder[]>>;

Search Past Margin Orders (Cross)

Returns margin loan orders by criteria. Signature required. Read permission. Rate: 2/2s.

Parameters ​

ParameterType
params?SpotCrossMarginLoanOrdersReq

Returns ​

Promise<SpotAPISuccessResponse<SpotCrossMarginLoanOrder[]>>


getCurrencies() ​

ts
getCurrencies(params?: object): Promise<SpotAPISuccessResponse<SpotCurrency[]>>;

Get all Supported Currencies (V2)

Returns all supported currencies. Pass ts for incremental updates.

Parameters ​

ParameterType
params?{ ts?: number; }
params.ts?number

Returns ​

Promise<SpotAPISuccessResponse<SpotCurrency[]>>


getCurrencysSettings() ​

ts
getCurrencysSettings(params?: object): Promise<SpotAPISuccessResponse<SpotV1CurrencySettings[]>>;

Get currency settings from the V1 public reference endpoint. The method name retains the published SDK spelling.

Parameters ​

ParameterType
params?{ ts?: number; }
params.ts?number

Returns ​

Promise<SpotAPISuccessResponse<SpotV1CurrencySettings[]>>


getDepositAddress() ​

ts
getDepositAddress(params?: object): Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>;

Query Deposit Address

Query deposit address per chain for a currency. Signature required. Read permission. Rate: 20/2s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>


getDepositWithdrawHistory() ​

ts
getDepositWithdrawHistory(params: SpotDepositWithdrawQueryReq): Promise<SpotAPISuccessResponse<SpotDepositWithdrawRecord[]>>;

Search Deposit/Withdraw Records

Search existed withdraws and deposits. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
paramsSpotDepositWithdrawQueryReq

Returns ​

Promise<SpotAPISuccessResponse<SpotDepositWithdrawRecord[]>>


getEarnProjectList() ​

ts
getEarnProjectList(params: SpotEarnProjectListReq): Promise<SpotAPISuccessResponse<{
  items: SpotEarnProject[];
  total: number;
}>>;

Query Earn Product List

Product query. Signature required. Read permission.

Parameters ​

ParameterType
paramsSpotEarnProjectListReq

Returns ​

Promise<SpotAPISuccessResponse<{ items: SpotEarnProject[]; total: number; }>>


getEarnUserAssets() ​

ts
getEarnUserAssets(params: SpotEarnUserAssetsReq): Promise<SpotAPISuccessResponse<{
  items: SpotEarnUserAsset[];
  total: number;
}>>;

Query Earn User Assets

Position query. Signature required. Read permission.

Parameters ​

ParameterType
paramsSpotEarnUserAssetsReq

Returns ​

Promise<SpotAPISuccessResponse<{ items: SpotEarnUserAsset[]; total: number; }>>


getFeeRate() ​

ts
getFeeRate(params: object): Promise<SpotAPISuccessResponse<SpotV2TransactFeeRate[]>>;

Get Transact Fee Rate

Query fee rates for trading pairs. Max 10 symbols. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
params{ symbols: string; }
params.symbolsstring

Returns ​

Promise<SpotAPISuccessResponse<SpotV2TransactFeeRate[]>>


getFullOrderBook() ​

ts
getFullOrderBook(params: object): Promise<SpotAPISuccessResponse<SpotDepth, "tick">>;

Get Full Order Book

Returns complete market depth, up to 5000 levels. Updated once per second. No signature required.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<SpotAPISuccessResponse<SpotDepth, "tick">>


getHistoryTrades() ​

ts
getHistoryTrades(params: object): Promise<SpotAPISuccessResponse<SpotTradeTimestampGroup[]>>;

Get the Most Recent Trades

Returns recent trades grouped by timestamp. No signature required.

Parameters ​

ParameterType
params{ size?: number; symbol: string; }
params.size?number
params.symbolstring

Returns ​

Promise<SpotAPISuccessResponse<SpotTradeTimestampGroup[]>>


getKlines() ​

ts
getKlines(params: SpotGetKlineReq): Promise<SpotAPISuccessResponse<SpotKline[]>>;

Get Klines (Candles)

Returns candlestick data for a symbol. No signature required.

Parameters ​

ParameterType
paramsSpotGetKlineReq

Returns ​

Promise<SpotAPISuccessResponse<SpotKline[]>>


getLastTrade() ​

ts
getLastTrade(params: object): Promise<SpotAPISuccessResponse<SpotLastTrade, "tick">>;

Get the Last Trade

Returns latest trade with price, volume, direction. No signature required.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<SpotAPISuccessResponse<SpotLastTrade, "tick">>


getMarginAccountBalance() ​

ts
getMarginAccountBalance(params?: object): Promise<SpotAPISuccessResponse<SpotMarginAccountBalance[]>>;

Get the Balance of the Margin Loan Account (Isolated)

Signature required. Read permission. Rate: 100/2s.

Parameters ​

ParameterType
params?{ "sub-uid"?: number; symbol?: string; }
params.sub-uid?number
params.symbol?string

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginAccountBalance[]>>


getMarginLoanInfo() ​

ts
getMarginLoanInfo(params?: object): Promise<SpotAPISuccessResponse<SpotMarginLoanInfo[]>>;

Get Loan Interest Rate and Quota (Isolated)

Returns loan interest rates and quota per symbol. Signature required. Read permission. Rate: 20/2s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginLoanInfo[]>>


getMarginLoanOrders() ​

ts
getMarginLoanOrders(params?: SpotMarginLoanOrdersReq): Promise<SpotAPISuccessResponse<SpotMarginLoanOrder[]>>;

Search Past Margin Orders (Isolated)

Returns margin loan orders by criteria. Signature required. Read permission. Rate: 100/2s.

Parameters ​

ParameterType
params?SpotMarginLoanOrdersReq

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginLoanOrder[]>>


getMarketDepth() ​

ts
getMarketDepth(params: SpotGetDepthReq): Promise<SpotAPISuccessResponse<SpotDepth, "tick">>;

Get Market Depth

Returns order book for a symbol. No signature required.

Parameters ​

ParameterType
paramsSpotGetDepthReq

Returns ​

Promise<SpotAPISuccessResponse<SpotDepth, "tick">>

See ​

Read an order book


getMarketStatus() ​

ts
getMarketStatus(): Promise<SpotMarketStatusResponse>;

Get Market Status

Returns current market status. 1=normal, 2=halted, 3=cancel-only.

Returns ​

Promise<SpotMarketStatusResponse>


getMarketSymbolsSettings() ​

ts
getMarketSymbolsSettings(params?: object): Promise<SpotAPISuccessResponse<SpotV1MarketSymbolSettings[]>>;

Get Market Symbols Settings (V1)

Returns market symbol settings. No signature required. Pass symbols (NA=all) and/or ts for incremental updates.

Parameters ​

ParameterType
params?{ symbols?: string; ts?: number; }
params.symbols?string
params.ts?number

Returns ​

Promise<SpotAPISuccessResponse<SpotV1MarketSymbolSettings[]>>


getMatchResults() ​

ts
getMatchResults(params?: SpotGetMatchResultsReq): Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>;

Search Match Results

Match results of filled/partial orders by symbol, types, time. 48h window, 120 days range. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params?SpotGetMatchResultsReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>


getOpenConditionalOrders() ​

ts
getOpenConditionalOrders(params?: SpotV2AlgoOrdersOpeningReq): Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>;

Query Open Conditional Orders (before triggering)

Returns conditional orders with orderStatus=created. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params?SpotV2AlgoOrdersOpeningReq

Returns ​

Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>


getOpenOrders() ​

ts
getOpenOrders(params?: SpotGetOpenOrdersReq): Promise<SpotAPISuccessResponse<SpotV1OpenOrder[]>>;

Get All Open Orders

Returns unfilled orders. Filter by account-id, symbol, side. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
params?SpotGetOpenOrdersReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OpenOrder[]>>


getOrder() ​

ts
getOrder(params: object): Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>;

Get Order Detail by Order ID

Returns order detail. API-created orders not queryable 2h after cancel. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>

See ​

Spot order management


getOrderByClientId() ​

ts
getOrderByClientId(params: object): Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>;

Get Order Detail by Client Order ID

Returns latest status of order with given client order ID. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
params{ clientOrderId: string; }
params.clientOrderIdstring

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>

See ​

Spot order management


getOrderHistory() ​

ts
getOrderHistory(params: SpotGetOrderHistoryReq): Promise<SpotAPISuccessResponse<SpotV1OrderHistory[]>>;

Search Past Orders

Historical orders by symbol, states, time range. Max 48h window, 180 days range. API orders not queryable 2h after cancel. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
paramsSpotGetOrderHistoryReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderHistory[]>>


getOrderHistory48h() ​

ts
getOrderHistory48h(params?: SpotGetOrderHistory48hReq): Promise<SpotAPISuccessResponse<SpotV1OrderHistory48h[]>>;

Search Historical Orders within 48 Hours

Orders by time range. Default: last 48h. next-time in last item when more exist. API orders not queryable 2h after cancel. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params?SpotGetOrderHistory48hReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderHistory48h[]>>


getOrderMatch() ​

ts
getOrderMatch(params: object): Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>;

Get Match Results of an Order

Returns match/trade results for a specific order. Signature required. Read permission. Rate: 50/2s.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>

See ​

Spot order management


getP2POrderHistory() ​

ts
getP2POrderHistory(params?: SpotP2POrderHistoryReq): Promise<SpotAPISuccessResponse<{
  openApiC2COrderInfoVOList: SpotP2POrderHistory[];
  ts: number;
}>>;

Query P2P Order History

Query C2C historical transaction records. No signature. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params?SpotP2POrderHistoryReq

Returns ​

Promise<SpotAPISuccessResponse<{ openApiC2COrderInfoVOList: SpotP2POrderHistory[]; ts: number; }>>


getPointBalance() ​

ts
getPointBalance(params?: object): Promise<SpotAPISuccessResponse<SpotV2PointAccount>>;

Get Point Balance

Query termless and terminable point balance. Parent can query sub user via subUid. Signature required. Read permission. Rate: 2/s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotV2PointAccount>>


getReferenceCurrencies() ​

ts
getReferenceCurrencies(params?: object): Promise<SpotAPISuccessResponse<SpotV2CurrencyReference[]>>;

Get Reference Currencies & Chains (V2)

Returns static reference info for each currency and its chains. No signature required.

Parameters ​

ParameterType
params?{ authorizedUser?: boolean; currency?: string; }
params.authorizedUser?boolean
params.currency?string

Returns ​

Promise<SpotAPISuccessResponse<SpotV2CurrencyReference[]>>


getReferralAllRebateDetail() ​

ts
getReferralAllRebateDetail(params?: SpotReferralAllRebateDetailReq): Promise<object & Record<"data", SpotReferralAllRebateDetail[]> & object>;

Query All Rebate Detail

Query all rebate detail. Signature required. Read permission.

Parameters ​

ParameterType
params?SpotReferralAllRebateDetailReq

Returns ​

Promise<object & Record<"data", SpotReferralAllRebateDetail[]> & object>


getReferralInvitedUserList() ​

ts
getReferralInvitedUserList(params?: SpotReferralReferralsReq): Promise<object & Record<"data", SpotReferralReferral[]> & object>;

Query Invited User List

KOL users: query invited user list. Signature required. Read permission. Rate: 1/s.

Parameters ​

ParameterType
params?SpotReferralReferralsReq

Returns ​

Promise<object & Record<"data", SpotReferralReferral[]> & object>


getReferralMultipleRebateDetail() ​

ts
getReferralMultipleRebateDetail(params?: object): Promise<SpotAPISuccessResponse<SpotReferralAllRebateDetail[]>>;

Query Batcher Rebate Detail

Query rebate detail for multiple invitees. Signature required. Read permission.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotReferralAllRebateDetail[]>>


getReferralRebateDetail() ​

ts
getReferralRebateDetail(params: object): Promise<SpotAPISuccessResponse<SpotReferralRebateDetail>>;

Query Referral Rebate Detail

Query rebate info of invitee. Signature required. Read permission.

Parameters ​

ParameterType
params{ inviteeUid: number; }
params.inviteeUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotReferralRebateDetail>>


getReferralRebateHistory() ​

ts
getReferralRebateHistory(params: SpotReferralRebateHistoryReq): Promise<SpotAPISuccessResponse<SpotReferralRebateHistoryRecord[]>>;

Query Referral Rebate History

Query historical rebate of invitee. Signature required. Read permission.

Parameters ​

ParameterType
paramsSpotReferralRebateHistoryReq

Returns ​

Promise<SpotAPISuccessResponse<SpotReferralRebateHistoryRecord[]>>


getRepaymentRecords() ​

ts
getRepaymentRecords(params?: SpotRepaymentRecordReq): Promise<object & Record<"data", SpotRepaymentRecord[]> & object>;

Repayment Record Reference

Query repayment records. Sorted by repayTime. Main and sub-accounts. Signature required. Read permission. Rate: 2/2s.

Parameters ​

ParameterType
params?SpotRepaymentRecordReq

Returns ​

Promise<object & Record<"data", SpotRepaymentRecord[]> & object>


getSubUserAccounts() ​

ts
getSubUserAccounts(params: object): Promise<SpotAPISuccessResponse<SpotSubUserAccountsResult>>;

Get Sub User Account List

Query account list of sub user by UID. Signature required. Read permission.

Parameters ​

ParameterType
params{ subUid: number; }
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserAccountsResult>>


getSubUserApiKey() ​

ts
getSubUserApiKey(params?: object): Promise<SpotAPISuccessResponse<SpotSubUserApiKey[]>>;

Query API Key

Query own or sub user's API key info. Signature required. Read permission.

Parameters ​

ParameterType
params?{ accessKey?: string; uid?: number; }
params.accessKey?string
params.uid?number

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserApiKey[]>>


getSubUserBalance() ​

ts
getSubUserBalance(params: object): Promise<SpotAPISuccessResponse<SpotSubUserBalanceResult[]>>;

Get Account Balance of a Sub-User

Returns balance of sub-user by sub-uid. Signature required. Read permission. Rate: 20/2s.

Parameters ​

ParameterType
params{ subUid: number; }
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserBalanceResult[]>>


getSubUserDepositAddress() ​

ts
getSubUserDepositAddress(params: object): Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>;

Query Sub User Deposit Address

Query sub user's deposit address per chain. Signature required. Read permission.

Parameters ​

ParameterType
params{ currency?: string; subUid: number; }
params.currency?string
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>


getSubUserDepositHistory() ​

ts
getSubUserDepositHistory(params: SpotSubUserDepositHistoryReq): Promise<object & Record<"data", SpotSubUserDepositHistoryRecord[]> & object>;

Query Sub User Deposit History

Query sub user's deposit history. Signature required. Read permission.

Parameters ​

ParameterType
paramsSpotSubUserDepositHistoryReq

Returns ​

Promise<object & Record<"data", SpotSubUserDepositHistoryRecord[]> & object>


getSubUserEntrustUserList() ​

ts
getSubUserEntrustUserList(params?: object): Promise<object & Record<"data", {
  list: SpotSubUserEntrustUser[];
}> & object>;

Get Custody Trading Sub-Account List

Query list of sub-accounts currently being managed. Read permission.

Parameters ​

ParameterType
params?{ fromId?: number; limit?: number; }
params.fromId?number
params.limit?number

Returns ​

Promise<object & Record<"data", { list: SpotSubUserEntrustUser[]; }> & object>


getSubUserList() ​

ts
getSubUserList(params?: object): Promise<object & Record<"data", SpotSubUserList[]> & object>;

Get Sub User List

Query full list of sub users with UID and status. Signature required. Read permission.

Parameters ​

ParameterType
params?{ fromId?: number; }
params.fromId?number

Returns ​

Promise<object & Record<"data", SpotSubUserList[]> & object>


getSubUserManagedTransferHistory() ​

ts
getSubUserManagedTransferHistory(params?: SpotSubUserManagedTransferHistoryReq): Promise<SpotAPISuccessResponse<SpotSubUserManagedTransferRecord[]>>;

Get Managed Sub-Account Transfer History

Query transfer records of managed sub-accounts. Read permission.

Parameters ​

ParameterType
params?SpotSubUserManagedTransferHistoryReq

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserManagedTransferRecord[]>>


getSubUsersAggregatedBalance() ​

ts
getSubUsersAggregatedBalance(): Promise<SpotAPISuccessResponse<SpotSubUsersAggregatedBalance[]>>;

Get Aggregated Balance of All Sub Users

Returns aggregated balance from all sub-users. Signature required. Read permission. Rate: 2/2s.

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUsersAggregatedBalance[]>>


getSubUserStatus() ​

ts
getSubUserStatus(params: object): Promise<SpotAPISuccessResponse<SpotSubUserStatusResult>>;

Get Sub User Status

Query sub user status by UID. Signature required. Read permission.

Parameters ​

ParameterType
params{ subUid: number; }
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserStatusResult>>


getSymbolsSettings() ​

ts
getSymbolsSettings(params?: object): Promise<SpotAPISuccessResponse<SpotV1SymbolSettings[]>>;

Get Symbols Settings (V1)

Returns symbol settings. No signature required. Pass ts for incremental updates.

Parameters ​

ParameterType
params?{ ts?: number; }
params.ts?number

Returns ​

Promise<SpotAPISuccessResponse<SpotV1SymbolSettings[]>>


getTicker() ​

ts
getTicker(params: object): Promise<SpotAPISuccessResponse<SpotMergedTicker, "tick">>;

Get Latest Aggregated Ticker

Returns latest ticker with 24h aggregated market data. No signature required.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<SpotAPISuccessResponse<SpotMergedTicker, "tick">>

See ​

Read a public Spot price


getTickers() ​

ts
getTickers(): Promise<SpotAPISuccessResponse<SpotTicker[]>>;

Get Latest Tickers for All Pairs

Returns latest tickers for all supported pairs. No signature required.

Returns ​

Promise<SpotAPISuccessResponse<SpotTicker[]>>


getTimestamp() ​

ts
getTimestamp(): Promise<SpotAPISuccessResponse<number>>;

Get Current Timestamp (V1)

Returns current server time in milliseconds since epoch. No signature required.

Returns ​

Promise<SpotAPISuccessResponse<number>>


getTradingSymbols() ​

ts
getTradingSymbols(params?: object): Promise<SpotAPISuccessResponse<SpotTradingSymbol[]>>;

Get all Supported Trading Symbols (V2)

Returns all supported trading symbols. Pass ts for incremental updates.

Parameters ​

ParameterType
params?{ ts?: number; }
params.ts?number

Returns ​

Promise<SpotAPISuccessResponse<SpotTradingSymbol[]>>


getUniversalTransferRecords() ​

ts
getUniversalTransferRecords(params?: SpotUniversalTransferRecordsReq): Promise<SpotAPISuccessResponse<SpotUniversalTransferRecord[]>>;

Get Universal Transfer Records

Query universal transfer history. Host: spot. Trade permission. Rate: 5/2s.

Parameters ​

ParameterType
params?SpotUniversalTransferRecordsReq

Returns ​

Promise<SpotAPISuccessResponse<SpotUniversalTransferRecord[]>>


getUserUid() ​

ts
getUserUid(): Promise<SpotAPISuccessResponse<number>>;

Get UID

Get current user's UID. Signature required. Read permission.

Returns ​

Promise<SpotAPISuccessResponse<number>>


getVaspList() ​

ts
getVaspList(): Promise<SpotAPISuccessResponse<SpotVaspExchange[]>>;

Get Exchange VASP List

Exchange list for Korean users (withdraw flow). Public. No signature. Rate: 1/s.

Returns ​

Promise<SpotAPISuccessResponse<SpotVaspExchange[]>>


getWithdrawAddress() ​

ts
getWithdrawAddress(params?: SpotWithdrawAddressReq): Promise<object & Record<"data", SpotWithdrawAddress[]> & object>;

Query Withdraw Address

Query withdraw addresses available for API key. Parent user only. Signature required. Read permission.

Parameters ​

ParameterType
params?SpotWithdrawAddressReq

Returns ​

Promise<object & Record<"data", SpotWithdrawAddress[]> & object>


getWithdrawByClientId() ​

ts
getWithdrawByClientId(params: object): Promise<SpotAPISuccessResponse<
  | SpotDepositWithdrawRecord
| null>>;

Query Withdrawal by Client Order ID

Query withdraw order submitted with client-order-id. Signature required. Read permission.

Parameters ​

ParameterType
params{ clientOrderId: string; }
params.clientOrderIdstring

Returns ​

Promise<SpotAPISuccessResponse< | SpotDepositWithdrawRecord | null>>


getWithdrawQuota() ​

ts
getWithdrawQuota(params?: object): Promise<SpotAPISuccessResponse<SpotWithdrawQuota>>;

Query Withdraw Quota

Query withdrawing quota for currencies. Parent user only. Signature required. Read permission. Rate: 20/2s.

Parameters ​

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

Returns ​

Promise<SpotAPISuccessResponse<SpotWithdrawQuota>>


hasAccessToken() ​

ts
hasAccessToken(): boolean;

Return whether an access-token value is stored. This does not verify credentials or account access.

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


placeConditionalOrder() ​

ts
placeConditionalOrder(params: SpotV2AlgoOrdersPlaceReq): Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersPlaceResult>>;

Place a Conditional Order

Conditional orders only via this endpoint (not Trading section). Signature required. Trade permission. Rate: 20/2s.

Parameters ​

ParameterType
paramsSpotV2AlgoOrdersPlaceReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersPlaceResult>>


repayCrossMarginLoan() ​

ts
repayCrossMarginLoan(params: object): Promise<SpotAPISuccessResponse<null>>;

Repay Margin Loan (Cross)

Repays with asset in cross margin account. Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
params{ amount: string; orderId: string; }
params.amountstring
params.orderIdstring

Returns ​

Promise<SpotAPISuccessResponse<null>>


repayMarginLoan() ​

ts
repayMarginLoan(params: SpotMarginRepaymentReq): Promise<SpotAPISuccessResponse<SpotMarginRepaymentResult[]>>;

Repay Margin Loan (Cross/Isolated)

Loan interest paid first if no transactId. Main and sub-accounts. Signature required. Trade permission. Rate: 2/s.

Parameters ​

ParameterType
paramsSpotMarginRepaymentReq

Returns ​

Promise<SpotAPISuccessResponse<SpotMarginRepaymentResult[]>>


repayMarginLoanIsolated() ​

ts
repayMarginLoanIsolated(params: object): Promise<SpotAPISuccessResponse<number>>;

Repay Margin Loan (Isolated)

Repays with asset in margin account. Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
params{ amount: string; orderId: string; }
params.amountstring
params.orderIdstring

Returns ​

Promise<SpotAPISuccessResponse<number>>


requestCrossMarginLoan() ​

ts
requestCrossMarginLoan(params: object): Promise<SpotAPISuccessResponse<number>>;

Request a Margin Loan (Cross)

Places order to borrow margin. Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
params{ amount?: string; currency?: string; }
params.amount?string
params.currency?string

Returns ​

Promise<SpotAPISuccessResponse<number>>


requestMarginLoan() ​

ts
requestMarginLoan(params: SpotMarginLoanOrderReq): Promise<SpotAPISuccessResponse<number>>;

Request a Margin Loan (Isolated)

Places order to borrow margin. Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
paramsSpotMarginLoanOrderReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Store an access-token value on the client. Private REST requests still require apiKey and apiSecret.

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


setBrokerSubUserFeeRate() ​

ts
setBrokerSubUserFeeRate(params: SpotBrokerSubUserFeeRateAddReq): Promise<SpotAPISuccessResponse<SpotBrokerFeeRateAddResult>>;

Set Broker Sub-User Fee Rate

Set trading fee rate for sub-accounts. Signature required. Read permission. Rate: 100/2s.

Parameters ​

ParameterType
paramsSpotBrokerSubUserFeeRateAddReq

Returns ​

Promise<SpotAPISuccessResponse<SpotBrokerFeeRateAddResult>>


setCancelAllAfter() ​

ts
setCancelAllAfter(params: object): Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancelAllAfterResult>>;

Dead Man's Switch (Cancel All After)

Turn on/off. timeout=0 to turn off. timeout>=5 to turn on: must call twice within timeout seconds or all spot orders (max 500) are canceled. Signature required. Trade permission.

Parameters ​

ParameterType
params{ timeout: number; }
params.timeoutnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancelAllAfterResult>>


setSubUserTradableMarket() ​

ts
setSubUserTradableMarket(params: SpotSubUserTradableMarketReq): Promise<SpotAPISuccessResponse<SpotSubUserTradableMarketResult[]>>;

Set Tradable Market for Sub Users

Set tradable market (isolated/cross margin) for sub users. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotSubUserTradableMarketReq

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserTradableMarketResult[]>>


setSubUserTransferPermissions() ​

ts
setSubUserTransferPermissions(params: SpotSubUserTransferPermissionsReq): Promise<SpotAPISuccessResponse<SpotSubUserTransferPermissionsResult[]>>;

Set Asset Transfer Permission for Sub Users

Set asset transfer permission for sub users. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotSubUserTransferPermissionsReq

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserTransferPermissionsResult[]>>


submitBatchOrders() ​

ts
submitBatchOrders(params: SpotV1OrderPlaceReq[]): Promise<SpotAPISuccessResponse<SpotV1OrderBatchPlaceResult[]>>;

Place a Batch of Orders

Max 10 orders per batch. Each returns order-id or err-code/err-msg. Signature required. Trade permission. Rate: 50/2s.

Parameters ​

ParameterType
paramsSpotV1OrderPlaceReq[]

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderBatchPlaceResult[]>>


submitFuturesTransfer() ​

ts
submitFuturesTransfer(params: SpotV1FuturesTransferReq): Promise<SpotAPISuccessResponse<number>>;

Futures Transfer

Transfer between spot and future contract account. pro-to-futures = spot -> contract, futures-to-pro = contract -> spot. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotV1FuturesTransferReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


submitMarginOrder() ​

ts
submitMarginOrder(params: SpotV1OrderAutoPlaceReq): Promise<SpotAPISuccessResponse<SpotV1OrderAutoPlaceResult>>;

Margin Order (Auto Borrow/Repay)

Auto borrow to place or auto repay. Sub-accounts not supported. Use amount or market-amount. Signature required. Trade permission. Rate: 100/2s.

Parameters ​

ParameterType
paramsSpotV1OrderAutoPlaceReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV1OrderAutoPlaceResult>>


submitOrder() ​

ts
submitOrder(params: SpotV1OrderPlaceReq): Promise<SpotAPISuccessResponse<string>>;

Place a New Order

Places order to be matched. Set account-id and source per account type. Signature required. Trade permission. Rate: 100/2s.

Parameters ​

ParameterType
paramsSpotV1OrderPlaceReq

Returns ​

Promise<SpotAPISuccessResponse<string>>

See ​

Spot order management


submitPointTransfer() ​

ts
submitPointTransfer(params: SpotV2PointTransferReq): Promise<SpotAPISuccessResponse<SpotV2PointTransfer>>;

Point Transfer

Transfer points between parent and sub user. groupId=0 for termless; for terminable query sub balance first. Signature required. Trade permission. Rate: 2/s.

Parameters ​

ParameterType
paramsSpotV2PointTransferReq

Returns ​

Promise<SpotAPISuccessResponse<SpotV2PointTransfer>>


submitSubUserTransfer() ​

ts
submitSubUserTransfer(params: SpotSubUserTransferReq): Promise<SpotAPISuccessResponse<number>>;

Transfer Asset between Parent and Sub Account

Transfer asset between parent and sub account. Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
paramsSpotSubUserTransferReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


submitTransfer() ​

ts
submitTransfer(params: SpotAccountTransferReq): Promise<SpotAPISuccessResponse<SpotAccountTransferResult>>;

Asset Transfer

Transfer asset between accounts (spot, margin, sub-users). Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotAccountTransferReq

Returns ​

Promise<SpotAPISuccessResponse<SpotAccountTransferResult>>


submitUniversalTransfer() ​

ts
submitUniversalTransfer(params: SpotUniversalTransferReq): Promise<SpotAPISuccessResponse<SpotUniversalTransferResult>>;

Create Universal Transfer

Transfer between account types (spot, margin, futures, options, etc). Host: spot. Trade permission. Rate: 5/2s.

Parameters ​

ParameterType
paramsSpotUniversalTransferReq

Returns ​

Promise<SpotAPISuccessResponse<SpotUniversalTransferResult>>


submitV2AccountTransfer() ​

ts
submitV2AccountTransfer(params: SpotV2AccountTransferReq): Promise<SpotAPISuccessResponse<number>>;

V2 Account Transfer

Transfer funds between spot, linear-swap, otc, futures, swap. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotV2AccountTransferReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


submitWithdraw() ​

ts
submitWithdraw(params: SpotWithdrawCreateReq): Promise<SpotAPISuccessResponse<number>>;

Create Withdraw Request

Create withdraw to address in your withdraw list. Parent user only. Withdraw permission. Rate: 20/2s.

api-not-support-temp-addr means this address is not enabled for API withdrawal (Verification-exempt API checkbox, or the key's custom address list). Web whitelist status white on GET /v2/account/withdraw/address does not by itself enable the API withdraw path.

Parameters ​

ParameterType
paramsSpotWithdrawCreateReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


transferCrossMarginToSpot() ​

ts
transferCrossMarginToSpot(params: object): Promise<SpotAPISuccessResponse<number>>;

Transfer Asset from Cross Margin Account to Spot Trading Account

Signature required. Trade permission.

Parameters ​

ParameterType
params{ amount?: string; currency?: string; }
params.amount?string
params.currency?string

Returns ​

Promise<SpotAPISuccessResponse<number>>


transferIsolatedMarginToSpot() ​

ts
transferIsolatedMarginToSpot(params: SpotMarginTransferOutIsolatedReq): Promise<SpotAPISuccessResponse<number>>;

Transfer Asset from Isolated Margin Account to Spot Trading Account

Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
paramsSpotMarginTransferOutIsolatedReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


transferSpotToCrossMargin() ​

ts
transferSpotToCrossMargin(params: object): Promise<SpotAPISuccessResponse<number>>;

Transfer Asset from Spot Trading Account to Cross Margin Account

Signature required. Trade permission.

Parameters ​

ParameterType
params{ amount?: string; currency?: string; }
params.amount?string
params.currency?string

Returns ​

Promise<SpotAPISuccessResponse<number>>


transferSpotToIsolatedMargin() ​

ts
transferSpotToIsolatedMargin(params: SpotMarginTransferInIsolatedReq): Promise<SpotAPISuccessResponse<number>>;

Transfer Asset from Spot Trading Account to Isolated Margin Account

Signature required. Trade permission. Rate: 2/2s.

Parameters ​

ParameterType
paramsSpotMarginTransferInIsolatedReq

Returns ​

Promise<SpotAPISuccessResponse<number>>


updateFeeDeductionMethod() ​

ts
updateFeeDeductionMethod(params: object): Promise<SpotAPISuccessResponse<null>>;

Set Spot/Margin Fee Deduction Method

switchType: 0=point card, 1=currency (pass deductionCurrency), 2=close. Signature required. Read permission. Rate: 2/s.

Parameters ​

ParameterType
params{ deductionCurrency?: string; switchType: 0 | 1 | 2; }
params.deductionCurrency?string
params.switchType0 | 1 | 2

Returns ​

Promise<SpotAPISuccessResponse<null>>


updateSubUserApiKey() ​

ts
updateSubUserApiKey(params: SpotSubUserApiKeyUpdateReq): Promise<SpotAPISuccessResponse<SpotSubUserApiKeyUpdateResult>>;

Modify Sub User API Key

Modify sub user's API key. Signature required. Trade permission.

Parameters ​

ParameterType
paramsSpotSubUserApiKeyUpdateReq

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserApiKeyUpdateResult>>


updateSubUserDeductMode() ​

ts
updateSubUserDeductMode(params?: object): Promise<SpotAPISuccessResponse<SpotSubUserDeductModeResult[]>>;

Set Deduction Mode

Set deduction fee (HT or point) for parent and sub user. Signature required. Trade permission.

Parameters ​

ParameterType
params?{ deductMode?: "sub" | "master"; subUids?: string; }
params.deductMode?"sub" | "master"
params.subUids?string

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserDeductModeResult[]>>


updateSubUserLockStatus() ​

ts
updateSubUserLockStatus(params: object): Promise<SpotAPISuccessResponse<SpotSubUserLockStatusResult>>;

Lock/Unlock Sub User

Lock or unlock a sub user. Signature required. Trade permission. Rate: 20/2s.

Parameters ​

ParameterType
params{ action: "lock" | "unlock"; subUid: number; }
params.action"lock" | "unlock"
params.subUidnumber

Returns ​

Promise<SpotAPISuccessResponse<SpotSubUserLockStatusResult>>

Built by Siebly. Open source SDKs for exchange APIs.