Skip to content

Class: FuturesClient ​

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

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

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

Returns ​

FuturesClient

Inherited from ​

BaseRestClient.constructor

Methods ​

addCopyTradeIsolatedMargin() ​

ts
addCopyTradeIsolatedMargin(params: object): Promise<APISuccessResponse<CopyTradePosition>>;

Add Isolated Margin (Copy Trading) Add Isolated Margin Manually.

Parameters ​

ParameterType
params{ bizNo: string; margin: number; positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; }
params.bizNostring
params.marginnumber
params.positionSide?"BOTH" | "LONG" | "SHORT"
params.symbolstring

Returns ​

Promise<APISuccessResponse<CopyTradePosition>>


batchCancelOrders() ​

ts
batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<BatchCancelOrderResult[]>>;

Batch Cancel Orders Cancel multiple orders.

Parameters ​

ParameterType
paramsBatchCancelOrdersRequest

Returns ​

Promise<APISuccessResponse<BatchCancelOrderResult[]>>


batchSwitchMarginMode() ​

ts
batchSwitchMarginMode(params: object): Promise<APISuccessResponse<BatchMarginModeUpdateResponse>>;

Batch Switch Margin Mode Batch modify the margin mode of the symbols.

Parameters ​

ParameterType
params{ marginMode: "ISOLATED" | "CROSS"; symbols: string[]; }
params.marginMode"ISOLATED" | "CROSS"
params.symbolsstring[]

Returns ​

Promise<APISuccessResponse<BatchMarginModeUpdateResponse>>


cancelAllOrdersV3() ​

ts
cancelAllOrdersV3(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel All Orders Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelAllStopOrders() ​

ts
cancelAllStopOrders(params?: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel All Stop orders Using this endpoint, all untriggered stop orders can be canceled in batches.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelCopyTradeOrderByClientOid() ​

ts
cancelCopyTradeOrderByClientOid(params: object): Promise<APISuccessResponse<{
  clientOid: string;
}>>;

Cancel Order By Client Order Id Cancel an order (including a stop order) in copy trading by client order id.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ clientOid: string; }>>


cancelCopyTradeOrderById() ​

ts
cancelCopyTradeOrderById(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel Order By OrderId Cancel an order (including a stop order) in copy trading.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelOrderByClientOid() ​

ts
cancelOrderByClientOid(params: object): Promise<APISuccessResponse<{
  clientOid: string;
}>>;

Cancel Order By Client Order Id Cancel an order (including a stop order) by client order id.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ clientOid: string; }>>


cancelOrderById() ​

ts
cancelOrderById(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel Order By OrderId Cancel an order (including a stop order).

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


changeCrossMarginLeverage() ​

ts
changeCrossMarginLeverage(params: object): Promise<APISuccessResponse<{
  leverage: string;
  symbol: string;
}>>;

Modify Cross Margin Leverage This endpoint can modify the current symbol's cross-margin leverage multiple.

Parameters ​

ParameterType
params{ leverage: string; symbol: string; }
params.leveragestring
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ leverage: string; symbol: string; }>>


deletePrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


depositMargin() ​

ts
depositMargin(params: object): Promise<APISuccessResponse<AddMargin>>;

Add Isolated Margin Add Isolated Margin Manually.

Parameters ​

ParameterType
params{ bizNo: string; margin: number; symbol: string; }
params.bizNostring
params.marginnumber
params.symbolstring

Returns ​

Promise<APISuccessResponse<AddMargin>>


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Misc Utility Methods

Returns ​

string


get() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


get24HourTransactionVolume() ​

ts
get24HourTransactionVolume(): Promise<APISuccessResponse<{
  turnoverOf24h: number;
}>>;

Get 24hr Stats Get the statistics of the platform futures trading volume in the last 24 hours.

Returns ​

Promise<APISuccessResponse<{ turnoverOf24h: number; }>>


getBalance() ​

ts
getBalance(params?: object): Promise<APISuccessResponse<AccountBalance>>;

Get Account - Futures Request via this endpoint to get the info of the futures account.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<AccountBalance>>


ts
getBrokerRebateOrderDownloadLink(params: object): Promise<APISuccessResponse<any>>;

Get download link for broker rebate orders

trade type 1 = spot, trade type 2 = futures

Parameters ​

ParameterType
params{ begin: string; end: string; tradeType: 1 | 2; }
params.beginstring
params.endstring
params.tradeType1 | 2

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

Use getBrokerRebateOrderDownloadLinkV2 instead


getBrokerRebateOrderDownloadLinkV2() ​

ts
getBrokerRebateOrderDownloadLinkV2(params: object): Promise<APISuccessResponse<any>>;

Get download link for broker rebate orders

trade type SPOT = spot, FUTURE = futures

Parameters ​

ParameterType
params{ begin: string; end: string; tradeType: "SPOT" | "FUTURE"; }
params.beginstring
params.endstring
params.tradeType"SPOT" | "FUTURE"

Returns ​

Promise<APISuccessResponse<any>>


getClientType() ​

ts
getClientType(): RestClientType;

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

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getCopyTradeCrossMarginRequirement() ​

ts
getCopyTradeCrossMarginRequirement(params: CopyTradeGetCrossMarginRequirementRequest): Promise<APISuccessResponse<CopyTradeCrossMarginRequirement[]>>;

Get Cross Margin Requirement (Copy Trading) This endpoint supports querying the cross margin requirements of a symbol by position value.

Parameters ​

ParameterType
paramsCopyTradeGetCrossMarginRequirementRequest

Returns ​

Promise<APISuccessResponse<CopyTradeCrossMarginRequirement[]>>


getCopyTradeMaxOpenSize() ​

ts
getCopyTradeMaxOpenSize(params: object): Promise<APISuccessResponse<{
  leverage: number;
  price: string;
  symbol: string;
}>>;

Get Max Open Size Get Maximum Open Position Size.

Parameters ​

ParameterType
params{ maxBuyOpenSize: string; maxSellOpenSize: string; symbol: string; }
params.maxBuyOpenSizestring
params.maxSellOpenSizestring
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ leverage: number; price: string; symbol: string; }>>


