Class: SpotClient
REST client for HTX Spot market data, trading and account operations.
Extends
BaseRestClient
Constructors
Constructor
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
| Parameter | Type | Description |
|---|---|---|
restClientOptions? | RestClientOptions | options to configure REST API connectivity |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
SpotClient
Inherited from
BaseRestClient.constructor
Methods
batchCancelOpenOrders()
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
| Parameter | Type |
|---|---|
params? | SpotV1OrderBatchCancelOpenOrdersReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelOpenOrdersResult>>
batchCancelOrders()
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
| Parameter | Type |
|---|---|
params | { "client-order-ids"?: string[]; "order-ids"?: string[]; } |
params.client-order-ids? | string[] |
params.order-ids? | string[] |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderBatchCancelResult>>
cancelAllOrders()
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
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<SpotAPISuccessResponse<null>>
cancelConditionalOrders()
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
| Parameter | Type |
|---|---|
params | { clientOrderIds: string[]; } |
params.clientOrderIds | string[] |
Returns
Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancellationResult>>
cancelOrderByClientId()
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
| Parameter | Type |
|---|---|
params | { "client-order-id": string; } |
params.client-order-id | string |
Returns
Promise<SpotAPISuccessResponse<number>>
cancelOrderById()
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
| Parameter | Type |
|---|---|
params | { orderId: string; symbol?: string; } |
params.orderId | string |
params.symbol? | string |
Returns
Promise<SpotAPISuccessResponse<string>>
See
cancelWithdraw()
cancelWithdraw(params: object): Promise<SpotAPISuccessResponse<number>>;Cancel Withdraw Request
Cancel withdraw by transfer id. Parent user only. Withdraw permission. Rate: 20/2s.
Parameters
| Parameter | Type |
|---|---|
params | { withdrawId: number; } |
params.withdrawId | number |
Returns
Promise<SpotAPISuccessResponse<number>>
createSubUser()
createSubUser(params: object): Promise<SpotAPISuccessResponse<SpotSubUserCreationResult[]>>;Create Sub Users
Create sub users, max 50 at a time. Signature required. Trade permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
params | { subAccountType?: string; userList: object[]; } | - |
params.subAccountType? | string | GENERAL (default), CONTACT, GRID, FIRE-BLOCK |
params.userList | object[] | Sub users to create, max 50 |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserCreationResult[]>>
createSubUserApiKey()
createSubUserApiKey(params: SpotSubUserApiKeyCreationReq): Promise<SpotAPISuccessResponse<SpotSubUserApiKeyCreationResult>>;Create Sub User API Key
Create API key for sub user. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotSubUserApiKeyCreationReq |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserApiKeyCreationResult>>
deleteSubUserApiKey()
deleteSubUserApiKey(params: object): Promise<SpotAPISuccessResponse<null>>;Delete Sub User API Key
Delete sub user's API key. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { accessKey: string; subUid: number; } |
params.accessKey | string |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<null>>
earnRedeem()
earnRedeem(params: SpotEarnRedeemReq): Promise<SpotAPISuccessResponse<SpotEarnRedeemResult>>;Earn Redemption
Redeem Earn product. Signature required. Trade permission. Arrival may be delayed.
Parameters
| Parameter | Type |
|---|---|
params | SpotEarnRedeemReq |
Returns
Promise<SpotAPISuccessResponse<SpotEarnRedeemResult>>
earnSubscribe()
earnSubscribe(params: SpotEarnSubscribeReq): Promise<SpotAPISuccessResponse<SpotEarnSubscribeResult>>;Earn Subscription
Subscribe to Earn product. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotEarnSubscribeReq |
Returns
Promise<SpotAPISuccessResponse<SpotEarnSubscribeResult>>
generateNewOrderID()
generateNewOrderID(): string;Misc Utility Methods
Returns
string
get24hMarketSummary()
get24hMarketSummary(params: object): Promise<SpotAPISuccessResponse<SpotDetailTick, "tick">>;Get the Last 24h Market Summary
Returns 24h trading summary for a symbol. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<SpotAPISuccessResponse<SpotDetailTick, "tick">>
getAccountBalance()
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
| Parameter | Type |
|---|---|
params | { accountId: string | number; } |
params.accountId | string | number |
Returns
Promise<SpotAPISuccessResponse<SpotAccountBalance>>
See
getAccountHistory()
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
| Parameter | Type |
|---|---|
params | SpotGetAccountHistoryReq |
Returns
Promise<object & Record<"data", SpotAccountHistory[]> & object>
getAccountLedger()
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
| Parameter | Type |
|---|---|
params? | SpotGetAccountLedgerReq |
Returns
Promise<object & Record<"data", SpotV2AccountLedger[]> & object>
getAccountOverviewInfo()
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()
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()
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()
getAccountValuation(params?: object): Promise<SpotAPISuccessResponse<SpotV2AccountValuation>>;Get The Total Valuation of Platform Assets
Returns total asset valuation in BTC or fiat. Signature required.
Parameters
| Parameter | Type |
|---|---|
params? | { accountType?: string; valuationCurrency?: string; } |
params.accountType? | string |
params.valuationCurrency? | string |
Returns
Promise<SpotAPISuccessResponse<SpotV2AccountValuation>>
getAssetValuation()
getAssetValuation(params?: SpotGetAssetValuationReq): Promise<SpotAPISuccessResponse<SpotV2AssetValuation>>;Get Asset Valuation
Returns valuation of total assets in BTC or fiat. Signature required.
Parameters
| Parameter | Type |
|---|---|
params? | SpotGetAssetValuationReq |
Returns
Promise<SpotAPISuccessResponse<SpotV2AssetValuation>>
getBrokerAccountCapitalSnapshot()
getBrokerAccountCapitalSnapshot(params: SpotBrokerAccountCapitalSnapshotReq): Promise<SpotAPISuccessResponse<SpotBrokerAccountCapitalSnapshot[]>>;Get Account Capital Snapshot
Request account asset snapshot. Signature required. Read permission. Rate: 100/2s.
Parameters
| Parameter | Type |
|---|---|
params | SpotBrokerAccountCapitalSnapshotReq |
Returns
Promise<SpotAPISuccessResponse<SpotBrokerAccountCapitalSnapshot[]>>
getBrokerSubUserFeeRate()
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
| Parameter | Type | Description |
|---|---|---|
params | { bizType: string; subUId: string; } | - |
params.bizType | string | 1 Spot, 2 U-standard linear, 3 Coin-Margined swap |
params.subUId | string | Sub-account id (user_id, UID minus last digit) |
Returns
Promise<SpotAPISuccessResponse<SpotBrokerSubUserFeeRate>>
getBrokerUserRebateStatus()
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
| Parameter | Type | Description |
|---|---|---|
params | { queryUid: string; } | - |
params.queryUid | string | User UID to check |
Returns
Promise<SpotAPISuccessResponse<SpotBrokerUserRebateStatus>>
getChainsInfo()
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
| Parameter | Type |
|---|---|
params? | SpotGetChainsReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1ChainInfo[]>>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getConditionalOrder()
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
| Parameter | Type |
|---|---|
params | { clientOrderId: string; } |
params.clientOrderId | string |
Returns
Promise<SpotAPISuccessResponse<SpotV2AlgoOrder>>
getConditionalOrderHistory()
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
| Parameter | Type |
|---|---|
params? | SpotV2AlgoOrdersHistoryReq |
Returns
Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>
getCrossMarginBalance()
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
| Parameter | Type |
|---|---|
params? | { "sub-uid"?: number; } |
params.sub-uid? | number |
Returns
Promise<SpotAPISuccessResponse<SpotCrossMarginAccountBalance>>
getCrossMarginLimit()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<SpotMarginLimit[]>>
getCrossMarginLoanInfo()
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()
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
| Parameter | Type |
|---|---|
params? | SpotCrossMarginLoanOrdersReq |
Returns
Promise<SpotAPISuccessResponse<SpotCrossMarginLoanOrder[]>>
getCurrencies()
getCurrencies(params?: object): Promise<SpotAPISuccessResponse<SpotCurrency[]>>;Get all Supported Currencies (V2)
Returns all supported currencies. Pass ts for incremental updates.
Parameters
| Parameter | Type |
|---|---|
params? | { ts?: number; } |
params.ts? | number |
Returns
Promise<SpotAPISuccessResponse<SpotCurrency[]>>
getCurrencysSettings()
getCurrencysSettings(params?: object): Promise<SpotAPISuccessResponse<SpotV1CurrencySettings[]>>;Get currency settings from the V1 public reference endpoint. The method name retains the published SDK spelling.
Parameters
| Parameter | Type |
|---|---|
params? | { ts?: number; } |
params.ts? | number |
Returns
Promise<SpotAPISuccessResponse<SpotV1CurrencySettings[]>>
getDepositAddress()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>
getDepositWithdrawHistory()
getDepositWithdrawHistory(params: SpotDepositWithdrawQueryReq): Promise<SpotAPISuccessResponse<SpotDepositWithdrawRecord[]>>;Search Deposit/Withdraw Records
Search existed withdraws and deposits. Signature required. Read permission. Rate: 20/2s.
Parameters
| Parameter | Type |
|---|---|
params | SpotDepositWithdrawQueryReq |
Returns
Promise<SpotAPISuccessResponse<SpotDepositWithdrawRecord[]>>
getEarnProjectList()
getEarnProjectList(params: SpotEarnProjectListReq): Promise<SpotAPISuccessResponse<{
items: SpotEarnProject[];
total: number;
}>>;Query Earn Product List
Product query. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotEarnProjectListReq |
Returns
Promise<SpotAPISuccessResponse<{ items: SpotEarnProject[]; total: number; }>>
getEarnUserAssets()
getEarnUserAssets(params: SpotEarnUserAssetsReq): Promise<SpotAPISuccessResponse<{
items: SpotEarnUserAsset[];
total: number;
}>>;Query Earn User Assets
Position query. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotEarnUserAssetsReq |
Returns
Promise<SpotAPISuccessResponse<{ items: SpotEarnUserAsset[]; total: number; }>>
getFeeRate()
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
| Parameter | Type |
|---|---|
params | { symbols: string; } |
params.symbols | string |
Returns
Promise<SpotAPISuccessResponse<SpotV2TransactFeeRate[]>>
getFullOrderBook()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<SpotAPISuccessResponse<SpotDepth, "tick">>
getHistoryTrades()
getHistoryTrades(params: object): Promise<SpotAPISuccessResponse<SpotTradeTimestampGroup[]>>;Get the Most Recent Trades
Returns recent trades grouped by timestamp. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | { size?: number; symbol: string; } |
params.size? | number |
params.symbol | string |
Returns
Promise<SpotAPISuccessResponse<SpotTradeTimestampGroup[]>>
getKlines()
getKlines(params: SpotGetKlineReq): Promise<SpotAPISuccessResponse<SpotKline[]>>;Get Klines (Candles)
Returns candlestick data for a symbol. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | SpotGetKlineReq |
Returns
Promise<SpotAPISuccessResponse<SpotKline[]>>
getLastTrade()
getLastTrade(params: object): Promise<SpotAPISuccessResponse<SpotLastTrade, "tick">>;Get the Last Trade
Returns latest trade with price, volume, direction. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<SpotAPISuccessResponse<SpotLastTrade, "tick">>
getMarginAccountBalance()
getMarginAccountBalance(params?: object): Promise<SpotAPISuccessResponse<SpotMarginAccountBalance[]>>;Get the Balance of the Margin Loan Account (Isolated)
Signature required. Read permission. Rate: 100/2s.
Parameters
| Parameter | Type |
|---|---|
params? | { "sub-uid"?: number; symbol?: string; } |
params.sub-uid? | number |
params.symbol? | string |
Returns
Promise<SpotAPISuccessResponse<SpotMarginAccountBalance[]>>
getMarginLoanInfo()
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
| Parameter | Type |
|---|---|
params? | { symbols?: string; } |
params.symbols? | string |
Returns
Promise<SpotAPISuccessResponse<SpotMarginLoanInfo[]>>
getMarginLoanOrders()
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
| Parameter | Type |
|---|---|
params? | SpotMarginLoanOrdersReq |
Returns
Promise<SpotAPISuccessResponse<SpotMarginLoanOrder[]>>
getMarketDepth()
getMarketDepth(params: SpotGetDepthReq): Promise<SpotAPISuccessResponse<SpotDepth, "tick">>;Get Market Depth
Returns order book for a symbol. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | SpotGetDepthReq |
Returns
Promise<SpotAPISuccessResponse<SpotDepth, "tick">>
See
getMarketStatus()
getMarketStatus(): Promise<SpotMarketStatusResponse>;Get Market Status
Returns current market status. 1=normal, 2=halted, 3=cancel-only.
Returns
Promise<SpotMarketStatusResponse>
getMarketSymbolsSettings()
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
| Parameter | Type |
|---|---|
params? | { symbols?: string; ts?: number; } |
params.symbols? | string |
params.ts? | number |
Returns
Promise<SpotAPISuccessResponse<SpotV1MarketSymbolSettings[]>>
getMatchResults()
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
| Parameter | Type |
|---|---|
params? | SpotGetMatchResultsReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>
getOpenConditionalOrders()
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
| Parameter | Type |
|---|---|
params? | SpotV2AlgoOrdersOpeningReq |
Returns
Promise<object & Record<"data", SpotV2AlgoOrder[]> & object>
getOpenOrders()
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
| Parameter | Type |
|---|---|
params? | SpotGetOpenOrdersReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OpenOrder[]>>
getOrder()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>
See
getOrderByClientId()
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
| Parameter | Type |
|---|---|
params | { clientOrderId: string; } |
params.clientOrderId | string |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderDetail>>
See
getOrderHistory()
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
| Parameter | Type |
|---|---|
params | SpotGetOrderHistoryReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderHistory[]>>
getOrderHistory48h()
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
| Parameter | Type |
|---|---|
params? | SpotGetOrderHistory48hReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderHistory48h[]>>
getOrderMatch()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderMatchResult[]>>
See
getP2POrderHistory()
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
| Parameter | Type |
|---|---|
params? | SpotP2POrderHistoryReq |
Returns
Promise<SpotAPISuccessResponse<{ openApiC2COrderInfoVOList: SpotP2POrderHistory[]; ts: number; }>>
getPointBalance()
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
| Parameter | Type |
|---|---|
params? | { subUid?: string; } |
params.subUid? | string |
Returns
Promise<SpotAPISuccessResponse<SpotV2PointAccount>>
getReferenceCurrencies()
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
| Parameter | Type |
|---|---|
params? | { authorizedUser?: boolean; currency?: string; } |
params.authorizedUser? | boolean |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<SpotV2CurrencyReference[]>>
getReferralAllRebateDetail()
getReferralAllRebateDetail(params?: SpotReferralAllRebateDetailReq): Promise<object & Record<"data", SpotReferralAllRebateDetail[]> & object>;Query All Rebate Detail
Query all rebate detail. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | SpotReferralAllRebateDetailReq |
Returns
Promise<object & Record<"data", SpotReferralAllRebateDetail[]> & object>
getReferralInvitedUserList()
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
| Parameter | Type |
|---|---|
params? | SpotReferralReferralsReq |
Returns
Promise<object & Record<"data", SpotReferralReferral[]> & object>
getReferralMultipleRebateDetail()
getReferralMultipleRebateDetail(params?: object): Promise<SpotAPISuccessResponse<SpotReferralAllRebateDetail[]>>;Query Batcher Rebate Detail
Query rebate detail for multiple invitees. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | { inviteeUidList?: string; } |
params.inviteeUidList? | string |
Returns
Promise<SpotAPISuccessResponse<SpotReferralAllRebateDetail[]>>
getReferralRebateDetail()
getReferralRebateDetail(params: object): Promise<SpotAPISuccessResponse<SpotReferralRebateDetail>>;Query Referral Rebate Detail
Query rebate info of invitee. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | { inviteeUid: number; } |
params.inviteeUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotReferralRebateDetail>>
getReferralRebateHistory()
getReferralRebateHistory(params: SpotReferralRebateHistoryReq): Promise<SpotAPISuccessResponse<SpotReferralRebateHistoryRecord[]>>;Query Referral Rebate History
Query historical rebate of invitee. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotReferralRebateHistoryReq |
Returns
Promise<SpotAPISuccessResponse<SpotReferralRebateHistoryRecord[]>>
getRepaymentRecords()
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
| Parameter | Type |
|---|---|
params? | SpotRepaymentRecordReq |
Returns
Promise<object & Record<"data", SpotRepaymentRecord[]> & object>
getSubUserAccounts()
getSubUserAccounts(params: object): Promise<SpotAPISuccessResponse<SpotSubUserAccountsResult>>;Get Sub User Account List
Query account list of sub user by UID. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | { subUid: number; } |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserAccountsResult>>
getSubUserApiKey()
getSubUserApiKey(params?: object): Promise<SpotAPISuccessResponse<SpotSubUserApiKey[]>>;Query API Key
Query own or sub user's API key info. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | { accessKey?: string; uid?: number; } |
params.accessKey? | string |
params.uid? | number |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserApiKey[]>>
getSubUserBalance()
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
| Parameter | Type |
|---|---|
params | { subUid: number; } |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserBalanceResult[]>>
getSubUserDepositAddress()
getSubUserDepositAddress(params: object): Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>;Query Sub User Deposit Address
Query sub user's deposit address per chain. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | { currency?: string; subUid: number; } |
params.currency? | string |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotDepositAddress[]>>
getSubUserDepositHistory()
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
| Parameter | Type |
|---|---|
params | SpotSubUserDepositHistoryReq |
Returns
Promise<object & Record<"data", SpotSubUserDepositHistoryRecord[]> & object>
getSubUserEntrustUserList()
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
| Parameter | Type |
|---|---|
params? | { fromId?: number; limit?: number; } |
params.fromId? | number |
params.limit? | number |
Returns
Promise<object & Record<"data", { list: SpotSubUserEntrustUser[]; }> & object>
getSubUserList()
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
| Parameter | Type |
|---|---|
params? | { fromId?: number; } |
params.fromId? | number |
Returns
Promise<object & Record<"data", SpotSubUserList[]> & object>
getSubUserManagedTransferHistory()
getSubUserManagedTransferHistory(params?: SpotSubUserManagedTransferHistoryReq): Promise<SpotAPISuccessResponse<SpotSubUserManagedTransferRecord[]>>;Get Managed Sub-Account Transfer History
Query transfer records of managed sub-accounts. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | SpotSubUserManagedTransferHistoryReq |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserManagedTransferRecord[]>>
getSubUsersAggregatedBalance()
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()
getSubUserStatus(params: object): Promise<SpotAPISuccessResponse<SpotSubUserStatusResult>>;Get Sub User Status
Query sub user status by UID. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | { subUid: number; } |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserStatusResult>>
getSymbolsSettings()
getSymbolsSettings(params?: object): Promise<SpotAPISuccessResponse<SpotV1SymbolSettings[]>>;Get Symbols Settings (V1)
Returns symbol settings. No signature required. Pass ts for incremental updates.
Parameters
| Parameter | Type |
|---|---|
params? | { ts?: number; } |
params.ts? | number |
Returns
Promise<SpotAPISuccessResponse<SpotV1SymbolSettings[]>>
getTicker()
getTicker(params: object): Promise<SpotAPISuccessResponse<SpotMergedTicker, "tick">>;Get Latest Aggregated Ticker
Returns latest ticker with 24h aggregated market data. No signature required.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<SpotAPISuccessResponse<SpotMergedTicker, "tick">>
See
getTickers()
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()
getTimestamp(): Promise<SpotAPISuccessResponse<number>>;Get Current Timestamp (V1)
Returns current server time in milliseconds since epoch. No signature required.
Returns
Promise<SpotAPISuccessResponse<number>>
getTradingSymbols()
getTradingSymbols(params?: object): Promise<SpotAPISuccessResponse<SpotTradingSymbol[]>>;Get all Supported Trading Symbols (V2)
Returns all supported trading symbols. Pass ts for incremental updates.
Parameters
| Parameter | Type |
|---|---|
params? | { ts?: number; } |
params.ts? | number |
Returns
Promise<SpotAPISuccessResponse<SpotTradingSymbol[]>>
getUniversalTransferRecords()
getUniversalTransferRecords(params?: SpotUniversalTransferRecordsReq): Promise<SpotAPISuccessResponse<SpotUniversalTransferRecord[]>>;Get Universal Transfer Records
Query universal transfer history. Host: spot. Trade permission. Rate: 5/2s.
Parameters
| Parameter | Type |
|---|---|
params? | SpotUniversalTransferRecordsReq |
Returns
Promise<SpotAPISuccessResponse<SpotUniversalTransferRecord[]>>
getUserUid()
getUserUid(): Promise<SpotAPISuccessResponse<number>>;Get UID
Get current user's UID. Signature required. Read permission.
Returns
Promise<SpotAPISuccessResponse<number>>
getVaspList()
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()
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
| Parameter | Type |
|---|---|
params? | SpotWithdrawAddressReq |
Returns
Promise<object & Record<"data", SpotWithdrawAddress[]> & object>
getWithdrawByClientId()
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
| Parameter | Type |
|---|---|
params | { clientOrderId: string; } |
params.clientOrderId | string |
Returns
Promise<SpotAPISuccessResponse< | SpotDepositWithdrawRecord | null>>
getWithdrawQuota()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<SpotWithdrawQuota>>
hasAccessToken()
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()
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
| Parameter | Type |
|---|---|
params | SpotV2AlgoOrdersPlaceReq |
Returns
Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersPlaceResult>>
repayCrossMarginLoan()
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
| Parameter | Type |
|---|---|
params | { amount: string; orderId: string; } |
params.amount | string |
params.orderId | string |
Returns
Promise<SpotAPISuccessResponse<null>>
repayMarginLoan()
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
| Parameter | Type |
|---|---|
params | SpotMarginRepaymentReq |
Returns
Promise<SpotAPISuccessResponse<SpotMarginRepaymentResult[]>>
repayMarginLoanIsolated()
repayMarginLoanIsolated(params: object): Promise<SpotAPISuccessResponse<number>>;Repay Margin Loan (Isolated)
Repays with asset in margin account. Signature required. Trade permission. Rate: 2/2s.
Parameters
| Parameter | Type |
|---|---|
params | { amount: string; orderId: string; } |
params.amount | string |
params.orderId | string |
Returns
Promise<SpotAPISuccessResponse<number>>
requestCrossMarginLoan()
requestCrossMarginLoan(params: object): Promise<SpotAPISuccessResponse<number>>;Request a Margin Loan (Cross)
Places order to borrow margin. Signature required. Trade permission. Rate: 2/2s.
Parameters
| Parameter | Type |
|---|---|
params | { amount?: string; currency?: string; } |
params.amount? | string |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<number>>
requestMarginLoan()
requestMarginLoan(params: SpotMarginLoanOrderReq): Promise<SpotAPISuccessResponse<number>>;Request a Margin Loan (Isolated)
Places order to borrow margin. Signature required. Trade permission. Rate: 2/2s.
Parameters
| Parameter | Type |
|---|---|
params | SpotMarginLoanOrderReq |
Returns
Promise<SpotAPISuccessResponse<number>>
setAccessToken()
setAccessToken(newAccessToken: string): void;Store an access-token value on the client. Private REST requests still require apiKey and apiSecret.
Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
setBrokerSubUserFeeRate()
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
| Parameter | Type |
|---|---|
params | SpotBrokerSubUserFeeRateAddReq |
Returns
Promise<SpotAPISuccessResponse<SpotBrokerFeeRateAddResult>>
setCancelAllAfter()
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
| Parameter | Type |
|---|---|
params | { timeout: number; } |
params.timeout | number |
Returns
Promise<SpotAPISuccessResponse<SpotV2AlgoOrdersCancelAllAfterResult>>
setSubUserTradableMarket()
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
| Parameter | Type |
|---|---|
params | SpotSubUserTradableMarketReq |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserTradableMarketResult[]>>
setSubUserTransferPermissions()
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
| Parameter | Type |
|---|---|
params | SpotSubUserTransferPermissionsReq |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserTransferPermissionsResult[]>>
submitBatchOrders()
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
| Parameter | Type |
|---|---|
params | SpotV1OrderPlaceReq[] |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderBatchPlaceResult[]>>
submitFuturesTransfer()
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
| Parameter | Type |
|---|---|
params | SpotV1FuturesTransferReq |
Returns
Promise<SpotAPISuccessResponse<number>>
submitMarginOrder()
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
| Parameter | Type |
|---|---|
params | SpotV1OrderAutoPlaceReq |
Returns
Promise<SpotAPISuccessResponse<SpotV1OrderAutoPlaceResult>>
submitOrder()
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
| Parameter | Type |
|---|---|
params | SpotV1OrderPlaceReq |
Returns
Promise<SpotAPISuccessResponse<string>>
See
submitPointTransfer()
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
| Parameter | Type |
|---|---|
params | SpotV2PointTransferReq |
Returns
Promise<SpotAPISuccessResponse<SpotV2PointTransfer>>
submitSubUserTransfer()
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
| Parameter | Type |
|---|---|
params | SpotSubUserTransferReq |
Returns
Promise<SpotAPISuccessResponse<number>>
submitTransfer()
submitTransfer(params: SpotAccountTransferReq): Promise<SpotAPISuccessResponse<SpotAccountTransferResult>>;Asset Transfer
Transfer asset between accounts (spot, margin, sub-users). Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotAccountTransferReq |
Returns
Promise<SpotAPISuccessResponse<SpotAccountTransferResult>>
submitUniversalTransfer()
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
| Parameter | Type |
|---|---|
params | SpotUniversalTransferReq |
Returns
Promise<SpotAPISuccessResponse<SpotUniversalTransferResult>>
submitV2AccountTransfer()
submitV2AccountTransfer(params: SpotV2AccountTransferReq): Promise<SpotAPISuccessResponse<number>>;V2 Account Transfer
Transfer funds between spot, linear-swap, otc, futures, swap. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotV2AccountTransferReq |
Returns
Promise<SpotAPISuccessResponse<number>>
submitWithdraw()
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
| Parameter | Type |
|---|---|
params | SpotWithdrawCreateReq |
Returns
Promise<SpotAPISuccessResponse<number>>
transferCrossMarginToSpot()
transferCrossMarginToSpot(params: object): Promise<SpotAPISuccessResponse<number>>;Transfer Asset from Cross Margin Account to Spot Trading Account
Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { amount?: string; currency?: string; } |
params.amount? | string |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<number>>
transferIsolatedMarginToSpot()
transferIsolatedMarginToSpot(params: SpotMarginTransferOutIsolatedReq): Promise<SpotAPISuccessResponse<number>>;Transfer Asset from Isolated Margin Account to Spot Trading Account
Signature required. Trade permission. Rate: 2/2s.
Parameters
| Parameter | Type |
|---|---|
params | SpotMarginTransferOutIsolatedReq |
Returns
Promise<SpotAPISuccessResponse<number>>
transferSpotToCrossMargin()
transferSpotToCrossMargin(params: object): Promise<SpotAPISuccessResponse<number>>;Transfer Asset from Spot Trading Account to Cross Margin Account
Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { amount?: string; currency?: string; } |
params.amount? | string |
params.currency? | string |
Returns
Promise<SpotAPISuccessResponse<number>>
transferSpotToIsolatedMargin()
transferSpotToIsolatedMargin(params: SpotMarginTransferInIsolatedReq): Promise<SpotAPISuccessResponse<number>>;Transfer Asset from Spot Trading Account to Isolated Margin Account
Signature required. Trade permission. Rate: 2/2s.
Parameters
| Parameter | Type |
|---|---|
params | SpotMarginTransferInIsolatedReq |
Returns
Promise<SpotAPISuccessResponse<number>>
updateFeeDeductionMethod()
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
| Parameter | Type |
|---|---|
params | { deductionCurrency?: string; switchType: 0 | 1 | 2; } |
params.deductionCurrency? | string |
params.switchType | 0 | 1 | 2 |
Returns
Promise<SpotAPISuccessResponse<null>>
updateSubUserApiKey()
updateSubUserApiKey(params: SpotSubUserApiKeyUpdateReq): Promise<SpotAPISuccessResponse<SpotSubUserApiKeyUpdateResult>>;Modify Sub User API Key
Modify sub user's API key. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | SpotSubUserApiKeyUpdateReq |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserApiKeyUpdateResult>>
updateSubUserDeductMode()
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
| Parameter | Type |
|---|---|
params? | { deductMode?: "sub" | "master"; subUids?: string; } |
params.deductMode? | "sub" | "master" |
params.subUids? | string |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserDeductModeResult[]>>
updateSubUserLockStatus()
updateSubUserLockStatus(params: object): Promise<SpotAPISuccessResponse<SpotSubUserLockStatusResult>>;Lock/Unlock Sub User
Lock or unlock a sub user. Signature required. Trade permission. Rate: 20/2s.
Parameters
| Parameter | Type |
|---|---|
params | { action: "lock" | "unlock"; subUid: number; } |
params.action | "lock" | "unlock" |
params.subUid | number |
Returns
Promise<SpotAPISuccessResponse<SpotSubUserLockStatusResult>>