Class: FuturesClient
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
addCopyTradeIsolatedMargin()
addCopyTradeIsolatedMargin(params: object): Promise<APISuccessResponse<CopyTradePosition>>;Add Isolated Margin (Copy Trading) Add Isolated Margin Manually.
Parameters
| Parameter | Type |
|---|---|
params | { bizNo: string; margin: number; positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; } |
params.bizNo | string |
params.margin | number |
params.positionSide? | "BOTH" | "LONG" | "SHORT" |
params.symbol | string |
Returns
Promise<APISuccessResponse<CopyTradePosition>>
batchCancelOrders()
batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<BatchCancelOrderResult[]>>;Batch Cancel Orders Cancel multiple orders.
Parameters
| Parameter | Type |
|---|---|
params | BatchCancelOrdersRequest |
Returns
Promise<APISuccessResponse<BatchCancelOrderResult[]>>
batchSwitchMarginMode()
batchSwitchMarginMode(params: object): Promise<APISuccessResponse<BatchMarginModeUpdateResponse>>;Batch Switch Margin Mode Batch modify the margin mode of the symbols.
Parameters
| Parameter | Type |
|---|---|
params | { marginMode: "ISOLATED" | "CROSS"; symbols: string[]; } |
params.marginMode | "ISOLATED" | "CROSS" |
params.symbols | string[] |
Returns
Promise<APISuccessResponse<BatchMarginModeUpdateResponse>>
cancelAllOrdersV3()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelAllStopOrders()
cancelAllStopOrders(params?: object): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Cancel All Stop orders Using this endpoint, all untriggered stop orders can be canceled in batches.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelCopyTradeOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid?: string; symbol: string; } |
params.clientOid? | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ clientOid: string; }>>
cancelCopyTradeOrderById()
cancelCopyTradeOrderById(params: object): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Cancel Order By OrderId Cancel an order (including a stop order) in copy trading.
Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ clientOid: string; }>>
cancelOrderById()
cancelOrderById(params: object): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Cancel Order By OrderId Cancel an order (including a stop order).
Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
changeCrossMarginLeverage()
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
| Parameter | Type |
|---|---|
params | { leverage: string; symbol: string; } |
params.leverage | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ leverage: string; symbol: string; }>>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
depositMargin()
depositMargin(params: object): Promise<APISuccessResponse<AddMargin>>;Add Isolated Margin Add Isolated Margin Manually.
Parameters
| Parameter | Type |
|---|---|
params | { bizNo: string; margin: number; symbol: string; } |
params.bizNo | string |
params.margin | number |
params.symbol | string |
Returns
Promise<APISuccessResponse<AddMargin>>
generateNewOrderID()
generateNewOrderID(): string;Misc Utility Methods
Returns
string
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
get24HourTransactionVolume()
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()
getBalance(params?: object): Promise<APISuccessResponse<AccountBalance>>;Get Account - Futures Request via this endpoint to get the info of the futures account.
Parameters
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<AccountBalance>>
getBrokerRebateOrderDownloadLink()
getBrokerRebateOrderDownloadLink(params: object): Promise<APISuccessResponse<any>>;Get download link for broker rebate orders
trade type 1 = spot, trade type 2 = futures
Parameters
| Parameter | Type |
|---|---|
params | { begin: string; end: string; tradeType: 1 | 2; } |
params.begin | string |
params.end | string |
params.tradeType | 1 | 2 |
Returns
Promise<APISuccessResponse<any>>
Deprecated
Use getBrokerRebateOrderDownloadLinkV2 instead
getBrokerRebateOrderDownloadLinkV2()
getBrokerRebateOrderDownloadLinkV2(params: object): Promise<APISuccessResponse<any>>;Get download link for broker rebate orders
trade type SPOT = spot, FUTURE = futures
Parameters
| Parameter | Type |
|---|---|
params | { begin: string; end: string; tradeType: "SPOT" | "FUTURE"; } |
params.begin | string |
params.end | string |
params.tradeType | "SPOT" | "FUTURE" |
Returns
Promise<APISuccessResponse<any>>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getCopyTradeCrossMarginRequirement()
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
| Parameter | Type |
|---|---|
params | CopyTradeGetCrossMarginRequirementRequest |
Returns
Promise<APISuccessResponse<CopyTradeCrossMarginRequirement[]>>
getCopyTradeMaxOpenSize()
getCopyTradeMaxOpenSize(params: object): Promise<APISuccessResponse<{
leverage: number;
price: string;
symbol: string;
}>>;Get Max Open Size Get Maximum Open Position Size.
Parameters
| Parameter | Type |
|---|---|
params | { maxBuyOpenSize: string; maxSellOpenSize: string; symbol: string; } |
params.maxBuyOpenSize | string |
params.maxSellOpenSize | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ leverage: number; price: string; symbol: string; }>>
getCopyTradeMaxWithdrawMargin()
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
| Parameter | Type |
|---|---|
params | { positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; } |
params.positionSide? | "BOTH" | "LONG" | "SHORT" |
params.symbol | string |
Returns
Promise<APISuccessResponse<string>>
getCrossMarginLeverage()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ leverage: string; symbol: string; }>>
getCrossMarginRequirement()
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
| Parameter | Type |
|---|---|
params | { leverage?: string; positionValue: string; symbol: string; } |
params.leverage? | string |
params.positionValue | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<CrossMarginRequirement>>
getCrossMarginRiskLimit()
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
| Parameter | Type |
|---|---|
params | { leverage?: number; symbol: string; totalMargin?: string; } |
params.leverage? | number |
params.symbol | string |
params.totalMargin? | string |
Returns
Promise<APISuccessResponse<CrossMarginRiskLimit[]>>
getFills()
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
| Parameter | Type |
|---|---|
params? | AccountFillsRequest |
Returns
Promise<APISuccessResponse<FuturesFills>>
getFullOrderBookLevel2()
getFullOrderBookLevel2(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;Get Full OrderBook Query for Full orderbook depth data. (aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FullOrderBookDetail>>
getFundingHistory()
getFundingHistory(params: GetFundingHistoryRequest): Promise<APISuccessResponse<{
dataList: FuturesAccountFundingRateHistory[];
hasMore: boolean;
}>>;Get Private Funding History Submit request to get the funding history.
Parameters
| Parameter | Type |
|---|---|
params | GetFundingHistoryRequest |
Returns
Promise<APISuccessResponse<{ dataList: FuturesAccountFundingRateHistory[]; hasMore: boolean; }>>
getFundingRate()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesCurrentFundingRate>>
getFundingRates()
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
| Parameter | Type |
|---|---|
params | GetFundingRatesRequest |
Returns
Promise<APISuccessResponse<FuturesHistoricFundingRate[]>>
getHistoryPositions()
getHistoryPositions(params?: object): Promise<APISuccessResponse<FuturesClosedPositions>>;Get Positions History This endpoint can query position history information records.
Parameters
| Parameter | Type |
|---|---|
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()
getIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
dataList: IndexListItem[];
hasMore: boolean;
}>>;Get Spot Index Price This endpoint returns the index price of the specified symbol.
Parameters
| Parameter | Type |
|---|---|
params | GetInterestRatesRequest |
Returns
Promise<APISuccessResponse<{ dataList: IndexListItem[]; hasMore: boolean; }>>
getInterestRates()
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
| Parameter | Type |
|---|---|
params | GetInterestRatesRequest |
Returns
Promise<APISuccessResponse<{ dataList: InterestRateItem[]; hasMore: boolean; }>>
getKlines()
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
| Parameter | Type |
|---|---|
params | GetKlinesRequest |
Returns
Promise<APISuccessResponse<FuturesKline[]>>
getMarginMode()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ marginMode: "ISOLATED" | "CROSS"; symbol: string; }>>
getMarketTrades()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<MarketTradeDetail>>
getMarkPrice()
getMarkPrice(params: object): Promise<APISuccessResponse<FuturesMarkPrice>>;Get Mark Price Get the mark price of the symbol.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesMarkPrice>>
getMaxOpenSize()
getMaxOpenSize(params: MaxOpenSizeRequest): Promise<APISuccessResponse<MaxOpenSize>>;Get Max Open Size Get Maximum Open Position Size.
Parameters
| Parameter | Type |
|---|---|
params | MaxOpenSizeRequest |
Returns
Promise<APISuccessResponse<MaxOpenSize>>
getMaxWithdrawMargin()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<string>>
getOpenOrderStatistics()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesActiveOrder>>
getOrderByClientOrderId()
getOrderByClientOrderId(params: object): Promise<APISuccessResponse<FuturesOrder>>;Get Order By Client Order Id Get order details by client order id.
Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; } |
params.clientOid | string |
Returns
Promise<APISuccessResponse<FuturesOrder>>
getOrderByOrderId()
getOrderByOrderId(params: object): Promise<APISuccessResponse<FuturesOrder>>;Get Order By OrderId Get order details by order id.
Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<FuturesOrder>>
getOrders()
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
| Parameter | Type |
|---|---|
params? | GetOrdersRequest |
Returns
Promise<APISuccessResponse<FuturesOrders>>
getPartOrderBookLevel2Depth100()
getPartOrderBookLevel2Depth100(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;Get Part OrderBook Query for part orderbook depth data. (aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FullOrderBookDetail>>
getPartOrderBookLevel2Depth20()
getPartOrderBookLevel2Depth20(params: object): Promise<APISuccessResponse<FullOrderBookDetail>>;Get Part OrderBook Query for part orderbook depth data. (aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FullOrderBookDetail>>
getPosition()
getPosition(params: object): Promise<APISuccessResponse<FuturesPosition>>;Get Position Details Get the position details of a specified position.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesPosition>>
Deprecated
Use getPositionV2 instead
getPositionMode()
getPositionMode(): Promise<APISuccessResponse<GetPositionModeResponse>>;Get Position Mode This interface can query the position mode of this account.
Returns
Promise<APISuccessResponse<GetPositionModeResponse>>
getPositions()
getPositions(params?: object): Promise<APISuccessResponse<FuturesPosition[]>>;Get Position List Get the position details of a specified position.
Parameters
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<FuturesPosition[]>>
getPositionV2()
getPositionV2(params: object): Promise<APISuccessResponse<FuturesPosition>>;Get Position Details Get the position details of a specified position.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesPosition>>
getPremiumIndex()
getPremiumIndex(params: GetInterestRatesRequest): Promise<APISuccessResponse<{
dataList: PremiumIndexItem[];
hasMore: boolean;
}>>;Get Premium Index This endpoint returns the premium index of the specified symbol.
Parameters
| Parameter | Type |
|---|---|
params | GetInterestRatesRequest |
Returns
Promise<APISuccessResponse<{ dataList: PremiumIndexItem[]; hasMore: boolean; }>>
getPrivate()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getPrivateWSConnectionToken()
getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;Private V1 WS Connection Token & URL
Returns
Promise<APISuccessResponse<WsConnectionInfo>>
getPrivateWSConnectionTokenV2()
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()
getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;Public V1 WS Connection Token & URL
Returns
Promise<APISuccessResponse<WsConnectionInfo>>
getRecentFills()
getRecentFills(params?: object): Promise<APISuccessResponse<FuturesFill[]>>;Get Recent Trade History Get a list of recent 1000 fills in the last 24 hours.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APISuccessResponse<FuturesFill[]>>
getRecentOrders()
getRecentOrders(params?: object): Promise<APISuccessResponse<FuturesOrder[]>>;Get Recent Closed Orders Get a list of recent 1000 closed orders in the last 24 hours.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APISuccessResponse<FuturesOrder[]>>
getRiskLimitLevel()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesRiskLimit[]>>
getServerTime()
getServerTime(): Promise<APISuccessResponse<number>>;Get Server Time Get the API server time. This is the Unix timestamp.
Returns
Promise<APISuccessResponse<number>>
getServiceStatus()
getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;Get Service Status This endpoint returns the status of the API service.
Returns
Promise<APISuccessResponse<ServiceStatus>>
getStopOrders()
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
| Parameter | Type |
|---|---|
params? | GetStopOrdersRequest |
Returns
Promise<APISuccessResponse<FuturesOrders>>
getSubBalances()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<{ accounts: FuturesSubAccount[]; summary: AccountSummary; }>>
getSymbol()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<FuturesSymbolInfo>>
getSymbols()
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()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<TickerDetail>>
getTickers()
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()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ makerFeeRate: string; symbol: string; takerFeeRate: string; }>>
getTransactions()
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
| Parameter | Type |
|---|---|
params | GetTransactionsRequest |
Returns
Promise<APISuccessResponse<{ dataList: FuturesAccountTransaction[]; hasMore: boolean; }>>
getTransfers()
getTransfers(params?: object): Promise<APISuccessResponse<any>>;Parameters
| Parameter | Type |
|---|---|
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()
hasAccessToken(): boolean;Returns
boolean
Inherited from
BaseRestClient.hasAccessToken
modifyCopyTradeRiskLimitLevel()
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
| Parameter | Type |
|---|---|
params | { level: number; symbol: string; } |
params.level | number |
params.symbol | string |
Returns
Promise<APISuccessResponse<boolean>>
post()
post(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(
endpoint: string,
params?: any,
internalReqContext?: InternalRequestContext
): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
internalReqContext? | InternalRequestContext |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
removeCopyTradeIsolatedMargin()
removeCopyTradeIsolatedMargin(params: object): Promise<APISuccessResponse<string>>;Remove Isolated Margin (Copy Trading) Remove Isolated Margin Manually.
Parameters
| Parameter | Type |
|---|---|
params | { positionSide?: "BOTH" | "LONG" | "SHORT"; symbol: string; withdrawAmount: string; } |
params.positionSide? | "BOTH" | "LONG" | "SHORT" |
params.symbol | string |
params.withdrawAmount | string |
Returns
Promise<APISuccessResponse<string>>
setAccessToken()
setAccessToken(newAccessToken: string): void;Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
submitCopyTradeOrder()
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
| Parameter | Type |
|---|---|
params | CopyTradeOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>
submitCopyTradeOrderTest()
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
| Parameter | Type |
|---|---|
params | CopyTradeOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>
submitCopyTradeSLTPOrder()
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
| Parameter | Type |
|---|---|
params | CopyTradeSLTPOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>
submitMultipleOrders()
submitMultipleOrders(params: Order[]): Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>;Batch Add Orders Place multiple order to the futures trading system
Parameters
| Parameter | Type |
|---|---|
params | Order[] |
Returns
Promise<APISuccessResponse<SubmitMultipleOrdersFuturesResponse[]>>
submitNewOrderTest()
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
| Parameter | Type |
|---|---|
params | Order |
Returns
Promise<{ clientOid?: string; orderId?: string; }>
submitOrder()
submitOrder(params: Order): Promise<APISuccessResponse<{
clientOid?: string;
orderId?: string;
}>>;Add Order Place order to the futures trading system
Parameters
| Parameter | Type |
|---|---|
params | Order |
Returns
Promise<APISuccessResponse<{ clientOid?: string; orderId?: string; }>>
submitSLTPOrder()
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
| Parameter | Type |
|---|---|
params | SLTPOrder |
Returns
Promise<APISuccessResponse<{ clientOid?: string; orderId?: string; }>>
submitTransferIn()
submitTransferIn(params: object): Promise<APISuccessResponse<any>>;Parameters
| Parameter | Type |
|---|---|
params | { amount: number; currency: string; payAccountType: "MAIN" | "TRADE"; } |
params.amount | number |
params.currency | string |
params.payAccountType | "MAIN" | "TRADE" |
Returns
Promise<APISuccessResponse<any>>
Deprecated
- please use universal transfer from SpotClient
submitTransferOut()
submitTransferOut(params: object): Promise<APISuccessResponse<any>>;Parameters
| Parameter | Type |
|---|---|
params | { amount: number; currency: string; recAccountType: "MAIN" | "TRADE"; } |
params.amount | number |
params.currency | string |
params.recAccountType | "MAIN" | "TRADE" |
Returns
Promise<APISuccessResponse<any>>
Deprecated
- please use universal transfer from SpotClient
switchCopyTradeMarginMode()
switchCopyTradeMarginMode(params: CopyTradeSwitchMarginModeRequest): Promise<APISuccessResponse<CopyTradeSwitchMarginModeResponse>>;Switch Margin Mode (Copy Trading) Modify the margin mode of the current symbol.
Parameters
| Parameter | Type |
|---|---|
params | CopyTradeSwitchMarginModeRequest |
Returns
Promise<APISuccessResponse<CopyTradeSwitchMarginModeResponse>>
switchCopyTradePositionMode()
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
| Parameter | Type |
|---|---|
params | CopyTradeSwitchPositionModeRequest |
Returns
Promise<APISuccessResponse<CopyTradeSwitchPositionModeResponse>>
updateAutoDepositStatus()
updateAutoDepositStatus(params: object): Promise<APISuccessResponse<any>>;Parameters
| Parameter | Type |
|---|---|
params | { status: boolean; symbol: string; } |
params.status | boolean |
params.symbol | string |
Returns
Promise<APISuccessResponse<any>>
Deprecated
- please use updateMarginMode() instead
updateCopyTradeAutoDepositStatus()
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
| Parameter | Type |
|---|---|
params | { positionSide?: "BOTH" | "LONG" | "SHORT"; status: boolean; symbol: string; } |
params.positionSide? | "BOTH" | "LONG" | "SHORT" |
params.status | boolean |
params.symbol | string |
Returns
Promise<APISuccessResponse<boolean>>
Deprecated
- It is recommended to use cross margin instead
updateCopyTradeCrossMarginLeverage()
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
| Parameter | Type |
|---|---|
params | CopyTradeChangeCrossMarginLeverageRequest |
Returns
Promise<APISuccessResponse<boolean>>
updateMarginMode()
updateMarginMode(params: object): Promise<APISuccessResponse<{
marginMode: "ISOLATED" | "CROSS";
symbol: string;
}>>;Switch Margin Mode Modify the margin mode of the current symbol.
Parameters
| Parameter | Type |
|---|---|
params | { marginMode: "ISOLATED" | "CROSS"; symbol: string; } |
params.marginMode | "ISOLATED" | "CROSS" |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ marginMode: "ISOLATED" | "CROSS"; symbol: string; }>>
updatePositionMode()
updatePositionMode(params: object): Promise<APISuccessResponse<{
positionMode: "0" | "1";
}>>;Switch Position Mode This endpoint can switch the position mode of the current symbol.
Parameters
| Parameter | Type |
|---|---|
params | { positionMode: "0" | "1"; } |
params.positionMode | "0" | "1" |
Returns
Promise<APISuccessResponse<{ positionMode: "0" | "1"; }>>
updateRiskLimitLevel()
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
| Parameter | Type |
|---|---|
params | { level: number; symbol: string; } |
params.level | number |
params.symbol | string |
Returns
Promise<boolean>
withdrawMargin()
withdrawMargin(params: object): Promise<APISuccessResponse<string>>;Remove Isolated Margin Remove Isolated Margin Manually.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; withdrawAmount: string; } |
params.symbol | string |
params.withdrawAmount | string |
Returns
Promise<APISuccessResponse<string>>