getCopyTradeMaxWithdrawMargin() ​

ts
getCopyTradeMaxWithdrawMargin(params: object): Promise<APISuccessResponse<string>>;

Get Max Withdraw Margin (Copy Trading) This endpoint can query the maximum amount of margin that the current position supports withdrawal.

Parameters ​

ParameterType
params{ positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; }
params.positionSide?"BOTH" | "LONG" | "SHORT"
params.symbolstring

Returns ​

Promise<APISuccessResponse<string>>


getCrossMarginLeverage() ​

ts
getCrossMarginLeverage(params: object): Promise<APISuccessResponse<{
  leverage: string;
  symbol: string;
}>>;

Get Cross Margin Leverage This endpoint can query the current symbol's cross-margin leverage multiple.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ leverage: string; symbol: string; }>>


getCrossMarginRequirement() ​

ts
getCrossMarginRequirement(params: object): Promise<APISuccessResponse<CrossMarginRequirement>>;

Get Cross Margin Requirement This endpoint supports querying the cross margin requirements of a symbol by position value.

Parameters ​

ParameterType
params{ leverage?: string; positionValue: string; symbol: string; }
params.leverage?string
params.positionValuestring
params.symbolstring

Returns ​

Promise<APISuccessResponse<CrossMarginRequirement>>


getCrossMarginRiskLimit() ​

ts
getCrossMarginRiskLimit(params: object): Promise<APISuccessResponse<CrossMarginRiskLimit[]>>;

Get Cross Margin Risk Limit Batch get cross margin risk limit. (It should be noted that the risk limit of cross margin does not have a fixed gear, but is a smooth curve)

Parameters ​

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

Returns ​

Promise<APISuccessResponse<CrossMarginRiskLimit[]>>


getFills() ​

ts
getFills(params?: AccountFillsRequest): Promise<APISuccessResponse<FuturesFills>>;

Get Trade History Get a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time. Note: For liquidation orders, tradeType returns liquid (as of 2026.05.15).

