Class: FuturesClient
REST client for HTX derivatives APIs. Select methods and request types for the intended contract family and account mode.
Extends
BaseRestClient
Constructors
Constructor
new FuturesClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): FuturesClient;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
FuturesClient
Inherited from
BaseRestClient.constructor
Methods
adjustMultiAssetMargin()
adjustMultiAssetMargin(params: FuturesV5AdjustMarginReq): Promise<FuturesAPISuccessResponse<Record<string, never>>>;Adjust Margin for Isolated Positions
Increase or decrease margin of isolated positions. Query margin_available (add) and withdraw_available (reduce) via unified account info. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5AdjustMarginReq |
Returns
Promise<FuturesAPISuccessResponse<Record<string, never>>>
cancelCoinMDeliveryAllOrders()
cancelCoinMDeliveryAllOrders(params: FuturesCmDeliveryCancelAllOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Orders (Future Trade)
Cancel all orders. One of: symbol, contract_code, or (symbol+contract_type). Optional direction/offset filter. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryCancelAllOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryAllTpslOrders()
cancelCoinMDeliveryAllTpslOrders(params: FuturesCmDeliveryCancelAllTpslOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Take-profit and Stop-loss Orders (Future Trade)
Cancel all TPSL. One of: symbol, contract_code, or (symbol+contract_type). Optional direction. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryCancelAllTpslOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryAllTrailingOrders()
cancelCoinMDeliveryAllTrailingOrders(params: FuturesCmDeliveryCancelAllTrailingOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Trailing Orders (Future Trade)
Cancel all trailing orders. symbol required. Optional contract_code, contract_type, direction, offset. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryCancelAllTrailingOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryAllTriggerOrders()
cancelCoinMDeliveryAllTriggerOrders(params: FuturesCmDeliveryCancelAllTriggerOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Trigger Orders (Future Trade)
Cancel all trigger orders. symbol required. Optional contract_code, contract_type, direction, offset. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryCancelAllTriggerOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryOrder()
cancelCoinMDeliveryOrder(params: FuturesCmDeliveryCancelOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel an Order (Future Trade)
Cancel by order_id or client_order_id. Max 10 per request. Symbol required. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryCancelOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryTpslOrder()
cancelCoinMDeliveryTpslOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Take-profit and Stop-loss Order (Future Trade)
Cancel TPSL by order_id. Max 10 per request. Symbol required. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { order_id: string; symbol: string; } |
params.order_id | string |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryTrailingOrder()
cancelCoinMDeliveryTrailingOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Trailing Order (Future Trade)
Cancel by order_id. Max 10 per request. Symbol required. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { order_id: string; symbol: string; } |
params.order_id | string |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMDeliveryTriggerOrder()
cancelCoinMDeliveryTriggerOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Trigger Order (Future Trade)
Cancel by order_id. Max 10 per request. Symbol required. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { order_id: string; symbol: string; } |
params.order_id | string |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpAllOrders()
cancelCoinMPerpAllOrders(params: FuturesCmPerpCancelAllOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Orders (CMPerp)
Cancel all orders for contract. Optional direction/offset filter. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelAllOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpAllTpslOrders()
cancelCoinMPerpAllTpslOrders(params: FuturesCmPerpCancelAllTpslOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All TPSL Orders (CMPerp)
Cancel all TPSL orders for contract. Optional direction filter. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelAllTpslOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpAllTrailingOrders()
cancelCoinMPerpAllTrailingOrders(params: FuturesCmPerpCancelAllTrailingOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Trailing Orders (CMPerp)
Cancel all trailing orders for contract. Optional direction/offset filter. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelAllTrailingOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpAllTriggerOrders()
cancelCoinMPerpAllTriggerOrders(params: FuturesCmPerpCancelAllTriggerOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Trigger Orders (CMPerp)
Cancel all trigger orders for contract. Optional direction/offset filter. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelAllTriggerOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpOrder()
cancelCoinMPerpOrder(params: FuturesCmPerpCancelOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Order (CMPerp)
Cancel by order_id or client_order_id. One required, max 10. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpTpslOrder()
cancelCoinMPerpTpslOrder(params: FuturesCmPerpCancelTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel TPSL Order (CMPerp)
Cancel by order_id. Max 10. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpTrailingOrder()
cancelCoinMPerpTrailingOrder(params: FuturesCmPerpCancelTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Trailing Order (CMPerp)
Cancel by order_id. Max 10. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpCancelTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelCoinMPerpTriggerOrder()
cancelCoinMPerpTriggerOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Trigger Order (CMPerp)
Cancel by order_id. Max 10. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; order_id: string; } |
params.contract_code | string |
params.order_id | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossAllOrders()
cancelLinearSwapCrossAllOrders(params: FuturesCancelCrossAllOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Orders (Cross)
Cancel all orders for contract. Optional direction/offset filter. Cross margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelCrossAllOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossAllTpslOrders()
cancelLinearSwapCrossAllTpslOrders(params: FuturesCancelAllCrossTpslOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel all Take-profit and Stop-loss Orders
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllCrossTpslOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossAllTrailingOrders()
cancelLinearSwapCrossAllTrailingOrders(params: FuturesCancelAllCrossTrailingOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel All Trailing Orders
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Can fill only one of direction and offset to filter. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllCrossTrailingOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossAllTriggerOrders()
cancelLinearSwapCrossAllTriggerOrders(params: FuturesCancelAllCrossTriggerOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel All Trigger Orders
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s. Can fill only one of direction and offset to filter.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllCrossTriggerOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossOrder()
cancelLinearSwapCrossOrder(params: FuturesCancelCrossOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Order (Cross)
Cancel order(s) by order_id or client_order_id. Max 25 per request. Cross margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelCrossOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossTpslOrder()
cancelLinearSwapCrossTpslOrder(params: FuturesCancelCrossTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel a Take-profit and Stop-loss Order
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelCrossTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossTrailingOrder()
cancelLinearSwapCrossTrailingOrder(params: FuturesCancelCrossTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel a Trailing Order
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelCrossTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapCrossTriggerOrder()
cancelLinearSwapCrossTriggerOrder(params: FuturesCancelCrossTriggerOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Cross] Cancel Trigger Order
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelCrossTriggerOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedAllOrders()
cancelLinearSwapIsolatedAllOrders(params: FuturesCancelAllOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel All Orders (Isolated)
Cancel all orders for contract. Optional direction/offset filter. Isolated margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedAllTpslOrders()
cancelLinearSwapIsolatedAllTpslOrders(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel all Take-profit and Stop-loss Orders
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; direction?: "buy" | "sell"; } |
params.contract_code | string |
params.direction? | "buy" | "sell" |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedAllTrailingOrders()
cancelLinearSwapIsolatedAllTrailingOrders(params: FuturesCancelAllTrailingOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel All Trailing Orders
Isolated margin only. Can fill only one of direction and offset to filter. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllTrailingOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedAllTriggerOrders()
cancelLinearSwapIsolatedAllTriggerOrders(params: FuturesCancelAllTriggerOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel All Trigger Orders
Isolated margin only. Trade permission. Rate limit: 5/s. Can fill only one of direction and offset to filter.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllTriggerOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedOrder()
cancelLinearSwapIsolatedOrder(params: FuturesCancelOrderReq): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;Cancel Order (Isolated)
Cancel order(s) by order_id or client_order_id. Max 25 per request. Isolated margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedTpslOrder()
cancelLinearSwapIsolatedTpslOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel a Take-profit and Stop-loss Order
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; order_id: string; } |
params.contract_code | string |
params.order_id | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedTrailingOrder()
cancelLinearSwapIsolatedTrailingOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel a Trailing Order
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; order_id: string; } |
params.contract_code | string |
params.order_id | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelLinearSwapIsolatedTriggerOrder()
cancelLinearSwapIsolatedTriggerOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>;[Isolated] Cancel Trigger Order
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; order_id: string; } |
params.contract_code | string |
params.order_id | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelOrder>>
cancelMultiAssetAlgoOrders()
cancelMultiAssetAlgoOrders(orders: FuturesV5CancelAlgoOrderReq[]): Promise<FuturesAPISuccessResponse<FuturesV5CancelAlgoOrderResp[]>>;Cancel algo order
Parameters
| Parameter | Type |
|---|---|
orders | FuturesV5CancelAlgoOrderReq[] |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5CancelAlgoOrderResp[]>>
cancelMultiAssetAllOrders()
cancelMultiAssetAllOrders(params?: FuturesV5CancelAllOrdersReq): Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>;Cancel All Orders
Cancel all open orders. Optional filters by contract, side, position_side. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5CancelAllOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>
cancelMultiAssetBatchOrders()
cancelMultiAssetBatchOrders(params: FuturesV5CancelBatchOrdersReq): Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>;Cancel Multiple Orders
Cancel orders in a batch. Max 10 orders per request. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5CancelBatchOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>
cancelMultiAssetOrder()
cancelMultiAssetOrder(params: FuturesV5CancelOrderReq): Promise<FuturesAPISuccessResponse<FuturesV5PlaceOrderResp>>;Cancel Order
Cancel an order in futures trading. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5CancelOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceOrderResp>>
closeMultiAssetAllPositions()
closeMultiAssetAllPositions(): Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>;Close All at Market Price
Sell all positions at market price. Signature required. Trade permission. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>
closeMultiAssetPosition()
closeMultiAssetPosition(params: FuturesV5ClosePositionReq): Promise<FuturesAPISuccessResponse<FuturesV5ClosePositionResp>>;Close All of a Symbol at Market Price
Sell designated positions at market price. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5ClosePositionReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5ClosePositionResp>>
createCopyTraderApikey()
createCopyTraderApikey(params: FuturesCopyTraderApikeyReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderApikey[]>>;Trader Create Lead Trading API Key
Create API key for lead trading (max 20). Main Account ApiKey only. Trade permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderApikeyReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderApikey[]>>
generateNewOrderID()
generateNewOrderID(): string;Misc Utility Methods
Returns
string
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getCoinMDeliveryAccountFull()
getCoinMDeliveryAccountFull(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAssetPositionInfo[]>>;Query Assets And Positions (CM)
Combined account + positions for symbol. symbol required. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAssetPositionInfo[]>>
getCoinMDeliveryAccountInfo()
getCoinMDeliveryAccountInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAccountInfo[]>>;Query Account Info (CM)
User's account info per symbol. Omit symbol for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAccountInfo[]>>
getCoinMDeliveryAccountRatio()
getCoinMDeliveryAccountRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryEliteAccountRatio>>;Query Top Trader Sentiment - Account (CM)
Net long/short accounts ratio. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { period: "5min" | "15min" | "30min" | "60min" | "4hour" | "1day"; symbol: string; } |
params.period | "5min" | "15min" | "30min" | "60min" | "4hour" | "1day" |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryEliteAccountRatio>>
getCoinMDeliveryAdjustFactor()
getCoinMDeliveryAdjustFactor(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAdjustFactor[]>>;Query Tiered Adjustment Factor (CM)
Get adjustment factor by leverage tier. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAdjustFactor[]>>
getCoinMDeliveryApiStatus()
getCoinMDeliveryApiStatus(): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryApiTradingStatus[]>>;Query API Trading Status (CM)
User's API indicator disable information (COR, TDN). No params. Signature required. Rate limit: 72/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryApiTradingStatus[]>>
getCoinMDeliveryAssetValuation()
getCoinMDeliveryAssetValuation(params?: object): Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>;Query Asset Valuation (CM)
Total asset valuation in fiat. valuation_asset optional, defaults to BTC. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { valuation_asset?: string; } |
params.valuation_asset? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>
getCoinMDeliveryAvailableLeverage()
getCoinMDeliveryAvailableLeverage(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLeverageRate[]>>;Query Available Leverage Rate (CM)
Available leverage rates per symbol. Omit symbol for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLeverageRate[]>>
getCoinMDeliveryBasisData()
getCoinMDeliveryBasisData(params: FuturesCmDeliveryBasisDataReq): Promise<FuturesAPISuccessResponse<FuturesBasis[]>>;Get Basis Data (CM)
Basis (contract - index) kline. basis_price_type defaults to open. No signature. Rate limit: 800/s per IP. Max 2000 per request.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryBasisDataReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBasis[]>>
getCoinMDeliveryContractElements()
getCoinMDeliveryContractElements(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryQueryElements[]>>;Get Contract Elements (CM)
Contract elements (limits, face value, etc). No signature.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryQueryElements[]>>
getCoinMDeliveryContractInfo()
getCoinMDeliveryContractInfo(params?: FuturesCmDeliveryContractInfoReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryContractInfo[]>>;Get Contract Info (CM)
Contract metadata (size, tick, dates, status). No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliveryContractInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryContractInfo[]>>
getCoinMDeliveryContractLimit()
getCoinMDeliveryContractLimit(params?: FuturesCmDeliveryContractLimitReq): Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>;Get Contract Price Limit (CM)
Highest/lowest price limits. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliveryContractLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>
getCoinMDeliveryDeliveryPrice()
getCoinMDeliveryDeliveryPrice(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryDeliveryPrice>>;Get Estimated Delivery Price (CM)
Estimated delivery price for a symbol. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryDeliveryPrice>>
getCoinMDeliveryEstimatedSettlementPrice()
getCoinMDeliveryEstimatedSettlementPrice(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryEstimatedSettlementPrice[]>>;Get Estimated Settlement Price (CM)
Current-period estimated settlement/delivery price. Updated every 6s within 1h of settlement. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryEstimatedSettlementPrice[]>>
getCoinMDeliveryFee()
getCoinMDeliveryFee(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFee[]>>;Query Trading Fee (CM)
Maker/taker fee rates per contract. Omit symbol for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFee[]>>
getCoinMDeliveryFills()
getCoinMDeliveryFills(params: FuturesCmDeliveryGetFillsReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get History Match Results (Future Trade, v3)
Match/fill history. symbol, contract, trade_type required. Window max 48h, within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetFillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getCoinMDeliveryFillsExact()
getCoinMDeliveryFillsExact(params: FuturesCmDeliveryGetFillsExactReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Query History Match Results via Multiple Fields (Future Trade, v3)
Match/fill history with flexible filters. symbol, trade_type required. Within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetFillsExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getCoinMDeliveryFinancialRecords()
getCoinMDeliveryFinancialRecords(params: FuturesCmDeliveryFinancialRecordReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFinancialRecord[]>>;Query Account Financial Records (CM)
Financial records (transfers, fees, funding, etc.). symbol required, type optional (comma-separated). Window max 48h, within 90 days. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryFinancialRecordReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFinancialRecord[]>>
getCoinMDeliveryFinancialRecordsExact()
getCoinMDeliveryFinancialRecordsExact(params: FuturesCmDeliveryFinancialRecordReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFinancialRecord[]>>;Query Account Financial Records Exact (CM)
Financial records via multiple fields. from_id for pagination. Same params as contract_financial_record. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryFinancialRecordReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryFinancialRecord[]>>
getCoinMDeliveryHistoricalOpenInterest()
getCoinMDeliveryHistoricalOpenInterest(params: FuturesCmDeliveryOpenInterestReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOpenInterest>>;Query Historical Open Interest (CM)
Get historical open interest. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryOpenInterestReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOpenInterest>>
getCoinMDeliveryHistoryOrders()
getCoinMDeliveryHistoryOrders(params: FuturesCmDeliveryGetHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders (Future Trade, v3)
History orders. symbol, trade_type, type, status required. Window max 48h, within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getCoinMDeliveryHistoryOrdersExact()
getCoinMDeliveryHistoryOrdersExact(params: FuturesCmDeliveryGetHistoryOrdersExactReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Query History Orders via Multiple Fields (Future Trade, v3)
History orders with type filter. symbol, trade_type, type, status required. Window max 48h, within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetHistoryOrdersExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getCoinMDeliveryIndexConstituents()
getCoinMDeliveryIndexConstituents(params: object): Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>;Get Index Components (CM)
Index constituent/exchange data. No signature.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>
getCoinMDeliveryIndexKlines()
getCoinMDeliveryIndexKlines(params: FuturesCmDeliveryIndexKlinesReq): Promise<FuturesAPISuccessResponse<FuturesKline[]>>;Get Index Kline Data (CM)
Index price candlestick data. vol/count/amount typically 0. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryIndexKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesKline[]>>
getCoinMDeliveryIndexPrice()
getCoinMDeliveryIndexPrice(params?: object): Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>;Get Index Price (CM)
Index price for symbol(s). No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>
getCoinMDeliveryKlines()
getCoinMDeliveryKlines(params: FuturesCmDeliveryKlinesReq): Promise<FuturesAPISuccessResponse<FuturesKline[]>>;Get Kline Data (CM)
Candlestick data. Either size or (from+to) required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesKline[]>>
getCoinMDeliveryLastTrade()
getCoinMDeliveryLastTrade(params?: object): Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>;Get Last Trade (CM)
Latest trade for a contract. Omit symbol for all. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>
getCoinMDeliveryLiquidationOrders()
getCoinMDeliveryLiquidationOrders(params: FuturesCmDeliveryLiquidationOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLiquidationOrder[]>>;Query Liquidation Orders (CM)
Get liquidation order info. trade_type: 0=fully filled, 5=liquidated close, 6=liquidated open. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryLiquidationOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLiquidationOrder[]>>
getCoinMDeliveryMarketBbo()
getCoinMDeliveryMarketBbo(params?: object): Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>;Get Market BBO (CM)
Best bid/offer. Omit symbol for all. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>
getCoinMDeliveryMarketDepth()
getCoinMDeliveryMarketDepth(params: object): Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>;Get Market Depth (CM)
Order book (asks/bids). type: step0=raw 150 levels; step1–5,14–15=merged 150; step6=raw 30; step7–13=merged 30. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; type: string; } |
params.symbol | string |
params.type | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>
getCoinMDeliveryMarkKlines()
getCoinMDeliveryMarkKlines(params: FuturesCmDeliveryMarkPriceKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Mark Klines (CM)
Mark price candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryMarkPriceKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getCoinMDeliveryMasterSubTransfers()
getCoinMDeliveryMasterSubTransfers(params: FuturesCmDeliveryMasterSubTransferRecordReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>;Query Master-Sub Transfer Records (CM)
Transfer history between master and sub accounts. symbol and create_date required. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryMasterSubTransferRecordReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>
getCoinMDeliveryOpenInterest()
getCoinMDeliveryOpenInterest(params?: FuturesCmDeliveryContractOpenInterestReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryContractOpenInterest[]>>;Get Open Interest (CM)
Current open interest and 24h trading volume. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliveryContractOpenInterestReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryContractOpenInterest[]>>
getCoinMDeliveryOpenOrders()
getCoinMDeliveryOpenOrders(params?: FuturesCmDeliveryGetOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOpenOrders>>;Query Open Orders (Future Trade)
Get open orders. Omit symbol for all. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliveryGetOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOpenOrders>>
getCoinMDeliveryOrderDetail()
getCoinMDeliveryOrderDetail(params: FuturesCmDeliveryGetOrderDetailReq): Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>;Order Details Acquisition (Future Trade)
Get order detail with trades. symbol, order_id, created_at, order_type required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetOrderDetailReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>
getCoinMDeliveryOrderInfo()
getCoinMDeliveryOrderInfo(params: FuturesCmDeliveryGetOrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>;Get Information of an Order (Future Trade)
Query order(s) by order_id or client_order_id. Max 50 per request. Symbol required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetOrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>
getCoinMDeliveryOrderLimit()
getCoinMDeliveryOrderLimit(params: FuturesCmDeliveryOrderLimitReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOrderLimit>>;Query Order Limit (CM)
Max open/close order limits per contract for given order type. order_price_type required. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryOrderLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryOrderLimit>>
getCoinMDeliveryPositionInfo()
getCoinMDeliveryPositionInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryPositionInfo[]>>;Query Position Info (CM)
User's positions. Omit symbol for all. Signature required. Rate limit: 72/3s per UID. Query with symbol to avoid 1080 when contracts in settlement.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryPositionInfo[]>>
getCoinMDeliveryPositionLimit()
getCoinMDeliveryPositionLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryPositionLimit[]>>;Query Position Limit (CM)
Max long/short position limits per contract type. Omit symbol for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryPositionLimit[]>>
getCoinMDeliveryPositionRatio()
getCoinMDeliveryPositionRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryElitePositionRatio>>;Query Top Trader Sentiment - Position (CM)
Net long/short position ratio. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { period: "5min" | "15min" | "30min" | "60min" | "4hour" | "1day"; symbol: string; } |
params.period | "5min" | "15min" | "30min" | "60min" | "4hour" | "1day" |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryElitePositionRatio>>
getCoinMDeliveryRelationTpslOrder()
getCoinMDeliveryRelationTpslOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>;Query TPSL Orders Related to Position-opening Order (Future Trade)
Get TPSL orders linked to a limit order. symbol, order_id required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { order_id: string | number; symbol: string; } |
params.order_id | string | number |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>
getCoinMDeliveryRiskReserveBalance()
getCoinMDeliveryRiskReserveBalance(): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>;Query Risk Reserve Balance (CM)
Total risk funds for all business lines, priced in USDT. No signature.
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>
getCoinMDeliveryRiskReserveHistory()
getCoinMDeliveryRiskReserveHistory(params?: FuturesCmDeliveryRiskReserveHistoryReq): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>;Query Historical Risk Reserves (CM)
Historical risk fund data by day. No signature.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliveryRiskReserveHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>
getCoinMDeliverySettlementRecords()
getCoinMDeliverySettlementRecords(params: FuturesCmDeliverySettlementRecordsReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliverySettlementRecords>>;Query Settlement Records (CM)
Historical settlement records. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySettlementRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliverySettlementRecords>>
getCoinMDeliverySubAccountAssets()
getCoinMDeliverySubAccountAssets(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubAccountAssets[]>>;Query Single Sub-Account Assets (CM)
Assets info for one sub-account. sub_uid required. Only activated sub-accounts. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { sub_uid: number; symbol?: string; } |
params.sub_uid | number |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubAccountAssets[]>>
getCoinMDeliverySubAccounts()
getCoinMDeliverySubAccounts(params?: FuturesCmDeliverySubAccountListReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAllSubAccount[]>>;Query Assets of All Sub-Accounts (CM)
Assets info of all sub-accounts under master. Only returns activated contract sub-accounts. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliverySubAccountListReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryAllSubAccount[]>>
getCoinMDeliverySubAccountsAssets()
getCoinMDeliverySubAccountsAssets(params?: FuturesCmDeliverySubAccountInfoListReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubAccountsAssets>>;Query Batch of Sub-Account Assets (CM)
Paginated batch of sub-account assets. Only activated sub-accounts. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliverySubAccountInfoListReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubAccountsAssets>>
getCoinMDeliverySubPermissions()
getCoinMDeliverySubPermissions(params?: FuturesCmDeliverySubPermissionsReq): Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>;Query Sub-Account Trading Permissions (CM)
List sub-accounts and their trading permission status. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmDeliverySubPermissionsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>
getCoinMDeliverySubPositionInfo()
getCoinMDeliverySubPositionInfo(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubPositionInfo[]>>;Query Single Sub-Account Positions (CM)
Position info for one sub-account. sub_uid required. Only activated sub-accounts. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { sub_uid: number; symbol?: string; } |
params.sub_uid | number |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliverySubPositionInfo[]>>
getCoinMDeliverySystemStatus()
getCoinMDeliverySystemStatus(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryApiState[]>>;Query System Status (CM)
Open/close/cancel/transfer access per symbol. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryApiState[]>>
getCoinMDeliveryTicker()
getCoinMDeliveryTicker(params: object): Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>;Get Ticker (CM)
24h ticker + best bid/ask for one contract. symbol required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>
getCoinMDeliveryTickers()
getCoinMDeliveryTickers(params?: object): Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>;Get Tickers (CM V2)
24h tickers + best bid/ask for one or all contracts. Omit symbol for all. No signature. Rate limit: 800/s per IP. Data updated every 50ms.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>
getCoinMDeliveryTieredMargin()
getCoinMDeliveryTieredMargin(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLadderMargin[]>>;Query Tiered Margin (CM)
Get tiered margin by leverage. No signature. Rate limit: 120/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryLadderMargin[]>>
getCoinMDeliveryTpslHistoryOrders()
getCoinMDeliveryTpslHistoryOrders(params: FuturesCmDeliveryGetTpslHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTpslHistoryOrders>>;Query Take-profit and Stop-loss History Orders (Future Trade)
TPSL order history. symbol, contract_code, status, create_date required. Within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTpslHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTpslHistoryOrders>>
getCoinMDeliveryTpslOpenOrders()
getCoinMDeliveryTpslOpenOrders(params: FuturesCmDeliveryGetTpslOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTpslOpenOrders>>;Query Open Take-profit and Stop-loss Orders (Future Trade)
Get open TPSL orders. Symbol required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTpslOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTpslOpenOrders>>
getCoinMDeliveryTradeHistory()
getCoinMDeliveryTradeHistory(params: object): Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>;Get Trade History (CM)
Batch of recent trades for a contract. symbol and size required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { size: number; symbol: string; } |
params.size | number |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>
getCoinMDeliveryTrailingHistoryOrders()
getCoinMDeliveryTrailingHistoryOrders(params: FuturesCmDeliveryGetTrailingHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTrailingHistoryOrders>>;Get History Trailing Orders (Future Trade)
Trailing order history. symbol, status, trade_type, create_date required. Within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTrailingHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTrailingHistoryOrders>>
getCoinMDeliveryTrailingOpenOrders()
getCoinMDeliveryTrailingOpenOrders(params: FuturesCmDeliveryGetTrailingOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTrailingOpenOrders>>;Query Open Trailing Orders (Future Trade)
Get unfilled trailing orders. Symbol required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTrailingOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTrailingOpenOrders>>
getCoinMDeliveryTransferLimit()
getCoinMDeliveryTransferLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTransferLimit[]>>;Query Transfer Limit (CM)
Transfer in/out limits per symbol. Omit symbol for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTransferLimit[]>>
getCoinMDeliveryTriggerHistoryOrders()
getCoinMDeliveryTriggerHistoryOrders(params: FuturesCmDeliveryGetTriggerHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTriggerHistoryOrders>>;Query Trigger Order History (Future Trade)
Get trigger order history. symbol, trade_type, status, create_date required. Within 90 days. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTriggerHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTriggerHistoryOrders>>
getCoinMDeliveryTriggerOpenOrders()
getCoinMDeliveryTriggerOpenOrders(params: FuturesCmDeliveryGetTriggerOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTriggerOpenOrders>>;Query Trigger Order Open Orders (Future Trade)
Get open trigger orders. Symbol required. Read permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryGetTriggerOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryTriggerOpenOrders>>
getCoinMDeliveryUserSettlementRecords()
getCoinMDeliveryUserSettlementRecords(params: FuturesCmDeliveryUserSettlementRecordsReq): Promise<FuturesAPISuccessResponse<FuturesCmDeliveryUserSettlementRecords>>;Query User Settlement Records (CM)
User's settlement records. symbol required. Within 90 days. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryUserSettlementRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliveryUserSettlementRecords>>
getCoinMPerpAccountFull()
getCoinMPerpAccountFull(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountFull[]>>;Query Assets And Positions (CMPerp)
Combined account + positions for contract. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountFull[]>>
getCoinMPerpAccountInfo()
getCoinMPerpAccountInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountInfo[]>>;Query Account Info (CMPerp)
User's account info per contract. Omit contract_code for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountInfo[]>>
getCoinMPerpAccountRatio()
getCoinMPerpAccountRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountRatio>>;Query Top Trader Sentiment - Account (CMPerp)
Net long/short accounts ratio. No signature.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; period: "5min" | "15min" | "30min" | "60min" | "4hour" | "1day"; } |
params.contract_code | string |
params.period | "5min" | "15min" | "30min" | "60min" | "4hour" | "1day" |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpAccountRatio>>
getCoinMPerpAdjustFactor()
getCoinMPerpAdjustFactor(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpAdjustFactor[]>>;Query Tiered Adjustment Factor (CMPerp)
Adjustment factor by leverage tier. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpAdjustFactor[]>>
getCoinMPerpApiStatus()
getCoinMPerpApiStatus(): Promise<FuturesAPISuccessResponse<FuturesCmPerpApiStatus[]>>;API Trading Status (CMPerp)
Query API indicator disable info (COR/TDN). Signature required. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpApiStatus[]>>
getCoinMPerpAssetValuation()
getCoinMPerpAssetValuation(params?: object): Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>;Query Asset Valuation (CMPerp)
Total asset valuation in fiat. valuation_asset optional, defaults to BTC. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { valuation_asset?: string; } |
params.valuation_asset? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>
getCoinMPerpAvailableLeverage()
getCoinMPerpAvailableLeverage(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpAvailableLeverage[]>>;Query Available Leverage (CMPerp)
User's available leverage per contract. Omit contract_code for all. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpAvailableLeverage[]>>
getCoinMPerpBasisData()
getCoinMPerpBasisData(params: FuturesCmPerpBasisDataReq): Promise<FuturesAPISuccessResponse<FuturesBasis[]>>;Get Basis Data (CMPerp)
Basis (contract - index) kline data. basis_price_type default: open. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpBasisDataReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBasis[]>>
getCoinMPerpContractElements()
getCoinMPerpContractElements(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpContractElements[]>>;Query Contract Elements (CMPerp)
Contract elements (limits, ticks, contract_infos). No signature. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpContractElements[]>>
getCoinMPerpContractInfo()
getCoinMPerpContractInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpContractInfo[]>>;Query Swap Info (CMPerp)
Contract metadata (size, tick, dates, status). No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpContractInfo[]>>
getCoinMPerpEstimatedSettlementPrice()
getCoinMPerpEstimatedSettlementPrice(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpEstimatedSettlementPrice[]>>;Get Estimated Settlement Price (CMPerp)
Current-period estimated settlement/delivery price. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpEstimatedSettlementPrice[]>>
getCoinMPerpFee()
getCoinMPerpFee(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpFee[]>>;Query Trading Fee (CMPerp)
Maker/taker fee rates per contract. Omit contract_code for all. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpFee[]>>
getCoinMPerpFills()
getCoinMPerpFills(params: FuturesCmPerpFillsReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get Match Results (CMPerp)
History match/trade results. Window max 48h, within 90d. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpFillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getCoinMPerpFillsExact()
getCoinMPerpFillsExact(params: FuturesCmPerpFillsReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get Match Results Exact (CMPerp)
History match results via multiple fields. Same params as getCoinMPerpFills. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpFillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getCoinMPerpFinancialRecords()
getCoinMPerpFinancialRecords(params: FuturesCmPerpFinancialRecordReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpFinancialRecord[]>>;Query Financial Records (CMPerp)
Account financial records. Window max 48h, within 90 days. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpFinancialRecordReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpFinancialRecord[]>>
getCoinMPerpFinancialRecordsExact()
getCoinMPerpFinancialRecordsExact(params: FuturesCmPerpFinancialRecordReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpFinancialRecord[]>>;Query Financial Records Exact (CMPerp)
Financial records via multiple fields. Same params as getCoinMPerpFinancialRecords. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpFinancialRecordReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpFinancialRecord[]>>
getCoinMPerpFundingRate()
getCoinMPerpFundingRate(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpFundingRate>>;Query Funding Rate (CMPerp)
Current funding rate for contract. No signature.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpFundingRate>>
getCoinMPerpFundingRateKlines()
getCoinMPerpFundingRateKlines(params: FuturesCmPerpFundingRateKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Estimated Funding Rate Kline (CMPerp)
Estimated funding rate candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpFundingRateKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getCoinMPerpFundingRates()
getCoinMPerpFundingRates(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpFundingRate[]>>;Query Batch Funding Rate (CMPerp)
Funding rates for multiple contracts. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpFundingRate[]>>
getCoinMPerpHistoricalFundingRate()
getCoinMPerpHistoricalFundingRate(params: FuturesCmPerpHistoricalFundingRateReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpHistoricalFundingRatePage>>;Query Historical Funding Rate (CMPerp)
Paginated historical funding rates. No signature.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpHistoricalFundingRateReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpHistoricalFundingRatePage>>
getCoinMPerpHistoricalOpenInterest()
getCoinMPerpHistoricalOpenInterest(params: FuturesCmPerpGetOpenInterestReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenInterest>>;Query Historical Open Interest (CMPerp)
Open interest by period. No signature.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpGetOpenInterestReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenInterest>>
getCoinMPerpHistoryOrders()
getCoinMPerpHistoryOrders(params: FuturesCmPerpHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders (CMPerp)
History orders. Window max 48h, within 90d. Cancelled orders: last 2h. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getCoinMPerpHistoryOrdersExact()
getCoinMPerpHistoryOrdersExact(params: FuturesCmPerpHistoryOrdersExactReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders Exact (CMPerp)
History orders via multiple fields. Adds price_type filter. Same window rules. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpHistoryOrdersExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getCoinMPerpIndexConstituents()
getCoinMPerpIndexConstituents(params: object): Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>;Get Index Constituents (CMPerp)
Index component info (exchange, symbol, weights, prices). No signature. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>
getCoinMPerpIndexPrice()
getCoinMPerpIndexPrice(params?: object): Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>;Query Swap Index Price (CMPerp)
Index price and timestamp per contract. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>
getCoinMPerpKlines()
getCoinMPerpKlines(params: FuturesCmPerpKlinesReq): Promise<FuturesAPISuccessResponse<FuturesKline[]>>;Get Kline Data (CMPerp)
Candlestick data. Either size or (from+to) required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesKline[]>>
getCoinMPerpLastTrade()
getCoinMPerpLastTrade(params?: object): Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>;Get Last Trade (CMPerp)
Latest trade for a contract. Omit contract_code for all. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>
getCoinMPerpLiquidationOrders()
getCoinMPerpLiquidationOrders(params: FuturesCmPerpLiquidationOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpLiquidationOrder[]>>;Query Liquidation Orders (CMPerp)
GET /swap-api/v3/swap_liquidation_orders. trade_type: 0=fully filled, 5=liquidated close, 6=liquidated open. No signature.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpLiquidationOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpLiquidationOrder[]>>
getCoinMPerpMarketBbo()
getCoinMPerpMarketBbo(params?: object): Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>;Get Market BBO (CMPerp)
Best bid/offer. Omit contract_code for all. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>
getCoinMPerpMarketDepth()
getCoinMPerpMarketDepth(params: object): Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>;Get Market Depth (CMPerp)
Order book (asks/bids). type: step0=raw 150 levels; step1-5,14-17=merged 150; step6=raw 20/30; step7-13,18-19=merged 20/30. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; type: string; } |
params.contract_code | string |
params.type | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>
getCoinMPerpMarkKlines()
getCoinMPerpMarkKlines(params: FuturesCmPerpMarkPriceKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Mark Klines (CMPerp)
Mark price candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpMarkPriceKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getCoinMPerpMasterSubTransfers()
getCoinMPerpMasterSubTransfers(params: FuturesCmPerpMasterSubTransfersReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>;Master-Sub Transfer Records (CMPerp)
Query transfer records between master and sub. transfer_type: 34=to sub, 35=from sub. create_date: days (≤90). Signature required.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpMasterSubTransfersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>
getCoinMPerpOpenInterest()
getCoinMPerpOpenInterest(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenInterestCurrent[]>>;Get Open Interest (CMPerp)
Current position quantity and 24h trading volume per contract. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenInterestCurrent[]>>
getCoinMPerpOpenOrders()
getCoinMPerpOpenOrders(params?: FuturesCmPerpOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenOrders>>;Get Open Orders (CMPerp)
Current unfilled orders. Omit contract_code for all. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmPerpOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpOpenOrders>>
getCoinMPerpOrderDetail()
getCoinMPerpOrderDetail(params: FuturesCmPerpOrderDetailReq): Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>;Get Order Detail (CMPerp)
Order details with trades. With created_at+order_type: last 6h; without: last 2h. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpOrderDetailReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>
getCoinMPerpOrderInfo()
getCoinMPerpOrderInfo(params: FuturesCmPerpOrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>;Get Order Info (CMPerp)
Query order(s) by order_id or client_order_id. One required, max 50. Cancel info: last 2h. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpOrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>
getCoinMPerpOrderLimit()
getCoinMPerpOrderLimit(params: FuturesCmPerpOrderLimitReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpOrderLimit>>;Query Order Limit (CMPerp)
Max open/close order limits per contract for given order type. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpOrderLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpOrderLimit>>
getCoinMPerpPositionInfo()
getCoinMPerpPositionInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionInfo[]>>;Query Position Info (CMPerp)
User's positions. Omit contract_code for all. Signature required. Rate limit: 72/3s per UID. Query with contract_code to avoid 1080 when contracts in settlement.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionInfo[]>>
getCoinMPerpPositionLimit()
getCoinMPerpPositionLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionLimit[]>>;Query Position Limit (CMPerp)
Max long/short position limits per contract. Omit contract_code for all. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionLimit[]>>
getCoinMPerpPositionRatio()
getCoinMPerpPositionRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionRatio>>;Query Top Trader Sentiment - Position (CMPerp)
Net long/short position ratio. No signature.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; period: "5min" | "15min" | "30min" | "60min" | "4hour" | "1day"; } |
params.contract_code | string |
params.period | "5min" | "15min" | "30min" | "60min" | "4hour" | "1day" |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpPositionRatio>>
getCoinMPerpPremiumIndexKlines()
getCoinMPerpPremiumIndexKlines(params: FuturesCmPerpPremiumIndexKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Premium Index Kline (CMPerp)
Premium index candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpPremiumIndexKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getCoinMPerpPriceLimit()
getCoinMPerpPriceLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>;Query Price Limitation (CMPerp)
Highest buying and lowest selling price per contract. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>
getCoinMPerpRelationTpslOrder()
getCoinMPerpRelationTpslOrder(params: FuturesCmPerpRelationTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>;Get Relation TPSL Order (CMPerp)
TPSL order info related to a position-opening order. order_id = open order id. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpRelationTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>
getCoinMPerpRiskReserveBalance()
getCoinMPerpRiskReserveBalance(): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>;Query Risk Reserve Balance (CMPerp)
Total risk funds for all business lines, priced in USDT. No signature. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>
getCoinMPerpRiskReserveHistory()
getCoinMPerpRiskReserveHistory(params?: FuturesCmPerpRiskReserveHistoryReq): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>;Query Historical Risk Reserves (CMPerp)
Historical risk fund data by day. No signature. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmPerpRiskReserveHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>
getCoinMPerpSettlementRecords()
getCoinMPerpSettlementRecords(params: FuturesCmPerpSettlementRecordsReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpSettlementRecordsPage>>;Query Settlement Records (CMPerp)
Historical settlement records for platform. No signature.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpSettlementRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSettlementRecordsPage>>
getCoinMPerpSubAccountAssets()
getCoinMPerpSubAccountAssets(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccountAssets[]>>;Query Single Sub-Account Assets (CMPerp)
Assets info of a single sub-account. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code?: string; sub_uid: number; } |
params.contract_code? | string |
params.sub_uid | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccountAssets[]>>
getCoinMPerpSubAccounts()
getCoinMPerpSubAccounts(params?: FuturesCmPerpSubAccountsReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccounts[]>>;Query Assets of All Sub-Accounts (CMPerp)
Assets info of all sub-accounts under master. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmPerpSubAccountsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccounts[]>>
getCoinMPerpSubAccountsAssets()
getCoinMPerpSubAccountsAssets(params?: FuturesCmPerpSubAccountsAssetsReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccountsAssets>>;Query Batch of Sub-Account Assets (CMPerp)
Batch query sub-account assets with pagination. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmPerpSubAccountsAssetsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSubAccountsAssets>>
getCoinMPerpSubPermissions()
getCoinMPerpSubPermissions(params?: FuturesCmPerpSubPermissionsReq): Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>;Query Sub-Account Trading Permissions (CMPerp)
List sub-accounts and their trading permission status. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCmPerpSubPermissionsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>
getCoinMPerpSubPositions()
getCoinMPerpSubPositions(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpSubPositions[]>>;Query Single Sub-Account Positions (CMPerp)
Position info of a single sub-account. Signature required. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code?: string; sub_uid: number; } |
params.contract_code? | string |
params.sub_uid | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSubPositions[]>>
getCoinMPerpSystemStatus()
getCoinMPerpSystemStatus(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpSystemStatus[]>>;Query System Status (CMPerp)
Open/close/cancel/transfer access per contract. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpSystemStatus[]>>
getCoinMPerpTicker()
getCoinMPerpTicker(params: object): Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>;Get Ticker (CMPerp)
24h ticker + best bid/ask for one contract. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>
getCoinMPerpTickers()
getCoinMPerpTickers(params?: object): Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>;Get Tickers (CMPerp V2)
24h tickers + best bid/ask for one or all contracts. Omit contract_code for all. No signature. Data updated every 50ms.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>
getCoinMPerpTieredMargin()
getCoinMPerpTieredMargin(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpTieredMargin[]>>;Query Tiered Margin (CMPerp)
Tiered margin by leverage. No signature. Omit contract_code for all.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTieredMargin[]>>
getCoinMPerpTpslHistoryOrders()
getCoinMPerpTpslHistoryOrders(params: FuturesCmPerpTpslHisOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTpslHisOrders>>;Get TPSL History Orders (CMPerp)
TPSL order history. create_date: days (max 90). Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTpslHisOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTpslHisOrders>>
getCoinMPerpTpslOpenOrders()
getCoinMPerpTpslOpenOrders(params: FuturesCmPerpTpslOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTpslOpenOrders>>;Get TPSL Open Orders (CMPerp)
Current open take-profit and stop-loss orders. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTpslOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTpslOpenOrders>>
getCoinMPerpTradeHistory()
getCoinMPerpTradeHistory(params: object): Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>;Get Trade History (CMPerp)
Batch of trade records for a contract. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; size: number; } |
params.contract_code | string |
params.size | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>
getCoinMPerpTrailingHistoryOrders()
getCoinMPerpTrailingHistoryOrders(params: FuturesCmPerpTrailingHisOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTrailingHisOrders>>;Get Trailing History Orders (CMPerp)
Trailing order history. create_date: days (max 90). Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTrailingHisOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTrailingHisOrders>>
getCoinMPerpTrailingOpenOrders()
getCoinMPerpTrailingOpenOrders(params: FuturesCmPerpTrailingOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTrailingOpenOrders>>;Get Trailing Open Orders (CMPerp)
Current unfilled trailing orders. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTrailingOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTrailingOpenOrders>>
getCoinMPerpTransferLimit()
getCoinMPerpTransferLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpTransferLimit[]>>;Query Transfer Limit (CMPerp)
Transfer in/out limits per contract. Omit contract_code for all. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTransferLimit[]>>
getCoinMPerpTriggerHistoryOrders()
getCoinMPerpTriggerHistoryOrders(params: FuturesCmPerpTriggerHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTriggerHistoryOrders>>;Get Trigger History Orders (CMPerp)
Trigger order history. create_date: days (max 90). Default query completed (status 4,5,6). Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTriggerHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTriggerHistoryOrders>>
getCoinMPerpTriggerOpenOrders()
getCoinMPerpTriggerOpenOrders(params: FuturesCmPerpTriggerOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesCmPerpTriggerOpenOrders>>;Get Trigger Open Orders (CMPerp)
Current unfilled trigger orders. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTriggerOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpTriggerOpenOrders>>
getCopyTraderConfig()
getCopyTraderConfig(params: FuturesCopyTraderConfigReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderConfig[]>>;Trader View Lead Trading Configuration
View lead trading configuration. Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderConfigReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderConfig[]>>
getCopyTraderFollowers()
getCopyTraderFollowers(params?: FuturesCopyTraderFollowersReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderFollower[]>>;Trader Query Followers
Query follower information. Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCopyTraderFollowersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderFollower[]>>
getCopyTraderInstruments()
getCopyTraderInstruments(params?: FuturesCopyTraderInstrumentsReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderInstrument[]>>;Trader Query Lead Trading Products
Query which products are available for lead trading. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesCopyTraderInstrumentsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderInstrument[]>>
getCopyTraderProfitSharingHistory()
getCopyTraderProfitSharingHistory(params: FuturesCopyTraderProfitSharingHistoryReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingHistory[]>>;Trader Historical Profit Sharing Details
Query historical lead trading profit sharing details. Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderProfitSharingHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingHistory[]>>
getCopyTraderProfitSharingHistorySummary()
getCopyTraderProfitSharingHistorySummary(params: FuturesCopyTraderProfitSharingHistorySummaryReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingSummary[]>>;Trader Historical Profit Sharing Summary
Query historical lead trading profit sharing summary. Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderProfitSharingHistorySummaryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingSummary[]>>
getCopyTraderStatistics()
getCopyTraderStatistics(params: FuturesCopyTraderStatisticsReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderStatistics[]>>;Trader Query Lead Trading Metrics
Query own lead trading metric statistics. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderStatisticsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderStatistics[]>>
getCopyTraderUPNLSharingSummary()
getCopyTraderUPNLSharingSummary(params: FuturesCopyTraderUnrealizedProfitSharingSummaryReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingSummary[]>>;Trader Query Unrealized Profit Sharing Summary
Query unrealized profit sharing information. Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderUnrealizedProfitSharingSummaryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderProfitSharingSummary[]>>
getHeartbeat()
getHeartbeat(): Promise<FuturesAPISuccessResponse<FuturesHeartbeat>>;Query System Availability
Heartbeat for futures, swap, linear-swap. 1=available, 0=maintenance. No signature. Rate limit: 240/3s per IP. During maintenance, most endpoints return {status:"maintain"}.
Returns
Promise<FuturesAPISuccessResponse<FuturesHeartbeat>>
getLinearSwapAccountType()
getLinearSwapAccountType(): Promise<FuturesAPISuccessResponse<{
account_type: 1 | 2;
}>>;Account Type Query
Query the current account type (unified vs non-unified). 1: non-unified (cross+isolated); 2: unified. Signature required. Read permission.
Returns
Promise<FuturesAPISuccessResponse<{ account_type: 1 | 2; }>>
getLinearSwapAssetValuation()
getLinearSwapAssetValuation(params?: object): Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>;Query Asset Valuation
Total asset valuation in fiat. Supports cross and isolated margin. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { valuation_asset?: string; } |
params.valuation_asset? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBalanceValuation[]>>
getLinearSwapBasisData()
getLinearSwapBasisData(params: FuturesGetBasisDataReq): Promise<FuturesAPISuccessResponse<FuturesBasis[]>>;Get Basis Data
Basis (contract - index) kline. basis_price_type defaults to open. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetBasisDataReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBasis[]>>
getLinearSwapContractElements()
getLinearSwapContractElements(params?: object): Promise<FuturesAPISuccessResponse<FuturesContractElements[]>>;Query Contract Elements
Contract elements (limits, ticks, contract_infos). No signature. Rate limit: 20/2s.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesContractElements[]>>
getLinearSwapContractInfo()
getLinearSwapContractInfo(params?: FuturesGetContractInfoReq): Promise<FuturesAPISuccessResponse<FuturesContractInfo[]>>;Query Contract Info
Contract metadata (size, tick, dates, status). support_margin_mode filters by cross/isolated/all. No signature. When isolated, contract_type/business_type cannot be futures. Rate limit: 240/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetContractInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesContractInfo[]>>
getLinearSwapContractPriceLimit()
getLinearSwapContractPriceLimit(params?: FuturesGetCrossTieredMarginReq): Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>;Query Price Limitation
Get highest buying and lowest selling price per contract. Supports cross and isolated margin. No signature. business_type required for futures. Rate limit: 240/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTieredMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesPriceLimit[]>>
getLinearSwapCrossAccountFull()
getLinearSwapCrossAccountFull(params: object): Promise<FuturesAPISuccessResponse<FuturesCrossAccountPosition>>;Query Assets And Positions (Cross)
Combined account + positions for cross margin. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account: string; } |
params.margin_account | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossAccountPosition>>
getLinearSwapCrossAccountInfo()
getLinearSwapCrossAccountInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesCrossAccountInfo[]>>;Query Account Info (Cross)
User's cross margin account info. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { margin_account?: string; } |
params.margin_account? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossAccountInfo[]>>
getLinearSwapCrossAdjustFactor()
getLinearSwapCrossAdjustFactor(params?: FuturesGetCrossTieredMarginReq): Promise<FuturesAPISuccessResponse<FuturesAdjustFactor[]>>;Query Tiered Adjustment Factor (Cross)
Get cross-margin tiered adjustment factors. Cross margin only. No signature. business_type required for futures contract query. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTieredMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesAdjustFactor[]>>
getLinearSwapCrossAvailableLeverage()
getLinearSwapCrossAvailableLeverage(params?: FuturesGetCrossAvailableLeverageReq): Promise<FuturesAPISuccessResponse<FuturesCrossAvailableLevelRate[]>>;Query Available Leverage (Cross)
User's available leverage per contract. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossAvailableLeverageReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossAvailableLevelRate[]>>
getLinearSwapCrossFills()
getLinearSwapCrossFills(params: FuturesGetCrossFillsReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get History Fills (Cross)
Matched trades history. One of contract or pair required. Cross margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossFillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getLinearSwapCrossFillsExact()
getLinearSwapCrossFillsExact(params: FuturesGetCrossFillsExactReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get History Fills via Multiple Fields (Cross)
Matched trades history. Cross margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossFillsExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getLinearSwapCrossHistoryOrders()
getLinearSwapCrossHistoryOrders(params: FuturesGetCrossHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders (Cross)
Historical orders. Time-window query, 48h max. Cross margin only. One of contract or pair required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getLinearSwapCrossHistoryOrdersExact()
getLinearSwapCrossHistoryOrdersExact(params: FuturesGetCrossHistoryOrdersExactReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders via Multiple Fields (Cross)
History orders with price_type filter. Cross margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossHistoryOrdersExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getLinearSwapCrossLeverageLimits()
getLinearSwapCrossLeverageLimits(params?: FuturesGetCrossLeverageLimitsReq): Promise<FuturesAPISuccessResponse<FuturesCrossLeverPositionLimit[]>>;Query Position Limit for All Leverages (Cross)
Position limits per leverage per contract. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossLeverageLimitsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossLeverPositionLimit[]>>
getLinearSwapCrossOpenOrders()
getLinearSwapCrossOpenOrders(params?: FuturesGetCrossOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesOpenOrders>>;Get Open Orders (Cross)
Current unfilled orders. Paginated. Cross margin only. Omit all for all contracts. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOpenOrders>>
getLinearSwapCrossOrderDetail()
getLinearSwapCrossOrderDetail(params: FuturesGetCrossOrderDetailReq): Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>;Get Order Detail (Cross)
Order details with trade breakdown. Paginated. Cross margin only. One of contract_code or pair required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossOrderDetailReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>
getLinearSwapCrossOrderInfo()
getLinearSwapCrossOrderInfo(params: FuturesGetCrossOrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>;Get Order Information (Cross)
Query order(s) by order_id or client_order_id. Max 50 per request. Cross margin only. One of contract_code or pair required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossOrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>
getLinearSwapCrossPositionLimit()
getLinearSwapCrossPositionLimit(params?: FuturesGetCrossPositionLimitReq): Promise<FuturesAPISuccessResponse<FuturesCrossPositionLimit[]>>;Query Position Limit (Cross)
Max long/short position limits per contract. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossPositionLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossPositionLimit[]>>
getLinearSwapCrossPositionMode()
getLinearSwapCrossPositionMode(params: object): Promise<FuturesAPISuccessResponse<FuturesPositionSideInfo[]>>;Query Position Mode (Cross)
Returns position mode (single_side/dual_side) per margin account. Cross. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account: string; } |
params.margin_account | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionSideInfo[]>>
getLinearSwapCrossPositions()
getLinearSwapCrossPositions(params?: FuturesGetCrossPositionsReq): Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>;Query Position Info (Cross)
User's cross margin positions. contract_code preferred when all filled. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossPositionsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>
getLinearSwapCrossRelationTpslOrder()
getLinearSwapCrossRelationTpslOrder(params: FuturesGetCrossRelationTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>;[Cross] Query Relation TPSL Order
TPSL order info related to position-opening order. Cross margin only. One of pair or contract_code required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossRelationTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>
getLinearSwapCrossSubAccountAssets()
getLinearSwapCrossSubAccountAssets(params: object): Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountInfo[]>>;Query Single Sub-Account Assets (Cross)
Assets info for one sub-account. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account?: string; sub_uid: number; } |
params.margin_account? | string |
params.sub_uid | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountInfo[]>>
getLinearSwapCrossSubAccounts()
getLinearSwapCrossSubAccounts(params?: FuturesGetCrossSubAccountsReq): Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountListEntry[]>>;Query Assets of All Sub-Accounts (Cross)
Assets info of all sub-accounts under master. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossSubAccountsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountListEntry[]>>
getLinearSwapCrossSubAccountsAssets()
getLinearSwapCrossSubAccountsAssets(params?: FuturesGetCrossSubAccountsAssetsReq): Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountInfoList>>;Query Batch of Sub-Account Assets (Cross)
Batch query sub-account assets with pagination. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossSubAccountsAssetsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossSubAccountInfoList>>
getLinearSwapCrossSubPositions()
getLinearSwapCrossSubPositions(params: FuturesGetCrossSubPositionsReq): Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>;Query Single Sub-Account Positions (Cross)
Position info for one sub-account. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossSubPositionsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>
getLinearSwapCrossTieredMargin()
getLinearSwapCrossTieredMargin(params?: FuturesGetCrossTieredMarginReq): Promise<FuturesAPISuccessResponse<FuturesCrossLadderMargin[]>>;Query Tiered Margin (Cross)
Get cross-margin tiered margin info. Cross margin only. No signature. When querying futures contract, business_type must be futures or all. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTieredMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossLadderMargin[]>>
getLinearSwapCrossTpslHistoryOrders()
getLinearSwapCrossTpslHistoryOrders(params: FuturesGetCrossTpslHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTpslHisOrders>>;[Cross] Query Take-profit and Stop-loss History Orders
Cross margin only. One of pair or contract_code required; contract_code preferred when both filled. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTpslHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslHisOrders>>
getLinearSwapCrossTpslOpenOrders()
getLinearSwapCrossTpslOpenOrders(params: FuturesGetCrossTpslOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTpslOpenOrders>>;[Cross] Query Open Take-profit and Stop-loss Orders
Cross margin only. When both filled, contract_code preferred; when none, all data. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTpslOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOpenOrders>>
getLinearSwapCrossTradeState()
getLinearSwapCrossTradeState(params?: FuturesGetCrossTradeStateReq): Promise<FuturesAPISuccessResponse<FuturesCrossTradeState[]>>;Query Trade State (Cross)
Open/close/cancel access per contract. Cross margin only. No signature. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTradeStateReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossTradeState[]>>
getLinearSwapCrossTrailingHistoryOrders()
getLinearSwapCrossTrailingHistoryOrders(params: FuturesGetCrossTrailingHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTrackHisOrders>>;[Cross] Get History Trailing Orders
Cross margin only. One of pair or contract_code required; contract_code preferred when both filled. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTrailingHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTrackHisOrders>>
getLinearSwapCrossTrailingOpenOrders()
getLinearSwapCrossTrailingOpenOrders(params: FuturesGetCrossTrailingOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTrackOpenOrders>>;[Cross] Current unfilled trailing order acquisition
Cross margin only. When both filled, contract_code preferred; when none, all open orders. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTrailingOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTrackOpenOrders>>
getLinearSwapCrossTransferLimit()
getLinearSwapCrossTransferLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesCrossTransferLimit[]>>;Query Transfer Limit (Cross)
Transfer in/out limits per margin account. Cross margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { margin_account?: string; } |
params.margin_account? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossTransferLimit[]>>
getLinearSwapCrossTransferState()
getLinearSwapCrossTransferState(params?: object): Promise<FuturesAPISuccessResponse<FuturesCrossTransferState[]>>;[Cross] Query Information On Transfer State
Transfer in/out and master-sub transfer access per margin account. Cross margin only. No signature. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | { margin_account?: string; } |
params.margin_account? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossTransferState[]>>
getLinearSwapCrossTriggerHistoryOrders()
getLinearSwapCrossTriggerHistoryOrders(params: FuturesGetCrossTriggerHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTriggerHistoryOrders>>;[Cross] Query Trigger Order History
Cross margin only. One of pair or contract_code required; contract_code preferred when both filled. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTriggerHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTriggerHistoryOrders>>
getLinearSwapCrossTriggerOpenOrders()
getLinearSwapCrossTriggerOpenOrders(params: FuturesGetCrossTriggerOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTriggerOpenOrders>>;[Cross] Query Trigger Order Open Orders
Cross margin only. When both pair and contract_code filled, contract_code preferred; when none, all open orders. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetCrossTriggerOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTriggerOpenOrders>>
getLinearSwapEstimatedSettlementPrice()
getLinearSwapEstimatedSettlementPrice(params?: FuturesGetCrossTieredMarginReq): Promise<FuturesAPISuccessResponse<FuturesEstimatedSettlementPrice[]>>;Get Estimated Settlement Price
Current-period estimated settlement/delivery price. Supports cross and isolated margin. No signature. Empty around settlement/delivery; updated every 6s within 10min of settlement. business_type required for futures. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTieredMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesEstimatedSettlementPrice[]>>
getLinearSwapFee()
getLinearSwapFee(params?: FuturesGetFeeReq): Promise<FuturesAPISuccessResponse<FuturesFee[]>>;Query Trading Fee
Maker/taker fee rates per contract. Supports cross and isolated. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetFeeReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesFee[]>>
getLinearSwapFinancialRecords()
getLinearSwapFinancialRecords(params: FuturesGetFinancialRecordsReq): Promise<FuturesAPISuccessResponse<FuturesFinancialRecord[]>>;Query Account Financial Records
Financial records (transfers, fees, funding, etc.). Supports cross and isolated. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetFinancialRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesFinancialRecord[]>>
getLinearSwapFinancialRecordsExact()
getLinearSwapFinancialRecordsExact(params: FuturesGetFinancialRecordsReq): Promise<FuturesAPISuccessResponse<FuturesFinancialRecord[]>>;Query Account Financial Records (Exact)
Financial records via multiple fields. Same params as swap_financial_record; API default direct is prev. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetFinancialRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesFinancialRecord[]>>
getLinearSwapFundingRate()
getLinearSwapFundingRate(params: object): Promise<FuturesAPISuccessResponse<FuturesFundingRate>>;Query Funding Rate
Get current funding rate for a contract. Supports cross and isolated margin. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesFundingRate>>
getLinearSwapFundingRateKlines()
getLinearSwapFundingRateKlines(params: FuturesGetMarkKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Estimated Funding Rate Kline
Estimated funding rate candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetMarkKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getLinearSwapFundingRates()
getLinearSwapFundingRates(params?: object): Promise<FuturesAPISuccessResponse<FuturesFundingRate[]>>;Query Batch Funding Rate
Get funding rates for one or all contracts. Omit contract_code for all. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesFundingRate[]>>
getLinearSwapHistoricalFundingRate()
getLinearSwapHistoricalFundingRate(params: FuturesGetHistoricalFundingRateReq): Promise<FuturesAPISuccessResponse<FuturesHistoricalFundingRatePage>>;Query Historical Funding Rate
Get historical funding rates for a contract. Supports cross and isolated margin. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoricalFundingRateReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoricalFundingRatePage>>
getLinearSwapHistoricalOpenInterest()
getLinearSwapHistoricalOpenInterest(params: FuturesGetHistoricalOpenInterestReq): Promise<FuturesAPISuccessResponse<FuturesHistoricalOpenInterest>>;Query Historical Open Interest
Open interest over time. One of (pair+contract_type) or contract_code required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoricalOpenInterestReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoricalOpenInterest>>
getLinearSwapIndexConstituents()
getLinearSwapIndexConstituents(params: object): Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>;Get Index Constituents
Index component info (exchange weights, symbol prices). No signature. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexConstituents>>
getLinearSwapIndexPrice()
getLinearSwapIndexPrice(params?: object): Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>;Query Index Price
Get index price and timestamp per contract. Supports cross and isolated margin. No signature. Rate limit: 240/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIndexPrice[]>>
getLinearSwapIsolatedAccountFull()
getLinearSwapIsolatedAccountFull(params: object): Promise<FuturesAPISuccessResponse<FuturesIsolatedAccountPosition[]>>;Query Assets And Positions (Isolated)
Combined account + positions for isolated margin. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIsolatedAccountPosition[]>>
getLinearSwapIsolatedAccountInfo()
getLinearSwapIsolatedAccountInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesIsolatedAccountInfo[]>>;Query Account Info (Isolated)
User's isolated margin account info. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesIsolatedAccountInfo[]>>
getLinearSwapIsolatedAdjustFactor()
getLinearSwapIsolatedAdjustFactor(params?: object): Promise<FuturesAPISuccessResponse<FuturesAdjustFactor[]>>;Query Tiered Adjustment Factor (Isolated)
Get isolated-margin tiered adjustment factors. Isolated margin only. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesAdjustFactor[]>>
getLinearSwapIsolatedAvailableLeverage()
getLinearSwapIsolatedAvailableLeverage(params?: object): Promise<FuturesAPISuccessResponse<FuturesAvailableLevelRate[]>>;Query Available Leverage (Isolated)
User's available leverage per contract. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesAvailableLevelRate[]>>
getLinearSwapIsolatedFills()
getLinearSwapIsolatedFills(params: FuturesGetFillsReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Acquire History Fills (Isolated)
Matched trades history. One of contract or pair required. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetFillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getLinearSwapIsolatedFillsExact()
getLinearSwapIsolatedFillsExact(params: FuturesGetFillsExactReq): Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>;Get History Fills via Multiple Fields (Isolated)
Matched trades history. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetFillsExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMatchResult[]>>
getLinearSwapIsolatedHistoryOrders()
getLinearSwapIsolatedHistoryOrders(params: FuturesGetHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders (Isolated)
Historical orders. Time-window query, 48h max. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getLinearSwapIsolatedHistoryOrdersExact()
getLinearSwapIsolatedHistoryOrdersExact(params: FuturesGetHistoryOrdersExactReq): Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>;Get History Orders via Multiple Fields (Isolated)
History orders with price_type filter. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoryOrdersExactReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesHistoryOrder[]>>
getLinearSwapIsolatedLeverageLimits()
getLinearSwapIsolatedLeverageLimits(params?: object): Promise<FuturesAPISuccessResponse<FuturesLeverPositionLimit[]>>;Query Position Limit for All Leverages (Isolated)
Position limits per leverage per contract. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; lever_rate?: number; } |
params.contract_code? | string |
params.lever_rate? | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesLeverPositionLimit[]>>
getLinearSwapIsolatedOpenOrders()
getLinearSwapIsolatedOpenOrders(params?: FuturesGetOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesOpenOrders>>;Get Open Orders (Isolated)
Current unfilled orders. Paginated. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOpenOrders>>
getLinearSwapIsolatedOrderDetail()
getLinearSwapIsolatedOrderDetail(params: FuturesGetOrderDetailReq): Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>;Get Order Detail (Isolated)
Order details with trade breakdown. Paginated. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOrderDetailReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderDetail>>
getLinearSwapIsolatedOrderInfo()
getLinearSwapIsolatedOrderInfo(params: FuturesGetOrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>;Get Order Information (Isolated)
Query order(s) by order_id or client_order_id. Max 50 per request. Isolated margin only. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderInfo[]>>
getLinearSwapIsolatedPositionLimit()
getLinearSwapIsolatedPositionLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesPositionLimit[]>>;Query Position Limit (Isolated)
Max long/short position limits per contract. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionLimit[]>>
getLinearSwapIsolatedPositionMode()
getLinearSwapIsolatedPositionMode(params: object): Promise<FuturesAPISuccessResponse<FuturesPositionSideInfo[]>>;Query Position Mode (Isolated)
Returns position mode (single_side/dual_side) per margin account. Isolated. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account: string; } |
params.margin_account | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionSideInfo[]>>
getLinearSwapIsolatedPositions()
getLinearSwapIsolatedPositions(params?: object): Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>;Query Position Info (Isolated)
User's isolated margin positions. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>
getLinearSwapIsolatedRelationTpslOrder()
getLinearSwapIsolatedRelationTpslOrder(params: object): Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>;[Isolated] Query Relation TPSL Order
TPSL order info related to position-opening order. Isolated margin only. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; order_id: string | number; } |
params.contract_code | string |
params.order_id | string | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesRelationTpslOrder>>
getLinearSwapIsolatedSubAccountAssets()
getLinearSwapIsolatedSubAccountAssets(params: object): Promise<FuturesAPISuccessResponse<FuturesIsolatedSubAccountInfo[]>>;Query Single Sub-Account Assets (Isolated)
Assets info for one sub-account. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code?: string; sub_uid: number; } |
params.contract_code? | string |
params.sub_uid | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesIsolatedSubAccountInfo[]>>
getLinearSwapIsolatedSubAccounts()
getLinearSwapIsolatedSubAccounts(params?: FuturesGetIsolatedSubAccountsReq): Promise<FuturesAPISuccessResponse<FuturesIsolatedSubAccountListEntry[]>>;Query Assets of All Sub-Accounts (Isolated)
Assets info of all sub-accounts under master. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetIsolatedSubAccountsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesIsolatedSubAccountListEntry[]>>
getLinearSwapIsolatedSubAccountsAssets()
getLinearSwapIsolatedSubAccountsAssets(params?: FuturesGetSubAccountsAssetsReq): Promise<FuturesAPISuccessResponse<FuturesSubAccountInfoList>>;Query Batch of Sub-Account Assets (Isolated)
Batch query sub-account assets with pagination. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetSubAccountsAssetsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubAccountInfoList>>
getLinearSwapIsolatedSubPositions()
getLinearSwapIsolatedSubPositions(params: object): Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>;Query Single Sub-Account Positions (Isolated)
Position info for one sub-account. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code?: string; sub_uid: number; } |
params.contract_code? | string |
params.sub_uid | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesPositionInfo[]>>
getLinearSwapIsolatedSystemStatus()
getLinearSwapIsolatedSystemStatus(params?: object): Promise<FuturesAPISuccessResponse<FuturesApiState[]>>;Query System Status (Isolated)
Get open/close/cancel/transfer access per margin account. Isolated margin only. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesApiState[]>>
getLinearSwapIsolatedTieredMargin()
getLinearSwapIsolatedTieredMargin(params?: object): Promise<FuturesAPISuccessResponse<FuturesCrossLadderMargin[]>>;Query Tiered Margin (Isolated)
Get isolated-margin tiered margin info. Isolated margin only. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossLadderMargin[]>>
getLinearSwapIsolatedTpslHistoryOrders()
getLinearSwapIsolatedTpslHistoryOrders(params: FuturesGetTpslHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTpslHisOrders>>;[Isolated] Query Take-profit and Stop-loss History Orders
Isolated margin only. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTpslHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslHisOrders>>
getLinearSwapIsolatedTpslOpenOrders()
getLinearSwapIsolatedTpslOpenOrders(params: FuturesGetTpslOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTpslOpenOrders>>;[Isolated] Query Open Take-profit and Stop-loss Orders
Isolated margin only. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTpslOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOpenOrders>>
getLinearSwapIsolatedTrailingHistoryOrders()
getLinearSwapIsolatedTrailingHistoryOrders(params: FuturesGetTrailingHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTrackHisOrders>>;[Isolated] Get History Trailing Orders
Isolated margin only. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTrailingHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTrackHisOrders>>
getLinearSwapIsolatedTrailingOpenOrders()
getLinearSwapIsolatedTrailingOpenOrders(params: FuturesGetTrailingOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTrackOpenOrders>>;[Isolated] Current unfilled trailing order acquisition
Isolated margin only. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTrailingOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTrackOpenOrders>>
getLinearSwapIsolatedTransferLimit()
getLinearSwapIsolatedTransferLimit(params?: object): Promise<FuturesAPISuccessResponse<FuturesTransferLimit[]>>;Query Transfer Limit (Isolated)
Transfer in/out limits per margin account. Isolated margin only. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTransferLimit[]>>
getLinearSwapIsolatedTriggerHistoryOrders()
getLinearSwapIsolatedTriggerHistoryOrders(params: FuturesGetTriggerHistoryOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTriggerHistoryOrders>>;[Isolated] Query Trigger Order History
Isolated margin only. Read permission. Default query completed orders (status 4, 5, 6).
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTriggerHistoryOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTriggerHistoryOrders>>
getLinearSwapIsolatedTriggerOpenOrders()
getLinearSwapIsolatedTriggerOpenOrders(params: FuturesGetTriggerOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesTriggerOpenOrders>>;[Isolated] Query Trigger Order Open Orders
Isolated margin only. Read permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetTriggerOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTriggerOpenOrders>>
getLinearSwapKlines()
getLinearSwapKlines(params: FuturesGetKlinesReq): Promise<FuturesAPISuccessResponse<FuturesKline[]>>;Get Kline Data
Candlestick data. Either size or (from+to) required. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesKline[]>>
getLinearSwapLastTrade()
getLinearSwapLastTrade(params?: object): Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>;Get Last Trade
Latest trade for a contract. Omit contract_code for all. business_type required for futures. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { business_type?: "all" | "swap" | "futures"; contract_code?: string; } |
params.business_type? | "all" | "swap" | "futures" |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesLastTrade, "tick">>
getLinearSwapLiquidationOrders()
getLinearSwapLiquidationOrders(params: FuturesGetLiquidationOrdersReq): Promise<FuturesAPISuccessResponse<FuturesLiquidationOrder[]>>;Query Liquidation Orders
Get liquidation orders. One of pair and contract required; contract preferred. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetLiquidationOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesLiquidationOrder[]>>
getLinearSwapMarketBbo()
getLinearSwapMarketBbo(params?: object): Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>;Get Market BBO
Best bid/offer per contract. Omit contract_code for all. business_type required for futures. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | { business_type?: "all" | "swap" | "futures"; contract_code?: string; } |
params.business_type? | "all" | "swap" | "futures" |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesBboTick[], "ticks">>
getLinearSwapMarketDepth()
getLinearSwapMarketDepth(params: object): Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>;Get Market Depth
Order book (asks/bids). step0=raw; step1-5,14-17=merged (150 levels); step6-13,18-19=merged (20 levels). No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; type: string; } |
params.contract_code | string |
params.type | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarketDepthTick, "tick">>
getLinearSwapMarkKlines()
getLinearSwapMarkKlines(params: FuturesGetMarkKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Mark Klines
Mark price candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetMarkKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getLinearSwapMasterSubTransfers()
getLinearSwapMasterSubTransfers(params: FuturesGetMasterSubTransfersReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>;Query Master-Sub Transfer Records
Transfer history between master and sub accounts. Supports cross and isolated. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetMasterSubTransfersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransferRecords>>
getLinearSwapNetAccountRatio()
getLinearSwapNetAccountRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesEliteRatio>>;Query Top Trader Sentiment (Account Ratio)
Net long/short accounts ratio. Supports cross and isolated margin. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; period: string; } |
params.contract_code | string |
params.period | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesEliteRatio>>
getLinearSwapNetPositionRatio()
getLinearSwapNetPositionRatio(params: object): Promise<FuturesAPISuccessResponse<FuturesEliteRatio>>;Query Top Trader Sentiment (Position Ratio)
Net long/short position ratio. Supports cross and isolated margin. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; period: string; } |
params.contract_code | string |
params.period | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesEliteRatio>>
getLinearSwapOpenInterest()
getLinearSwapOpenInterest(params?: FuturesGetCrossTieredMarginReq): Promise<FuturesAPISuccessResponse<FuturesOpenInterest[]>>;Get Open Interest
Position quantity and 24h trading volume per contract. Supports cross and isolated margin. No signature. business_type required for futures. Rate limit: 240/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetCrossTieredMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOpenInterest[]>>
getLinearSwapOrderLimit()
getLinearSwapOrderLimit(params: FuturesGetOrderLimitReq): Promise<FuturesAPISuccessResponse<FuturesOrderLimit>>;Query Order Limit
Max open/close order limits per contract for given order type. Supports cross and isolated. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOrderLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesOrderLimit>>
getLinearSwapPremiumIndexKlines()
getLinearSwapPremiumIndexKlines(params: FuturesGetMarkKlinesReq): Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>;Get Premium Index Kline
Premium index candlestick data. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetMarkKlinesReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMarkPriceKline[]>>
getLinearSwapRiskReserveBalance()
getLinearSwapRiskReserveBalance(): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>;Query Risk Reserve Balance
Total risk funds for all business lines, priced in USDT. No signature. Rate limit: 144/3s per UID (shared with other read interfaces).
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundInfo>>
getLinearSwapRiskReserveHistory()
getLinearSwapRiskReserveHistory(params?: FuturesGetRiskReserveHistoryReq): Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>;Query Historical Risk Reserves
Historical risk fund data by day. No signature. Rate limit: 144/3s per UID (shared with other read interfaces).
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetRiskReserveHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesInsuranceFundHistory[]>>
getLinearSwapSettlementRecords()
getLinearSwapSettlementRecords(params: FuturesGetSettlementRecordsReq): Promise<FuturesAPISuccessResponse<FuturesSettlementRecordsPage>>;Query Historical Settlement Records
Get platform settlement records for a contract. Supports swap and future formats. No signature. Rate limit: 240/3s per IP (shared with other public index/price endpoints).
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetSettlementRecordsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSettlementRecordsPage>>
getLinearSwapSubPermissions()
getLinearSwapSubPermissions(params?: FuturesGetSubPermissionsReq): Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>;Query Sub-Account Trading Permissions
List sub-accounts and their trading permission status. Signature required. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesGetSubPermissionsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubPermissions>>
getLinearSwapTicker()
getLinearSwapTicker(params: object): Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>;Get Ticker
24h ticker + best bid/ask for one contract. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; } |
params.contract_code | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker, "tick">>
getLinearSwapTickers()
getLinearSwapTickers(params?: object): Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>;Get Tickers (V2)
24h tickers + best bid/ask for one or all contracts. business_type required for futures. No signature. Rate limit: 800/s per IP. Data updated every 50ms.
Parameters
| Parameter | Type |
|---|---|
params? | { business_type?: "all" | "swap" | "futures"; contract_code?: string; } |
params.business_type? | "all" | "swap" | "futures" |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesTicker[], "ticks">>
getLinearSwapTradeHistory()
getLinearSwapTradeHistory(params: object): Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>;Get Trade History
Batch of recent trades for a contract. No signature. Rate limit: 800/s per IP.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; size: number; } |
params.contract_code | string |
params.size | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesTradeHistory[]>>
getLinearSwapUnifiedAccountInfo()
getLinearSwapUnifiedAccountInfo(params?: object): Promise<FuturesAPISuccessResponse<FuturesUnifiedAccountInfo[]>>;Query unified account assets
Total assets of USDT-M unified account. Non-unified accounts still use cross/isolated separately. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesUnifiedAccountInfo[]>>
getLinearSwapUnifiedAssets()
getLinearSwapUnifiedAssets(params?: object): Promise<FuturesAPISuccessResponse<FuturesLinearSwapOverviewAccountInfo[]>>;Deductible asset inquiry (linear swap overview account info)
Total account assets of U-margin contract unified account. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | { trade_partition?: string; } |
params.trade_partition? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesLinearSwapOverviewAccountInfo[]>>
getLinearSwapUnifiedMarginAdjustments()
getLinearSwapUnifiedMarginAdjustments(params: FuturesGetUnifiedMarginAdjustmentsReq): Promise<FuturesAPISuccessResponse<FuturesFixPositionMarginChangeRecord[]>>;Query the margin adjustment records of isolated positions
Margin increase/decrease records. Read permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesGetUnifiedMarginAdjustmentsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesFixPositionMarginChangeRecord[]>>
getMultiAssetAccountBalance()
getMultiAssetAccountBalance(): Promise<FuturesAPISuccessResponse<FuturesV5AccountBalance>>;Get Account Balance
Get information about your Futures account. Applicable to multi-assets collateral mode. Signature required. Read permission. Rate limit: 144/3s per UID (shared by all altcoins contracts).
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AccountBalance>>
getMultiAssetAlgoOpenOrders()
getMultiAssetAlgoOpenOrders(params: FuturesV5AlgoOpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder[]>>;Algo pending order list
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5AlgoOpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder[]>>
getMultiAssetAlgoOrder()
getMultiAssetAlgoOrder(params: FuturesV5AlgoOrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder>>;Algo order details
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5AlgoOrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder>>
getMultiAssetAlgoOrderHistory()
getMultiAssetAlgoOrderHistory(params: FuturesV5AlgoOrderHistoryReq): Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder[]>>;Algo order history
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5AlgoOrderHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AlgoOrder[]>>
getMultiAssetBills()
getMultiAssetBills(params?: FuturesV5BillsReq): Promise<FuturesAPISuccessResponse<FuturesV5Bill[]>>;Query Financial Records
Query financial records (bills) with optional filters. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5BillsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5Bill[]>>
getMultiAssetCollateralAssets()
getMultiAssetCollateralAssets(): Promise<FuturesAPISuccessResponse<FuturesV5MultiAssetsMarginResp>>;Assets Available for Multi-Assets Collateral Mode
Get assets available for multi-assets collateral mode. Signature required. Read permission. Rate limit: 240/3s per IP.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5MultiAssetsMarginResp>>
getMultiAssetFeeCurrencies()
getMultiAssetFeeCurrencies(): Promise<FuturesAPISuccessResponse<FuturesV5AssetsDeductionCurrencyResp>>;Assets Available for Trading Fee Deduction
Get list of assets that can be used to deduct trading fees. Signature required. Read permission. Rate limit: 240/3s per IP.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AssetsDeductionCurrencyResp>>
getMultiAssetFeeCurrency()
getMultiAssetFeeCurrency(): Promise<FuturesAPISuccessResponse<FuturesV5FeeDeductionCurrency>>;Get Fee Deduction Crypto
Query whether fee deduction is enabled and the deduction currency. Signature required. Read permission. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5FeeDeductionCurrency>>
getMultiAssetFills()
getMultiAssetFills(params?: FuturesV5OrderDetailsReq): Promise<FuturesAPISuccessResponse<FuturesV5OrderExecutionDetail[]>>;Get Execution Details (last 3 days)
Get detailed info about executed orders in the last 3 days. Either order_id or client_order_id recommended. Signature required. Read permission.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5OrderDetailsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5OrderExecutionDetail[]>>
getMultiAssetFundingRateHistory()
getMultiAssetFundingRateHistory(params: FuturesV5FundingRateHistoryReq): Promise<FuturesAPISuccessResponse<FuturesV5FundingRateHistory[]>>;Get Funding Rate History
Historical funding rates, including funding_fee_type. No signature. Rate limit: 240/3s per IP, shared with other non-market public requests.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5FundingRateHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5FundingRateHistory[]>>
getMultiAssetLeverage()
getMultiAssetLeverage(params?: FuturesV5LeverListReq): Promise<FuturesAPISuccessResponse<FuturesV5LeverListEntry[]>>;Get Leverage List
Get the list of available leverage for a contract. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5LeverListReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5LeverListEntry[]>>
getMultiAssetMarketRiskLimit()
getMultiAssetMarketRiskLimit(params?: FuturesV5MarketRiskLimitReq): Promise<FuturesAPISuccessResponse<FuturesV5MarketRiskLimitEntry[]>>;Get Futures Risk Limit (Market)
Get futures risk limit table info. Signature required. Read permission. Rate limit: 240/3s per IP.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5MarketRiskLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5MarketRiskLimitEntry[]>>
getMultiAssetMode()
getMultiAssetMode(): Promise<FuturesAPISuccessResponse<FuturesV5AssetModeGet>>;Get Asset Mode
Query the current asset mode (single vs multi-assets collateral). Signature required. Read permission. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AssetModeGet>>
getMultiAssetOpenOrders()
getMultiAssetOpenOrders(params?: FuturesV5OpenOrdersReq): Promise<FuturesAPISuccessResponse<FuturesV5Order[]>>;Get Current Orders
Get unfilled futures orders. Omit params for all open orders. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5OpenOrdersReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5Order[]>>
getMultiAssetOrderHistory()
getMultiAssetOrderHistory(params: FuturesV5OrderHistoryReq): Promise<FuturesAPISuccessResponse<FuturesV5Order[]>>;Get Order History
Get previous futures orders. contract_code and margin_mode required. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5OrderHistoryReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5Order[]>>
getMultiAssetOrderInfo()
getMultiAssetOrderInfo(params: FuturesV5OrderInfoReq): Promise<FuturesAPISuccessResponse<FuturesV5Order>>;Get Order Info
Get information about a specific order. contract_code required; one of order_id or client_order_id required. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5OrderInfoReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5Order>>
getMultiAssetPositionMode()
getMultiAssetPositionMode(): Promise<FuturesAPISuccessResponse<FuturesV5PositionModeResp>>;Get Position Mode
Get the current position mode (one-way vs hedge). Signature required. Read permission. Rate limit: 144/3s per UID.
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PositionModeResp>>
getMultiAssetPositions()
getMultiAssetPositions(params?: object): Promise<FuturesAPISuccessResponse<FuturesV5Position[]>>;Get Current Position
Get information about your current positions. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | { contract_code?: string; } |
params.contract_code? | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5Position[]>>
getMultiAssetRiskLimit()
getMultiAssetRiskLimit(params?: FuturesV5RiskLimitReq): Promise<FuturesAPISuccessResponse<FuturesV5RiskLimitEntry[]>>;Get Futures Risk Limit
Get risk limit info of your current futures position. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params? | FuturesV5RiskLimitReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5RiskLimitEntry[]>>
getMultiAssetRiskLimitTiers()
getMultiAssetRiskLimitTiers(params: object): Promise<FuturesAPISuccessResponse<FuturesV5RiskLimitTierEntry[]>>;Query Position Risk Limit Tiers
Get all risk limit tiers for a contract. Signature required. Read permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; margin_mode?: "cross" | "isolated"; } |
params.contract_code | string |
params.margin_mode? | "cross" | "isolated" |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5RiskLimitTierEntry[]>>
getTimestamp()
getTimestamp(): Promise<FuturesTimestamp>;Get Current System Timestamp
Returns server time in milliseconds. No signature. Rate limit: 240/3s per IP.
Returns
Promise<FuturesTimestamp>
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
removeCopyTraderFollower()
removeCopyTraderFollower(params: FuturesCopyTraderFollowerRemoveReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderFollowerRemoveResult[]>>;Trader Remove Follower
Remove specific followers (max 10 at once). Main Account ApiKey only. Trade permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderFollowerRemoveReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderFollowerRemoveResult[]>>
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
setCoinMDeliveryCancelAfter()
setCoinMDeliveryCancelAfter(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelAfter>>;Automatic Order Cancellation (Future Trade)
Dead Man's Switch for delivery futures. Enable/disable auto-cancel of all pending orders after countdown. If not refreshed before timer ends, all pending orders cancelled. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { on_off: 0 | 1; time_out?: number; } |
params.on_off | 0 | 1 |
params.time_out? | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelAfter>>
setCoinMPerpCancelAfter()
setCoinMPerpCancelAfter(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpCancelAfter>>;Cancel-After (CMPerp)
Dead Man's Switch: enable/disable auto-cancel of all pending orders after countdown. Refresh before timer ends to keep orders. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { on_off: 0 | 1; time_out?: number; } |
params.on_off | 0 | 1 |
params.time_out? | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpCancelAfter>>
setLinearSwapCancelAfter()
setLinearSwapCancelAfter(params: object): Promise<FuturesAPISuccessResponse<FuturesCancelAfter>>;Automatic Order Cancellation (Dead Man's Switch)
Enable/disable auto-cancel of all pending orders after countdown. If not refreshed before timer ends, all pending orders are cancelled. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { on_off: 0 | 1; time_out?: number; } |
params.on_off | 0 | 1 |
params.time_out? | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCancelAfter>>
setMultiAssetCancelAfter()
setMultiAssetCancelAfter(params: FuturesV5CancelAfterReq): Promise<FuturesAPISuccessResponse<FuturesV5CancelAfterResp>>;Automatic Order Cancellation (Dead Man's Switch)
Enable/disable auto-cancel of all pending orders when heartbeat stops. time_out >= 5000 ms; default 5000. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5CancelAfterReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5CancelAfterResp>>
submitCoinMDeliveryBatchOrders()
submitCoinMDeliveryBatchOrders(params: FuturesCmDeliverySubmitBatchOrderReq): Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>;Place a Batch of Orders (Future Trade)
Place up to 25 orders for delivery futures. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitBatchOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>
submitCoinMDeliveryLightningCloseOrder()
submitCoinMDeliveryLightningCloseOrder(params: FuturesCmDeliverySubmitFlashCloseOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Lightning Close Order (Future Trade)
Lightning close position. One of contract_code or (symbol+contract_type). volume, direction required. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitFlashCloseOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMDeliveryOrder()
submitCoinMDeliveryOrder(params: FuturesCmDeliverySubmitOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place an Order (Future Trade)
Place order for delivery futures (weekly/quarterly). One of contract_code or (symbol+contract_type). Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMDeliveryTpslOrder()
submitCoinMDeliveryTpslOrder(params: FuturesCmDeliverySubmitTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>;Set Take-profit and Stop-loss Order (Future Trade)
TPSL for existing position. One of contract_code or (symbol+contract_type). At least one of tp or sl. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>
submitCoinMDeliveryTrailingOrder()
submitCoinMDeliveryTrailingOrder(params: FuturesCmDeliverySubmitTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Trailing Order (Future Trade)
Submit trailing order. One of contract_code or (symbol+contract_type). lever_rate required when open. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMDeliveryTriggerOrder()
submitCoinMDeliveryTriggerOrder(params: FuturesCmDeliverySubmitTriggerOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Trigger Order (Future Trade)
Submit trigger order. One of contract_code or (symbol+contract_type). Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliverySubmitTriggerOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMPerpBatchOrders()
submitCoinMPerpBatchOrders(params: FuturesCmPerpSubmitBatchOrderReq): Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>;Place Batch Orders (CMPerp)
Place up to 25 orders. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpSubmitBatchOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>
submitCoinMPerpLightningCloseOrder()
submitCoinMPerpLightningCloseOrder(params: FuturesCmPerpLightningCloseReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Lightning Close Order (CMPerp)
Close position at rival price + optimal 30 levels. Unfilled becomes limit. Default order_price_type: lightning. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpLightningCloseReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMPerpOrder()
submitCoinMPerpOrder(params: FuturesCmPerpSubmitOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Order (CMPerp)
Place order for coin-m perpetual. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpSubmitOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMPerpTpslOrder()
submitCoinMPerpTpslOrder(params: FuturesCmPerpTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>;Set TPSL Order (CMPerp)
Take-profit and/or stop-loss for existing position. At least one trigger price required. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>
submitCoinMPerpTrailingOrder()
submitCoinMPerpTrailingOrder(params: FuturesCmPerpTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Trailing Order (CMPerp)
Trailing order with callback rate. formula_price = market*(1±callback_rate). Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCoinMPerpTriggerOrder()
submitCoinMPerpTriggerOrder(params: FuturesCmPerpTriggerOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Trigger Order (CMPerp)
ge: trigger when price >= trigger_price; le: <=. order_price needed for limit. Rate limit 5/s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpTriggerOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitCopyTraderTransfer()
submitCopyTraderTransfer(params: FuturesCopyTraderTransferReq): Promise<FuturesAPISuccessResponse<[]>>;Trader Account Transfer
Transfer copy trading funds (USDT). Main Account ApiKey only. Read permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderTransferReq |
Returns
Promise<FuturesAPISuccessResponse<[]>>
submitLinearSwapCrossBatchOrders()
submitLinearSwapCrossBatchOrders(params: FuturesSubmitCrossBatchOrderReq): Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>;Place Batch Orders (Cross)
Place up to 25 orders. Cross margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitCrossBatchOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>
submitLinearSwapCrossLightningCloseOrder()
submitLinearSwapCrossLightningCloseOrder(params: FuturesSubmitCrossLightningCloseOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Lightning Close Position (Cross)
Closes position using optimal 30-grade rival price. One of (pair+contract_type) or contract_code required. Cross only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitCrossLightningCloseOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapCrossOrder()
submitLinearSwapCrossOrder(params: FuturesCrossSubmitOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Order (Cross)
Place a single order. Cross margin only. One of contract_code or (pair+contract_type) required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCrossSubmitOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapCrossTpslOrder()
submitLinearSwapCrossTpslOrder(params: FuturesSubmitCrossTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>;[Cross] Set Take-profit and Stop-loss Order for an Existing Position
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. At least one of tp_trigger_price and sl_trigger_price required. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitCrossTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>
submitLinearSwapCrossTrailingOrder()
submitLinearSwapCrossTrailingOrder(params: FuturesSubmitCrossTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;[Cross] Place a Trailing Order
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitCrossTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapCrossTriggerOrder()
submitLinearSwapCrossTriggerOrder(params: FuturesSubmitCrossTriggerOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;[Cross] Place Trigger Order
Cross margin only. One of (pair+contract_type) or contract_code required; contract_code preferred when all filled. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitCrossTriggerOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapIsolatedBatchOrders()
submitLinearSwapIsolatedBatchOrders(params: FuturesSubmitBatchOrderReq): Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>;Place Batch Orders (Isolated)
Place up to 10 orders. Isolated margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitBatchOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesBatchOrder>>
submitLinearSwapIsolatedLightningCloseOrder()
submitLinearSwapIsolatedLightningCloseOrder(params: FuturesSubmitLightningCloseOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Lightning Close Order (Isolated)
Closes position using optimal 30-grade rival price; unfilled converts to limit. Isolated only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitLightningCloseOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapIsolatedOrder()
submitLinearSwapIsolatedOrder(params: FuturesSubmitOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;Place Order (Isolated)
Place a single order. Isolated margin only. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapIsolatedTpslOrder()
submitLinearSwapIsolatedTpslOrder(params: FuturesSubmitTpslOrderReq): Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>;[Isolated] Set Take-profit and Stop-loss Order for an Existing Position
Isolated margin only. At least one of tp_trigger_price and sl_trigger_price required. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitTpslOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesTpslOrder>>
submitLinearSwapIsolatedTrailingOrder()
submitLinearSwapIsolatedTrailingOrder(params: FuturesSubmitTrailingOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;[Isolated] Place a Trailing Order
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitTrailingOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitLinearSwapIsolatedTriggerOrder()
submitLinearSwapIsolatedTriggerOrder(params: FuturesSubmitTriggerOrderReq): Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>;[Isolated] Place Trigger Order
Isolated margin only. Trade permission. Rate limit: 5/s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesSubmitTriggerOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubmitOrder>>
submitMultiAssetAlgoOrder()
submitMultiAssetAlgoOrder(params: FuturesV5SubmitAlgoOrderReq): Promise<FuturesAPISuccessResponse<FuturesV5PlaceAlgoOrderResp>>;Place algo order
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5SubmitAlgoOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceAlgoOrderResp>>
submitMultiAssetBatchOrders()
submitMultiAssetBatchOrders(orders: FuturesV5SubmitOrderReq[]): Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>;Place Multiple Orders
Place bulk orders in futures trading. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
orders | FuturesV5SubmitOrderReq[] |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceBatchOrderRespItem[]>>
submitMultiAssetOrder()
submitMultiAssetOrder(params: FuturesV5SubmitOrderReq): Promise<FuturesAPISuccessResponse<FuturesV5PlaceOrderResp>>;Place Order
Place an order in futures trading. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5SubmitOrderReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PlaceOrderResp>>
transferCoinMDeliveryMasterSub()
transferCoinMDeliveryMasterSub(params: FuturesCmDeliveryMasterSubTransferReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>;Transfer Between Master And Sub Account (CM)
Master-sub or sub-master transfer. type: master_to_sub or sub_to_master. Rate limit 10/min per sub. Signature required. Trade permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmDeliveryMasterSubTransferReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>
transferCoinMPerpMasterSub()
transferCoinMPerpMasterSub(params: FuturesCmPerpMasterSubTransferReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>;Master-Sub Transfer (CMPerp)
Transfer between master and sub account. Rate limit 10/min per master-sub pair. Signature required.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCmPerpMasterSubTransferReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>
transferLinearSwapInner()
transferLinearSwapInner(params: FuturesTransferInnerReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>;Transfer Between Margin Accounts
Transfer between margin accounts under same account. Supports cross and isolated. Trade permission. Rate limit: 10/min.
Parameters
| Parameter | Type |
|---|---|
params | FuturesTransferInnerReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>
transferLinearSwapMasterSub()
transferLinearSwapMasterSub(params: FuturesTransferMasterSubReq): Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>;Transfer Between Master and Sub Account
Transfer asset between master and sub. Supports cross and isolated. Trade permission. Rate limit: 10/min per sub.
Parameters
| Parameter | Type |
|---|---|
params | FuturesTransferMasterSubReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesMasterSubTransfer>>
updateCoinMDeliveryLeverage()
updateCoinMDeliveryLeverage(params: object): Promise<FuturesAPISuccessResponse<FuturesCmDeliverySwitchLeverRate>>;Switch Leverage (Future Trade)
Set leverage for symbol. Trade permission. Rate limit: 36/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { lever_rate: number; symbol: string; } |
params.lever_rate | number |
params.symbol | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmDeliverySwitchLeverRate>>
updateCoinMDeliverySubPermissions()
updateCoinMDeliverySubPermissions(params: object): Promise<FuturesAPISuccessResponse<FuturesSubAuth>>;Set Sub-Account Trading Permissions (CM)
Enable/disable trading for sub-accounts. sub_uid comma-separated, max 10. Signature required. Trade permission. Rate limit: 72/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { sub_auth: 0 | 1; sub_uid: string; } |
params.sub_auth | 0 | 1 |
params.sub_uid | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubAuth>>
updateCoinMPerpLeverage()
updateCoinMPerpLeverage(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpUpdateLeverage>>;Switch Leverage (CMPerp)
Switch leverage for contract. Rate limit 1/3s. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; lever_rate: number; } |
params.contract_code | string |
params.lever_rate | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpUpdateLeverage>>
updateCoinMPerpSubPermissions()
updateCoinMPerpSubPermissions(params: object): Promise<FuturesAPISuccessResponse<FuturesCmPerpUpdateSubPermissions>>;Set Sub-Account Trading Permissions (CMPerp)
Enable/disable trading for sub-accounts. Max 10 sub UIDs per request. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { sub_auth: 0 | 1; sub_uid: string; } |
params.sub_auth | 0 | 1 |
params.sub_uid | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesCmPerpUpdateSubPermissions>>
updateCopyTraderFollowerSettings()
updateCopyTraderFollowerSettings(params: FuturesCopyTraderFollowerSettingsReq): Promise<FuturesAPISuccessResponse<FuturesCopyTraderConfig[]>>;Trader Set Lead Trading Configuration
Enable/disable copy trading, set profit sharing ratio and max followers. Main Account ApiKey only. Trade permission. Rate limit: 5/s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesCopyTraderFollowerSettingsReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCopyTraderConfig[]>>
updateLinearSwapAccountType()
updateLinearSwapAccountType(params: object): Promise<FuturesAPISuccessResponse<{
account_type: 1 | 2;
}>>;Account Type Change
Switch between unified and non-unified account. No positions and pending orders allowed. When switching to unified, transfer assets from isolated to cross-margin first. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { account_type: 1 | 2; } |
params.account_type | 1 | 2 |
Returns
Promise<FuturesAPISuccessResponse<{ account_type: 1 | 2; }>>
updateLinearSwapCrossLeverage()
updateLinearSwapCrossLeverage(params: FuturesUpdateCrossLeverageReq): Promise<FuturesAPISuccessResponse<FuturesCrossSwitchLeverRate>>;Switch Leverage (Cross)
Set leverage for cross margin contract. Requires no open orders. Trade permission. Rate limit: 1 per 3s.
Parameters
| Parameter | Type |
|---|---|
params | FuturesUpdateCrossLeverageReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesCrossSwitchLeverRate>>
updateLinearSwapCrossPositionMode()
updateLinearSwapCrossPositionMode(params: object): Promise<FuturesAPISuccessResponse<FuturesSwitchPositionMode[]>>;Switch Position Mode (Cross)
Set single_side or dual_side for cross margin account. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account: string; position_mode: "single_side" | "dual_side"; } |
params.margin_account | string |
params.position_mode | "single_side" | "dual_side" |
Returns
Promise<FuturesAPISuccessResponse<FuturesSwitchPositionMode[]>>
updateLinearSwapIsolatedLeverage()
updateLinearSwapIsolatedLeverage(params: object): Promise<FuturesAPISuccessResponse<FuturesSwitchLeverRate>>;Switch Leverage (Isolated)
Set leverage for isolated margin contract. Requires no open orders. Trade permission. Rate limit: 1 per 3s.
Parameters
| Parameter | Type |
|---|---|
params | { contract_code: string; lever_rate: number; } |
params.contract_code | string |
params.lever_rate | number |
Returns
Promise<FuturesAPISuccessResponse<FuturesSwitchLeverRate>>
updateLinearSwapIsolatedPositionMode()
updateLinearSwapIsolatedPositionMode(params: object): Promise<FuturesAPISuccessResponse<FuturesSwitchPositionMode[]>>;Switch Position Mode (Isolated)
Set single_side or dual_side for isolated margin account. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { margin_account: string; position_mode: "single_side" | "dual_side"; } |
params.margin_account | string |
params.position_mode | "single_side" | "dual_side" |
Returns
Promise<FuturesAPISuccessResponse<FuturesSwitchPositionMode[]>>
updateLinearSwapSubPermissions()
updateLinearSwapSubPermissions(params: object): Promise<FuturesAPISuccessResponse<FuturesSubAuth>>;Set Sub-Account Trading Permissions
Enable/disable trading for sub-accounts. Max 10 sub UIDs per request. Signature required. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { sub_auth: 0 | 1; sub_uid: string; } |
params.sub_auth | 0 | 1 |
params.sub_uid | string |
Returns
Promise<FuturesAPISuccessResponse<FuturesSubAuth>>
updateLinearSwapUnifiedFeeMethod()
updateLinearSwapUnifiedFeeMethod(params: object): Promise<FuturesAPISuccessResponse<Record<string, never>>>;Set the U-standard contract fee deduction method
When set currency balance is insufficient, other currencies (e.g. USDT) offset. Only one currency in deduction_currency. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | { deduction_currency: string; fee_option: 0 | 1; } |
params.deduction_currency | string |
params.fee_option | 0 | 1 |
Returns
Promise<FuturesAPISuccessResponse<Record<string, never>>>
updateLinearSwapUnifiedMargin()
updateLinearSwapUnifiedMargin(params: FuturesUpdateUnifiedMarginReq): Promise<FuturesAPISuccessResponse<FuturesFixPositionMarginChange>>;Adjust margin for isolated positions
Increase or decrease isolated margin. Query margin_available (increase) and withdraw_available (reduce) via getLinearSwapUnifiedAccountInfo. Trade permission.
Parameters
| Parameter | Type |
|---|---|
params | FuturesUpdateUnifiedMarginReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesFixPositionMarginChange>>
updateMultiAssetFeeCurrency()
updateMultiAssetFeeCurrency(params: object): Promise<FuturesAPISuccessResponse<FuturesV5FeeDeductionCurrency>>;Set Fee Deduction Crypto
Set the cryptocurrency for deducting trading fees (e.g. HTX, TRX). Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { deduction_currency: string; fee_option: 0 | 1; } |
params.deduction_currency | string |
params.fee_option | 0 | 1 |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5FeeDeductionCurrency>>
updateMultiAssetLeverage()
updateMultiAssetLeverage(params: FuturesV5SetLeverageReq): Promise<FuturesAPISuccessResponse<FuturesV5SetLeverageResp>>;Set Leverage
Set leverage for a contract. position_side required when isolated in two-way mode. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | FuturesV5SetLeverageReq |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5SetLeverageResp>>
updateMultiAssetMode()
updateMultiAssetMode(params: object): Promise<FuturesAPISuccessResponse<FuturesV5AssetMode>>;Set Asset Mode
Set the current asset mode (single vs multi-assets collateral). Signature required. Trade permission. Rate limit: 1 req/10s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { assets_mode: 0 | 1 | 2; } |
params.assets_mode | 0 | 1 | 2 |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5AssetMode>>
updateMultiAssetPositionMode()
updateMultiAssetPositionMode(params: object): Promise<FuturesAPISuccessResponse<FuturesV5PositionModeResp>>;Set Position Mode
Switch between one-way (single_side) and hedge (dual_side) mode. Signature required. Trade permission. Rate limit: 144/3s per UID.
Parameters
| Parameter | Type |
|---|---|
params | { position_mode: "single_side" | "dual_side"; } |
params.position_mode | "single_side" | "dual_side" |
Returns
Promise<FuturesAPISuccessResponse<FuturesV5PositionModeResp>>