Parameters ​

ParameterType
params?AccountFillsRequest

Returns ​

Promise<APISuccessResponse<FuturesFills>>


getFullOrderBookLevel2() ​

ts
getFullOrderBookLevel2(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;

Get Full OrderBook Query for Full orderbook depth data. (aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FullOrderBookDetail>>


getFundingHistory() ​

ts
getFundingHistory(params: GetFundingHistoryRequest): Promise<APISuccessResponse<{
  dataList: FuturesAccountFundingRateHistory[];
  hasMore: boolean;
}>>;

Get Private Funding History Submit request to get the funding history.

Parameters ​

ParameterType
paramsGetFundingHistoryRequest

Returns ​

Promise<APISuccessResponse<{ dataList: FuturesAccountFundingRateHistory[]; hasMore: boolean; }>>


getFundingRate() ​

ts
getFundingRate(params: object): Promise<APISuccessResponse<FuturesCurrentFundingRate>>;

Get Current Funding Rate This endpoint can be used to obtain the current funding rate of the specified symbol.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesCurrentFundingRate>>


getFundingRates() ​

ts
getFundingRates(params: GetFundingRatesRequest): Promise<APISuccessResponse<FuturesHistoricFundingRate[]>>;

Get Public Funding History Query the funding rate at each settlement time point within a certain time range of the corresponding contract

Parameters ​

ParameterType
paramsGetFundingRatesRequest

Returns ​

Promise<APISuccessResponse<FuturesHistoricFundingRate[]>>


getHistoryPositions() ​

ts
getHistoryPositions(params?: object): Promise<APISuccessResponse<FuturesClosedPositions>>;

Get Positions History This endpoint can query position history information records.

Parameters ​

ParameterType
params?{ from?: number; limit?: number; pageId?: number; symbol?: string; to?: number; }
params.from?number
params.limit?number
params.pageId?number
params.symbol?string
params.to?number

Returns ​

Promise<APISuccessResponse<FuturesClosedPositions>>


getIndex() ​

ts
getIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
  dataList: IndexListItem[];
  hasMore: boolean;
}>>;

Get Spot Index Price This endpoint returns the index price of the specified symbol.

Parameters ​

ParameterType
paramsGetInterestRatesRequest

Returns ​

Promise<APISuccessResponse<{ dataList: IndexListItem[]; hasMore: boolean; }>>


getInterestRates() ​

ts
getInterestRates(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
  dataList: InterestRateItem[];
  hasMore: boolean;
}>>;

Get Interest Rate Index This endpoint returns the interest rate index of the specified symbol.

Parameters ​

ParameterType
paramsGetInterestRatesRequest

Returns ​

Promise<APISuccessResponse<{ dataList: InterestRateItem[]; hasMore: boolean; }>>


getKlines() ​

ts
getKlines(params: GetKlinesRequest): Promise<APISuccessResponse<FuturesKline[]>>;

Get Klines Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.

Parameters ​

ParameterType
paramsGetKlinesRequest

Returns ​

Promise<APISuccessResponse<FuturesKline[]>>


getMarginMode() ​

ts
getMarginMode(params: object): Promise<APISuccessResponse<{
  marginMode: "ISOLATED" | "CROSS";
  symbol: string;
}>>;

Get Margin Mode This endpoint can query the margin mode of the current symbol.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ marginMode: "ISOLATED" | "CROSS"; symbol: string; }>>


getMarketTrades() ​

ts
getMarketTrades(params: object): Promise<APISuccessResponse<MarketTradeDetail>>;

Get Trade History Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<MarketTradeDetail>>


getMarkPrice() ​

ts
getMarkPrice(params: object): Promise<APISuccessResponse<FuturesMarkPrice>>;

Get Mark Price Get the mark price of the symbol.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesMarkPrice>>


getMaxOpenSize() ​

ts
getMaxOpenSize(params: MaxOpenSizeRequest): Promise<APISuccessResponse<MaxOpenSize>>;

Get Max Open Size Get Maximum Open Position Size.

Parameters ​

ParameterType
paramsMaxOpenSizeRequest

Returns ​

Promise<APISuccessResponse<MaxOpenSize>>


getMaxWithdrawMargin() ​

ts
getMaxWithdrawMargin(params: object): Promise<APISuccessResponse<string>>;

Get Max Withdraw Margin This endpoint can query the maximum amount of margin that the current position supports withdrawal.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<string>>


getOpenOrderStatistics() ​

ts
getOpenOrderStatistics(params: object): Promise<APISuccessResponse<FuturesActiveOrder>>;

Get Open Order Value You can query this endpoint to get the the total number and value of the all your active orders.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesActiveOrder>>


getOrderByClientOrderId() ​

ts
getOrderByClientOrderId(params: object): Promise<APISuccessResponse<FuturesOrder>>;

Get Order By Client Order Id Get order details by client order id.

Parameters ​

ParameterType
params{ clientOid: string; }
params.clientOidstring

Returns ​

Promise<APISuccessResponse<FuturesOrder>>


getOrderByOrderId() ​

ts
getOrderByOrderId(params: object): Promise<APISuccessResponse<FuturesOrder>>;

Get Order By OrderId Get order details by order id.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<FuturesOrder>>


getOrders() ​

ts
getOrders(params?: GetOrdersRequest): Promise<APISuccessResponse<FuturesOrders>>;

Get Order List List your current orders. Any limit order on the exchange order book is in active status.

Parameters ​

ParameterType
params?GetOrdersRequest

Returns ​

Promise<APISuccessResponse<FuturesOrders>>


getPartOrderBookLevel2Depth100() ​

ts
getPartOrderBookLevel2Depth100(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;

Get Part OrderBook Query for part orderbook depth data. (aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FullOrderBookDetail>>


getPartOrderBookLevel2Depth20() ​

ts
getPartOrderBookLevel2Depth20(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;

Get Part OrderBook Query for part orderbook depth data. (aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FullOrderBookDetail>>


getPosition() ​

ts
getPosition(params: object): Promise<APISuccessResponse<FuturesPosition>>;

Get Position Details Get the position details of a specified position.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesPosition>>

Deprecated ​

Use getPositionV2 instead


getPositionMode() ​

ts
getPositionMode(): Promise<APISuccessResponse<GetPositionModeResponse>>;

Get Position Mode This interface can query the position mode of this account.

Returns ​

Promise<APISuccessResponse<GetPositionModeResponse>>


getPositions() ​

ts
getPositions(params?: object): Promise<APISuccessResponse<FuturesPosition[]>>;

Get Position List Get the position details of a specified position.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<FuturesPosition[]>>


getPositionV2() ​

ts
getPositionV2(params: object): Promise<APISuccessResponse<FuturesPosition>>;

Get Position Details Get the position details of a specified position.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesPosition>>


getPremiumIndex() ​

ts
getPremiumIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
  dataList: PremiumIndexItem[];
  hasMore: boolean;
}>>;

Get Premium Index This endpoint returns the premium index of the specified symbol.

Parameters ​

ParameterType
paramsGetInterestRatesRequest

Returns ​

Promise<APISuccessResponse<{ dataList: PremiumIndexItem[]; hasMore: boolean; }>>


getPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getPrivateWSConnectionToken() ​

ts
getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;

Private V1 WS Connection Token & URL

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>


getPrivateWSConnectionTokenV2() ​

ts
getPrivateWSConnectionTokenV2(): Promise<APISuccessResponse<WsConnectionInfo>>;

Fetch connection token for V2 (Pro) private connections. Not needed for public. Only returns token, no URL.

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>


getPublicWSConnectionToken() ​

ts
getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;

Public V1 WS Connection Token & URL

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>


getRecentFills() ​

ts
getRecentFills(params?: object): Promise<APISuccessResponse<FuturesFill[]>>;

Get Recent Trade History Get a list of recent 1000 fills in the last 24 hours.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<FuturesFill[]>>


getRecentOrders() ​

ts
getRecentOrders(params?: object): Promise<APISuccessResponse<FuturesOrder[]>>;

Get Recent Closed Orders Get a list of recent 1000 closed orders in the last 24 hours.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<FuturesOrder[]>>


getRiskLimitLevel() ​

ts
getRiskLimitLevel(params: object): Promise<APISuccessResponse<FuturesRiskLimit[]>>;

Get Isolated Margin Risk Limit This endpoint can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesRiskLimit[]>>


getServerTime() ​

ts
getServerTime(): Promise<APISuccessResponse<number>>;

Get Server Time Get the API server time. This is the Unix timestamp.

Returns ​

Promise<APISuccessResponse<number>>


getServiceStatus() ​

ts
getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;

Get Service Status This endpoint returns the status of the API service.

Returns ​

Promise<APISuccessResponse<ServiceStatus>>


getStopOrders() ​

ts
getStopOrders(params?: GetStopOrdersRequest): Promise<APISuccessResponse<FuturesOrders>>;

Get Stop Order List Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order endpoint

Parameters ​

ParameterType
params?GetStopOrdersRequest

Returns ​

Promise<APISuccessResponse<FuturesOrders>>


getSubBalances() ​

ts
getSubBalances(params?: object): Promise<APISuccessResponse<{
  accounts: FuturesSubAccount[];
  summary: AccountSummary;
}>>;

Get SubAccount List - Futures Balance(V2) This endpoint can be used to get Futures sub-account information.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ accounts: FuturesSubAccount[]; summary: AccountSummary; }>>


getSymbol() ​

ts
getSymbol(params: object): Promise<APISuccessResponse<FuturesSymbolInfo>>;

Get Symbol Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<FuturesSymbolInfo>>


getSymbols() ​

ts
getSymbols(): Promise<APISuccessResponse<FuturesSymbolInfo[]>>;

Get Symbol Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.

Returns ​

Promise<APISuccessResponse<FuturesSymbolInfo[]>>


getTicker() ​

ts
getTicker(params: object): Promise<APISuccessResponse<TickerDetail>>;

Get Ticker This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of a single symbol.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<TickerDetail>>


getTickers() ​

ts
getTickers(): Promise<APISuccessResponse<TickerDetail[]>>;

Get All Tickers This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of all symbol.

Returns ​

Promise<APISuccessResponse<TickerDetail[]>>


getTradingPairFee() ​

ts
getTradingPairFee(params: object): Promise<APISuccessResponse<{
  makerFeeRate: string;
  symbol: string;
  takerFeeRate: string;
}>>;

Get Actual Fee - Futures This endpoint is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ makerFeeRate: string; symbol: string; takerFeeRate: string; }>>


getTransactions() ​

ts
getTransactions(params: GetTransactionsRequest): Promise<APISuccessResponse<{
  dataList: FuturesAccountTransaction[];
  hasMore: boolean;
}>>;

Get Account Ledgers - Futures This endpoint can query the ledger records of the futures business line

Parameters ​

ParameterType
paramsGetTransactionsRequest

Returns ​

Promise<APISuccessResponse<{ dataList: FuturesAccountTransaction[]; hasMore: boolean; }>>


getTransfers() ​

ts
getTransfers(params?: object): Promise<APISuccessResponse<any>>;

Parameters ​

ParameterType
params?{ currency?: string; currentPage?: number; endAt?: number; pageSize?: number; startAt?: number; tag?: string[]; type?: "MAIN" | "TRADE" | "MARGIN" | "ISOLATED"; }
params.currency?string
params.currentPage?number
params.endAt?number
params.pageSize?number
params.startAt?number
params.tag?string[]
params.type?"MAIN" | "TRADE" | "MARGIN" | "ISOLATED"

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

  • please use universal transfer from SpotClient

hasAccessToken() ​

ts
hasAccessToken(): boolean;

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


modifyCopyTradeRiskLimitLevel() ​

ts
modifyCopyTradeRiskLimitLevel(params: object): Promise<APISuccessResponse<boolean>>;

Modify Isolated Margin Risk Limit This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin). To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not.

Parameters ​

ParameterType
params{ level: number; symbol: string; }
params.levelnumber
params.symbolstring

Returns ​

Promise<APISuccessResponse<boolean>>


post() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any
internalReqContext?InternalRequestContext

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


removeCopyTradeIsolatedMargin() ​

ts
removeCopyTradeIsolatedMargin(params: object): Promise<APISuccessResponse<string>>;

Remove Isolated Margin (Copy Trading) Remove Isolated Margin Manually.

Parameters ​

ParameterType
params{ positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; withdrawAmount: string; }
params.positionSide?"BOTH" | "LONG" | "SHORT"
params.symbolstring
params.withdrawAmountstring

Returns ​

Promise<APISuccessResponse<string>>


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


submitCopyTradeOrder() ​

ts
submitCopyTradeOrder(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  orderId: string;
}>>;

Add Order (Copy Trading) Place order to the futures trading system for copy trading. Max leverage is set to 20x, and marginMode supports both ISOLATED and CROSS.

Parameters ​

ParameterType
paramsCopyTradeOrderRequest

Returns ​

Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>


submitCopyTradeOrderTest() ​

ts
submitCopyTradeOrderTest(params: CopyTradeOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  orderId: string;
}>>;

Add Order Test (Copy Trading) Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. Max leverage is set to 20x, and marginMode supports both ISOLATED and CROSS.

Parameters ​

ParameterType
paramsCopyTradeOrderRequest

Returns ​

Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>


submitCopyTradeSLTPOrder() ​

ts
submitCopyTradeSLTPOrder(params: CopyTradeSLTPOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  orderId: string;
}>>;

Add Take Profit And Stop Loss Order (Copy Trading) Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint. Max leverage is set to 20x, and marginMode supports both ISOLATED and CROSS.

Parameters ​

ParameterType
paramsCopyTradeSLTPOrderRequest

Returns ​

Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>


submitMultipleOrders() ​

ts
submitMultipleOrders(params: Order[]): Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>;

Batch Add Orders Place multiple order to the futures trading system

Parameters ​

ParameterType
paramsOrder[]

Returns ​

Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>


submitNewOrderTest() ​

ts
submitNewOrderTest(params: Order): Promise<{
  clientOid?: string;
  orderId?: string;
}>;

Add Order Test Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations.

Parameters ​

ParameterType
paramsOrder

Returns ​

Promise<{ clientOid?: string; orderId?: string; }>


submitOrder() ​

ts
submitOrder(params: Order): Promise<APISuccessResponse<{
  clientOid?: string;
  orderId?: string;
}>>;

Add Order Place order to the futures trading system

Parameters ​

ParameterType
paramsOrder

Returns ​

Promise<APISuccessResponse<{ clientOid?: string; orderId?: string; }>>


submitSLTPOrder() ​

ts
submitSLTPOrder(params: SLTPOrder): Promise<APISuccessResponse<{
  clientOid?: string;
  orderId?: string;
}>>;

Add Take Profit And Stop Loss Order Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order endpoint.

Parameters ​

ParameterType
paramsSLTPOrder

Returns ​

Promise<APISuccessResponse<{ clientOid?: string; orderId?: string; }>>


submitTransferIn() ​

ts
submitTransferIn(params: object): Promise<APISuccessResponse<any>>;

Parameters ​

ParameterType
params{ amount: number; currency: string; payAccountType: "MAIN" | "TRADE"; }
params.amountnumber
params.currencystring
params.payAccountType"MAIN" | "TRADE"

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

  • please use universal transfer from SpotClient

submitTransferOut() ​

ts
submitTransferOut(params: object): Promise<APISuccessResponse<any>>;

Parameters ​

ParameterType
params{ amount: number; currency: string; recAccountType: "MAIN" | "TRADE"; }
params.amountnumber
params.currencystring
params.recAccountType"MAIN" | "TRADE"

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

  • please use universal transfer from SpotClient

switchCopyTradeMarginMode() ​

ts
switchCopyTradeMarginMode(params: CopyTradeSwitchMarginModeRequest): Promise<APISuccessResponse<CopyTradeSwitchMarginModeResponse>>;

Switch Margin Mode (Copy Trading) Modify the margin mode of the current symbol.

Parameters ​

ParameterType
paramsCopyTradeSwitchMarginModeRequest

Returns ​

Promise<APISuccessResponse<CopyTradeSwitchMarginModeResponse>>


switchCopyTradePositionMode() ​

ts
switchCopyTradePositionMode(params: CopyTradeSwitchPositionModeRequest): Promise<APISuccessResponse<CopyTradeSwitchPositionModeResponse>>;

Switch Position Mode (Copy Trading) This interface is used to toggle between one-way mode and hedge mode for the position mode. Applies to all futures trading pairs.

Parameters ​

ParameterType
paramsCopyTradeSwitchPositionModeRequest

Returns ​

Promise<APISuccessResponse<CopyTradeSwitchPositionModeResponse>>


updateAutoDepositStatus() ​

ts
updateAutoDepositStatus(params: object): Promise<APISuccessResponse<any>>;

Parameters ​

ParameterType
params{ status: boolean; symbol: string; }
params.statusboolean
params.symbolstring

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

  • please use updateMarginMode() instead

updateCopyTradeAutoDepositStatus() ​

ts
updateCopyTradeAutoDepositStatus(params: object): Promise<APISuccessResponse<boolean>>;

Modify Isolated Margin Auto-Deposit Status (Copy Trading) This endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead.

Parameters ​

ParameterType
params{ positionSide?: "BOTH" | "LONG" | "SHORT"; status: boolean; symbol: string; }
params.positionSide?"BOTH" | "LONG" | "SHORT"
params.statusboolean
params.symbolstring

Returns ​

Promise<APISuccessResponse<boolean>>

Deprecated ​

  • It is recommended to use cross margin instead

updateCopyTradeCrossMarginLeverage() ​

ts
updateCopyTradeCrossMarginLeverage(params: CopyTradeChangeCrossMarginLeverageRequest): Promise<APISuccessResponse<boolean>>;

Modify Cross Margin Leverage (Copy Trading) This interface can modify the current symbol's cross-margin leverage multiple.

Parameters ​

ParameterType
paramsCopyTradeChangeCrossMarginLeverageRequest

Returns ​

Promise<APISuccessResponse<boolean>>


updateMarginMode() ​

ts
updateMarginMode(params: object): Promise<APISuccessResponse<{
  marginMode: "ISOLATED" | "CROSS";
  symbol: string;
}>>;

Switch Margin Mode Modify the margin mode of the current symbol.

Parameters ​

ParameterType
params{ marginMode: "ISOLATED" | "CROSS"; symbol: string; }
params.marginMode"ISOLATED" | "CROSS"
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ marginMode: "ISOLATED" | "CROSS"; symbol: string; }>>


updatePositionMode() ​

ts
updatePositionMode(params: object): Promise<APISuccessResponse<{
  positionMode: "0" | "1";
}>>;

Switch Position Mode This endpoint can switch the position mode of the current symbol.

Parameters ​

ParameterType
params{ positionMode: "0" | "1"; }
params.positionMode"0" | "1"

Returns ​

Promise<APISuccessResponse<{ positionMode: "0" | "1"; }>>


updateRiskLimitLevel() ​

ts
updateRiskLimitLevel(params: object): Promise<boolean>;

Modify Isolated Margin Risk Limit This endpoint is for the adjustment of the risk limit level(Only valid for isolated Margin).

Parameters ​

ParameterType
params{ level: number; symbol: string; }
params.levelnumber
params.symbolstring

Returns ​

Promise<boolean>


withdrawMargin() ​

ts
withdrawMargin(params: object): Promise<APISuccessResponse<string>>;

Remove Isolated Margin Remove Isolated Margin Manually.

Parameters ​

ParameterType
params{ symbol: string; withdrawAmount: string; }
params.symbolstring
params.withdrawAmountstring

Returns ​

Promise<APISuccessResponse<string>>

Built by Siebly. Open source SDKs for exchange APIs.