Class: USDMClient

Extends

default

Constructors

Constructor

new USDMClient(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig): USDMClient;

Parameters

Parameter	Type
`restClientOptions?`	`RestClientOptions`
`requestOptions?`	`AxiosRequestConfig`

Returns

USDMClient

Overrides

BaseRestClient.constructor

Properties

apiLimitLastUpdated

apiLimitLastUpdated: number;

Inherited from

BaseRestClient.apiLimitLastUpdated

apiLimitTrackers

apiLimitTrackers: Record<ApiLimitHeader, number>;

Inherited from

BaseRestClient.apiLimitTrackers

Methods

acceptConvertQuote()

acceptConvertQuote(params: object): Promise<{
  createTime: number;
  orderId: string;
  orderStatus: "PROCESS" | "ACCEPT_SUCCESS" | "SUCCESS" | "FAIL";
}>;

Parameters

Parameter	Type
`params`	{ `quoteId`: `string`; }
`params.quoteId`	`string`

Returns

Promise<{ createTime: number; orderId: string; orderStatus: "PROCESS" | "ACCEPT_SUCCESS" | "SUCCESS" | "FAIL"; }>

cancelAlgoOrder()

cancelAlgoOrder(params: FuturesCancelAlgoOrderParams): Promise<FuturesCancelAlgoOrderResponse>;

Parameters

Parameter	Type
`params`	`FuturesCancelAlgoOrderParams`

Returns

Promise<FuturesCancelAlgoOrderResponse>

cancelAllAlgoOpenOrders()

cancelAllAlgoOpenOrders(params: object): Promise<FuturesCancelAllAlgoOpenOrdersResponse>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<FuturesCancelAllAlgoOpenOrdersResponse>

cancelAllOpenOrders()

cancelAllOpenOrders(params: object): Promise<CancelAllOpenOrdersResult>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<CancelAllOpenOrdersResult>

cancelMultipleOrders()

cancelMultipleOrders(params: CancelMultipleOrdersParams): Promise<(
  | GenericCodeMsgError
| CancelFuturesOrderResult)[]>;

Parameters

Parameter	Type
`params`	`CancelMultipleOrdersParams`

Returns

Promise<( | GenericCodeMsgError | CancelFuturesOrderResult)[]>

cancelOrder()

cancelOrder(params: CancelOrderParams): Promise<CancelFuturesOrderResult>;

Parameters

Parameter	Type
`params`	`CancelOrderParams`

Returns

Promise<CancelFuturesOrderResult>

closeFuturesUserDataListenKey()

closeFuturesUserDataListenKey(): Promise<object>;

Returns

Promise<object>

delete()

delete(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.delete

deletePrivate()

deletePrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.deletePrivate

fetchTimeOffset()

fetchTimeOffset(): Promise<number>;

Estimate drift based on client<->server latency

Returns

Promise<number>

Inherited from

BaseRestClient.fetchTimeOffset

generateNewOrderId()

generateNewOrderId(): string;

Returns

string

A randomly generated custom order ID that can be used when sending an order to the API. Typically used with the custom order ID parameter, such as newClientOrderId.

Inherited from

BaseRestClient.generateNewOrderId

get()

get(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.get

get24hrChangeStatistics()

Call Signature

get24hrChangeStatistics(params: object): Promise<ChangeStats24hr>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<ChangeStats24hr>

Call Signature

get24hrChangeStatistics(): Promise<ChangeStats24hr[]>;

Returns

Promise<ChangeStats24hr[]>

getAccountCommissionRate()

getAccountCommissionRate(params: object): Promise<UserCommissionRate>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<UserCommissionRate>

getAccountInformation()

getAccountInformation(): Promise<FuturesAccountInformation>;

Returns

Promise<FuturesAccountInformation>

Deprecated

Use getAccountInformationV3() instead

getAccountInformationV3()

getAccountInformationV3(): Promise<FuturesAccountInformation>;

Returns

Promise<FuturesAccountInformation>

getAccountTrades()

getAccountTrades(params: SymbolFromPaginatedRequestFromId & object): Promise<FuturesPositionTrade[]>;

Parameters

Parameter	Type
`params`	`SymbolFromPaginatedRequestFromId` & `object`

Returns

Promise<FuturesPositionTrade[]>

getADLQuantileEstimation()

getADLQuantileEstimation(params?: object): Promise<any>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<any>

getAggregateTrades()

getAggregateTrades(params: SymbolFromPaginatedRequestFromId): Promise<AggregateFuturesTrade[]>;

Parameters

Parameter	Type
`params`	`SymbolFromPaginatedRequestFromId`

Returns

Promise<AggregateFuturesTrade[]>

getAlgoOrder()

getAlgoOrder(params: FuturesQueryAlgoOrderParams): Promise<FuturesQueryAlgoOrderResponse>;

Parameters

Parameter	Type
`params`	`FuturesQueryAlgoOrderParams`

Returns

Promise<FuturesQueryAlgoOrderResponse>

getAllAlgoOrders()

getAllAlgoOrders(params: FuturesQueryAllAlgoOrdersParams): Promise<FuturesQueryAlgoOrderResponse[]>;

Parameters

Parameter	Type
`params`	`FuturesQueryAllAlgoOrdersParams`

Returns

Promise<FuturesQueryAlgoOrderResponse[]>

getAllConvertPairs()

getAllConvertPairs(params?: object): Promise<FuturesConvertPair[]>;

Convert Endpoints

Parameters

Parameter	Type
`params?`	{ `fromAsset?`: `string`; `toAsset?`: `string`; }
`params.fromAsset?`	`string`
`params.toAsset?`	`string`

Returns

Promise<FuturesConvertPair[]>

getAllOpenOrders()

getAllOpenOrders(params?: object): Promise<OrderResult[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<OrderResult[]>

getAllOrders()

getAllOrders(params?: GetFuturesAllOrdersParams): Promise<OrderResult[]>;

Parameters

Parameter	Type
`params?`	`GetFuturesAllOrdersParams`

Returns

Promise<OrderResult[]>

getApiQuantitativeRulesIndicators()

getApiQuantitativeRulesIndicators(params?: object): Promise<any>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<any>

getBalance()

getBalance(): Promise<FuturesAccountBalance[]>;

Returns

Promise<FuturesAccountBalance[]>

Deprecated

Use getBalanceV3() instead

getBalanceV3()

getBalanceV3(): Promise<FuturesAccountBalance[]>;

ACCOUNT endpoints - Rest API

Returns

Promise<FuturesAccountBalance[]>

getBaseUrlKey()

getBaseUrlKey(): BinanceBaseUrlKey;

Returns

BinanceBaseUrlKey

Inherited from

BaseRestClient.getBaseUrlKey

getBasis()

getBasis(params: BasisParams): Promise<Basis[]>;

Possibly @deprecated, found only in old docs

Parameters

Parameter	Type
`params`	`BasisParams`

Returns

Promise<Basis[]>

getBNBBurnStatus()

getBNBBurnStatus(): Promise<{
  feeBurn: boolean;
}>;

Returns

Promise<{ feeBurn: boolean; }>

getBrokerClientCustomIds()

getBrokerClientCustomIds(
   customerId: string, 
   email: string, 
   page?: number, 
   limit?: number
): Promise<any>;

Parameters

Parameter	Type
`customerId`	`string`
`email`	`string`
`page?`	`number`
`limit?`	`number`

Returns

Promise<any>

Deprecated

getBrokerIfNewFuturesUser()

getBrokerIfNewFuturesUser(brokerId: string, type?: 1 | 2): Promise<{
  brokerId: string;
  ifNewUser: boolean;
  rebateWorking: boolean;
}>;

Parameters

Parameter	Type	Default value
`brokerId`	`string`	`undefined`
`type?`	`1` \| `2`	`1`

Returns

Promise<{ brokerId: string; ifNewUser: boolean; rebateWorking: boolean; }>

Deprecated

getBrokerRebateDataOverview()

getBrokerRebateDataOverview(type?: 1 | 2): Promise<RebateDataOverview>;

Parameters

Parameter	Type	Default value
`type?`	`1` \| `2`	`1`

Returns

Promise<RebateDataOverview>

Deprecated

getBrokerRebateVolume()

getBrokerRebateVolume(
   type?: 1 | 2, 
   startTime?: number, 
   endTime?: number, 
   limit?: number
): Promise<any>;

Parameters

Parameter	Type	Default value
`type?`	`1` \| `2`	`1`
`startTime?`	`number`	`undefined`
`endTime?`	`number`	`undefined`
`limit?`	`number`	`undefined`

Returns

Promise<any>

Deprecated

getBrokerTradeDetail()

getBrokerTradeDetail(
   type?: 1 | 2, 
   startTime?: number, 
   endTime?: number, 
   limit?: number
): Promise<any>;

Parameters

Parameter	Type	Default value
`type?`	`1` \| `2`	`1`
`startTime?`	`number`	`undefined`
`endTime?`	`number`	`undefined`
`limit?`	`number`	`undefined`

Returns

Promise<any>

Deprecated

getBrokerUserCustomId()

getBrokerUserCustomId(brokerId: string): Promise<any>;

Parameters

Parameter	Type
`brokerId`	`string`

Returns

Promise<any>

Deprecated

getBrokerUserTradeVolume()

getBrokerUserTradeVolume(
   type?: 1 | 2, 
   startTime?: number, 
   endTime?: number, 
   limit?: number
): Promise<any>;

Parameters

Parameter	Type	Default value
`type?`	`1` \| `2`	`1`
`startTime?`	`number`	`undefined`
`endTime?`	`number`	`undefined`
`limit?`	`number`	`undefined`

Returns

Promise<any>

Deprecated

getCompositeSymbolIndex()

getCompositeSymbolIndex(params?: object): Promise<any>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<any>

getContinuousContractKlines()

getContinuousContractKlines(params: ContinuousContractKlinesParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`ContinuousContractKlinesParams`

Returns

Promise<Kline[]>

getConvertOrderStatus()

getConvertOrderStatus(params: object): Promise<FuturesConvertOrderStatus>;

Parameters

Parameter	Type
`params`	{ `orderId?`: `string`; `quoteId?`: `string`; }
`params.orderId?`	`string`
`params.quoteId?`	`string`

Returns

Promise<FuturesConvertOrderStatus>

getCurrentOpenOrder()

getCurrentOpenOrder(params: GetOrderParams): Promise<OrderResult>;

Parameters

Parameter	Type
`params`	`GetOrderParams`

Returns

Promise<OrderResult>

getCurrentPositionMode()

getCurrentPositionMode(): Promise<PositionModeResponse>;

Returns

Promise<PositionModeResponse>

getExchangeInfo()

getExchangeInfo(): Promise<FuturesExchangeInfo>;

Returns

Promise<FuturesExchangeInfo>

getForBaseUrl()

getForBaseUrl(
   endpoint: string, 
   baseUrlKey: BinanceBaseUrlKey, 
   params?: any
): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`baseUrlKey`	`BinanceBaseUrlKey`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getForBaseUrl

getForceOrders()

getForceOrders(params?: GetForceOrdersParams): Promise<ForceOrderResult[]>;

Parameters

Parameter	Type
`params?`	`GetForceOrdersParams`

Returns

Promise<ForceOrderResult[]>

getFundingRateHistory()

getFundingRateHistory(params?: Partial<BasicSymbolPaginatedParams>): Promise<FundingRateHistory[]>;

Parameters

Parameter	Type
`params?`	`Partial`<`BasicSymbolPaginatedParams`>

Returns

Promise<FundingRateHistory[]>

getFundingRates()

getFundingRates(): Promise<FundingRate[]>;

Returns

Promise<FundingRate[]>

getFuturesAccountConfig()

getFuturesAccountConfig(): Promise<FuturesAccountConfig>;

Returns

Promise<FuturesAccountConfig>

getFuturesOrderHistoryDownloadId()

getFuturesOrderHistoryDownloadId(params: object): Promise<FuturesTradeHistoryDownloadId>;

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<FuturesTradeHistoryDownloadId>

getFuturesOrderHistoryDownloadLink()

getFuturesOrderHistoryDownloadLink(params: object): Promise<FuturesTransactionDownloadLink>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<FuturesTransactionDownloadLink>

getFuturesSymbolConfig()

getFuturesSymbolConfig(params: object): Promise<SymbolConfig[]>;

Parameters

Parameter	Type
`params`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<SymbolConfig[]>

getFuturesTradeDownloadLink()

getFuturesTradeDownloadLink(params: object): Promise<FuturesTransactionDownloadLink>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<FuturesTransactionDownloadLink>

getFuturesTradeHistoryDownloadId()

getFuturesTradeHistoryDownloadId(params: object): Promise<FuturesTradeHistoryDownloadId>;

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<FuturesTradeHistoryDownloadId>

getFuturesTransactionHistoryDownloadId()

getFuturesTransactionHistoryDownloadId(params: object): Promise<FuturesTradeHistoryDownloadId>;

Get a download id for futures transaction history (GET /fapi/v1/income/asyn). Limited to 100 requests per month, shared across the web download page, REST, USD-M and COIN-M.

Parameters

Parameter	Type
`params`	{ `endTime`: `number`; `startTime`: `number`; }
`params.endTime`	`number`
`params.startTime`	`number`

Returns

Promise<FuturesTradeHistoryDownloadId>

getFuturesTransactionHistoryDownloadLink()

getFuturesTransactionHistoryDownloadLink(params: object): Promise<FuturesTransactionDownloadLink>;

Parameters

Parameter	Type
`params`	{ `downloadId`: `string`; }
`params.downloadId`	`string`

Returns

Promise<FuturesTransactionDownloadLink>

getFuturesUserDataListenKey()

getFuturesUserDataListenKey(): Promise<{
  listenKey: string;
}>;

User Data Stream Endpoints

Returns

Promise<{ listenKey: string; }>

getGlobalLongShortAccountRatio()

getGlobalLongShortAccountRatio(params: FuturesDataPaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params`	`FuturesDataPaginatedParams`

Returns

Promise<any>

getHistoricalBlvtNavKlines()

getHistoricalBlvtNavKlines(params: SymbolKlinePaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params`	`SymbolKlinePaginatedParams`

Returns

Promise<any>

getHistoricalTrades()

getHistoricalTrades(params: HistoricalTradesParams): Promise<RawFuturesTrade[]>;

Parameters

Parameter	Type
`params`	`HistoricalTradesParams`

Returns

Promise<RawFuturesTrade[]>

getIncomeHistory()

getIncomeHistory(params?: GetIncomeHistoryParams): Promise<IncomeHistory[]>;

Query income history (GET /fapi/v1/income). Paginate with startTime and endTime. page is not accepted.

Parameters

Parameter	Type
`params?`	`GetIncomeHistoryParams`

Returns

Promise<IncomeHistory[]>

getIndexPriceConstituents()

getIndexPriceConstituents(params: object): Promise<IndexPriceConstituents>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<IndexPriceConstituents>

getIndexPriceKlines()

getIndexPriceKlines(params: IndexPriceKlinesParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`IndexPriceKlinesParams`

Returns

Promise<Kline[]>

getInsuranceFundBalance()

getInsuranceFundBalance(params?: object): Promise<
  | InsuranceFundBalance
| InsuranceFundBalance[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise< | InsuranceFundBalance | InsuranceFundBalance[]>

getKlines()

getKlines(params: KlinesParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`KlinesParams`

Returns

Promise<Kline[]>

getMarkPrice()

Call Signature

getMarkPrice(params: object): Promise<MarkPrice>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<MarkPrice>

Call Signature

getMarkPrice(): Promise<MarkPrice[]>;

Returns

Promise<MarkPrice[]>

getMarkPriceKlines()

getMarkPriceKlines(params: SymbolKlinePaginatedParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`SymbolKlinePaginatedParams`

Returns

Promise<Kline[]>

getMultiAssetsMode()

getMultiAssetsMode(): Promise<MultiAssetModeResponse>;

Returns

Promise<MultiAssetModeResponse>

getMultiAssetsModeAssetIndex()

getMultiAssetsModeAssetIndex(params?: object): Promise<any>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<any>

getNotionalAndLeverageBrackets()

getNotionalAndLeverageBrackets(params?: object): Promise<SymbolLeverageBracketsResult[]>;

Contrary to what the docs say - if symbol is provided, this returns an array with length 1 (assuming the symbol exists)

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<SymbolLeverageBracketsResult[]>

getOpenAlgoOrders()

getOpenAlgoOrders(params?: FuturesQueryOpenAlgoOrdersParams): Promise<FuturesAlgoOrderResponse[]>;

Parameters

Parameter	Type
`params?`	`FuturesQueryOpenAlgoOrdersParams`

Returns

Promise<FuturesAlgoOrderResponse[]>

getOpenInterest()

getOpenInterest(params: object): Promise<OpenInterest>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<OpenInterest>

getOpenInterestStatistics()

getOpenInterestStatistics(params: FuturesDataPaginatedParams): Promise<HistoricOpenInterest[]>;

Parameters

Parameter	Type
`params`	`FuturesDataPaginatedParams`

Returns

Promise<HistoricOpenInterest[]>

getOrder()

getOrder(params: GetOrderParams): Promise<OrderResult>;

Parameters

Parameter	Type
`params`	`GetOrderParams`

Returns

Promise<OrderResult>

getOrderBook()

getOrderBook(params: OrderBookParams): Promise<FuturesOrderBook>;

Parameters

Parameter	Type
`params`	`OrderBookParams`

Returns

Promise<FuturesOrderBook>

getOrderIdPrefix()

getOrderIdPrefix(): string;

Get the correct prefix for this product group (e.g. spot, margin, futures) to be used when generating a custom order ID (e.g. newClientOrderId).

Returns

string

The prefix that should be used when any custom order ID is included with an order (e.g. newClientOrderId). The prefix will always be 10 characters long.

Inherited from

BaseRestClient.getOrderIdPrefix

getOrderModifyHistory()

getOrderModifyHistory(params: GetFuturesOrderModifyHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetFuturesOrderModifyHistoryParams`

Returns

Promise<any>

getPortfolioMarginProAccountInfo()

getPortfolioMarginProAccountInfo(params: object): Promise<PortfolioMarginProAccountInfo>;

Portfolio Margin Pro Endpoints

Parameters

Parameter	Type
`params`	{ `asset`: `string`; }
`params.asset`	`string`

Returns

Promise<PortfolioMarginProAccountInfo>

getPositionMarginChangeHistory()

getPositionMarginChangeHistory(params: GetPositionMarginChangeHistoryParams): Promise<any>;

Parameters

Parameter	Type
`params`	`GetPositionMarginChangeHistoryParams`

Returns

Promise<any>

getPositions()

getPositions(params?: Partial<BasicSymbolParam>): Promise<FuturesPosition[]>;

Parameters

Parameter	Type
`params?`	`Partial`<`BasicSymbolParam`>

Returns

Promise<FuturesPosition[]>

Deprecated

Use getPositionsV3() instead

getPositionsV3()

getPositionsV3(params?: object): Promise<FuturesPositionV3[]>;

Parameters

Parameter	Type
`params?`	{ `symbol?`: `string`; }
`params.symbol?`	`string`

Returns

Promise<FuturesPositionV3[]>

getPremiumIndexKlines()

getPremiumIndexKlines(params: SymbolKlinePaginatedParams): Promise<Kline[]>;

Parameters

Parameter	Type
`params`	`SymbolKlinePaginatedParams`

Returns

Promise<Kline[]>

getPrivate()

getPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.getPrivate

getQuarterlyContractSettlementPrices()

getQuarterlyContractSettlementPrices(params: object): Promise<QuarterlyContractSettlementPrice[]>;

Parameters

Parameter	Type
`params`	{ `pair`: `string`; }
`params.pair`	`string`

Returns

Promise<QuarterlyContractSettlementPrice[]>

getRateLimitStates()

getRateLimitStates(): object;

Returns

object

lastUpdated

lastUpdated: number;

x-mbx-order-count-10s

"x-mbx-order-count-10s": number;

x-mbx-order-count-1d

"x-mbx-order-count-1d": number;

x-mbx-order-count-1h

"x-mbx-order-count-1h": number;

x-mbx-order-count-1m

"x-mbx-order-count-1m": number;

x-mbx-order-count-1s

"x-mbx-order-count-1s": number;

x-mbx-used-weight

"x-mbx-used-weight": number;

x-mbx-used-weight-1m

"x-mbx-used-weight-1m": number;

x-sapi-used-ip-weight-1m

"x-sapi-used-ip-weight-1m": number;

Inherited from

BaseRestClient.getRateLimitStates

getRecentTrades()

getRecentTrades(params: RecentTradesParams): Promise<RawFuturesTrade[]>;

Parameters

Parameter	Type
`params`	`RecentTradesParams`

Returns

Promise<RawFuturesTrade[]>

getRpiOrderBook()

getRpiOrderBook(params: object): Promise<RpiOrderBook>;

Parameters

Parameter	Type
`params`	{ `limit?`: `number`; `symbol`: `string`; }
`params.limit?`	`number`
`params.symbol`	`string`

Returns

Promise<RpiOrderBook>

getServerTime()

getServerTime(): Promise<number>;

Abstraction required by each client to aid with time sync / drift handling

Returns

Promise<number>

Overrides

BaseRestClient.getServerTime

getSymbolAdlRisk()

Call Signature

getSymbolAdlRisk(params: object): Promise<SymbolAdlRisk>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<SymbolAdlRisk>

Call Signature

getSymbolAdlRisk(): Promise<SymbolAdlRisk[]>;

Returns

Promise<SymbolAdlRisk[]>

getSymbolOrderBookTicker()

Call Signature

getSymbolOrderBookTicker(params: object): Promise<FuturesSymbolOrderBookTicker>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<FuturesSymbolOrderBookTicker>

Call Signature

getSymbolOrderBookTicker(): Promise<FuturesSymbolOrderBookTicker[]>;

Returns

Promise<FuturesSymbolOrderBookTicker[]>

getSymbolPriceTicker()

Call Signature

getSymbolPriceTicker(params: object): Promise<SymbolPrice>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<SymbolPrice>

Call Signature

getSymbolPriceTicker(): Promise<SymbolPrice[]>;

Returns

Promise<SymbolPrice[]>

getSymbolPriceTickerV2()

Call Signature

getSymbolPriceTickerV2(params: object): Promise<SymbolPrice>;

Parameters

Parameter	Type
`params`	{ `symbol`: `string`; }
`params.symbol`	`string`

Returns

Promise<SymbolPrice>

Call Signature

getSymbolPriceTickerV2(): Promise<SymbolPrice[]>;

Returns

Promise<SymbolPrice[]>

getTakerBuySellVolume()

getTakerBuySellVolume(params: FuturesDataPaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params`	`FuturesDataPaginatedParams`

Returns

Promise<any>

getTimeOffset()

getTimeOffset(): number;

Return time sync offset, automatically set if time sync is enabled. A higher offset means system clock is behind server time.

Returns

number

Inherited from

BaseRestClient.getTimeOffset

getTopTradersLongShortAccountRatio()

getTopTradersLongShortAccountRatio(params: FuturesDataPaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params`	`FuturesDataPaginatedParams`

Returns

Promise<any>

getTopTradersLongShortPositionRatio()

getTopTradersLongShortPositionRatio(params: FuturesDataPaginatedParams): Promise<any>;

Parameters

Parameter	Type
`params`	`FuturesDataPaginatedParams`

Returns

Promise<any>

getTradingSchedule()

getTradingSchedule(): Promise<TradingSchedule>;

Returns

Promise<TradingSchedule>

getUserForceOrders()

getUserForceOrders(): Promise<UserForceOrder[]>;

Returns

Promise<UserForceOrder[]>

keepAliveFuturesUserDataListenKey()

keepAliveFuturesUserDataListenKey(): Promise<object>;

Returns

Promise<object>

modifyMultipleOrders()

modifyMultipleOrders(orders: ModifyOrderParams[]): Promise<any>;

Parameters

Parameter	Type
`orders`	`ModifyOrderParams`[]

Returns

Promise<any>

modifyOrder()

modifyOrder(params: ModifyFuturesOrderParams): Promise<ModifyFuturesOrderResult>;

Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue

Parameters

Parameter	Type
`params`	`ModifyFuturesOrderParams`

Returns

Promise<ModifyFuturesOrderResult>

post()

post(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.post

postPrivate()

postPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.postPrivate

put()

put(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.put

putPrivate()

putPrivate(endpoint: string, params?: any): GenericAPIResponse;

Parameters

Parameter	Type
`endpoint`	`string`
`params?`	`any`

Returns

GenericAPIResponse

Inherited from

BaseRestClient.putPrivate

setBNBBurnEnabled()

setBNBBurnEnabled(params: object): Promise<{
  code: number;
  msg: string;
}>;

Parameters

Parameter	Type
`params`	{ `feeBurn`: `"true"` \| `"false"`; }
`params.feeBurn`	`"true"` \| `"false"`

Returns

Promise<{ code: number; msg: string; }>

setBrokerCustomIdForClient()

setBrokerCustomIdForClient(customerId: string, email: string): Promise<{
  customerId: string;
  email: string;
}>;

Parameters

Parameter	Type
`customerId`	`string`
`email`	`string`

Returns

Promise<{ customerId: string; email: string; }>

Deprecated

setCancelOrdersOnTimeout()

setCancelOrdersOnTimeout(params: CancelOrdersTimeoutParams): Promise<SetCancelTimeoutResult>;

Parameters

Parameter	Type
`params`	`CancelOrdersTimeoutParams`

Returns

Promise<SetCancelTimeoutResult>

setIsolatedPositionMargin()

setIsolatedPositionMargin(params: SetIsolatedMarginParams): Promise<SetIsolatedMarginResult>;

Parameters

Parameter	Type
`params`	`SetIsolatedMarginParams`

Returns

Promise<SetIsolatedMarginResult>

setLeverage()

setLeverage(params: SetLeverageParams): Promise<SetLeverageResult>;

Change initial leverage (POST /fapi/v1/leverage). leverage is an unbounded number here. The maximum is symbol-specific: bracket 1 initialLeverage from GET /fapi/v1/leverageBracket (Binance derivatives changelog 2026-10-09).

Parameters

Parameter	Type
`params`	`SetLeverageParams`

Returns

Promise<SetLeverageResult>

setMarginType()

setMarginType(params: SetMarginTypeParams): Promise<ModeChangeResult>;

Parameters

Parameter	Type
`params`	`SetMarginTypeParams`

Returns

Promise<ModeChangeResult>

setMultiAssetsMode()

setMultiAssetsMode(params: object): Promise<ModeChangeResult>;

Parameters

Parameter	Type
`params`	{ `multiAssetsMargin`: `"true"` \| `"false"`; }
`params.multiAssetsMargin`	`"true"` \| `"false"`

Returns

Promise<ModeChangeResult>

setPositionMode()

setPositionMode(params: PositionModeParams): Promise<ModeChangeResult>;

Parameters

Parameter	Type
`params`	`PositionModeParams`

Returns

Promise<ModeChangeResult>

setTimeOffset()

setTimeOffset(value: number): void;

Parameters

Parameter	Type
`value`	`number`

Returns

void

Inherited from

BaseRestClient.setTimeOffset

signTradFiPerpsAgreement()

signTradFiPerpsAgreement(): Promise<{
  code: number;
  msg: string;
}>;

Returns

Promise<{ code: number; msg: string; }>

submitConvertQuoteRequest()

submitConvertQuoteRequest(params: FuturesConvertQuoteRequest): Promise<FuturesConvertQuote>;

Parameters

Parameter	Type
`params`	`FuturesConvertQuoteRequest`

Returns

Promise<FuturesConvertQuote>

submitMultipleOrders()

submitMultipleOrders<TNumberType = numberInString>(orders: NewFuturesOrderParams<TNumberType>[]): Promise<(
  | NewOrderResult
| NewOrderError)[]>;

Warning: max 5 orders at a time! This method does not throw, instead it returns individual errors in the response array if any orders were rejected.

Note: this method will automatically ensure "price" and "quantity" are sent as a string, if present in the request. See #523 & #526 for more details.

Type Parameters

Type Parameter	Default type
`TNumberType`	`numberInString`

Parameters

Parameter	Type
`orders`	`NewFuturesOrderParams`<`TNumberType`>[]

Returns

Promise<( | NewOrderResult | NewOrderError)[]>

submitNewAlgoOrder()

submitNewAlgoOrder(params: FuturesNewAlgoOrderParams): Promise<FuturesAlgoOrderResponse>;

Algo Order Endpoints (Effective 2025-12-02) Conditional orders migrate to Algo Service

Parameters

Parameter	Type
`params`	`FuturesNewAlgoOrderParams`

Returns

Promise<FuturesAlgoOrderResponse>

submitNewOrder()

submitNewOrder(params: NewFuturesOrderParams): Promise<NewOrderResult>;

TRADE endpoints - Rest API

Parameters

Parameter	Type
`params`	`NewFuturesOrderParams`

Returns

Promise<NewOrderResult>

syncTime()

syncTime(): Promise<void>;

Trigger time sync and store promise

Returns

Promise<void>

Inherited from

BaseRestClient.syncTime

testConnectivity()

testConnectivity(): Promise<object>;

MARKET DATA endpoints - Rest API

Returns

Promise<object>

testOrder()

testOrder(params: NewFuturesOrderParams): Promise<any>;

Parameters

Parameter	Type
`params`	`NewFuturesOrderParams`

Returns

Promise<any>

Class: USDMClient ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

apiLimitLastUpdated ​

Inherited from ​

apiLimitTrackers ​

Inherited from ​

Methods ​

acceptConvertQuote() ​

Parameters ​

Returns ​

cancelAlgoOrder() ​

Parameters ​

Returns ​

cancelAllAlgoOpenOrders() ​

Parameters ​

Returns ​

cancelAllOpenOrders() ​

Parameters ​

Returns ​

cancelMultipleOrders() ​

Parameters ​

Returns ​

cancelOrder() ​

Parameters ​

Returns ​

closeFuturesUserDataListenKey() ​

Returns ​

delete() ​

Parameters ​

Returns ​

Inherited from ​

deletePrivate() ​

Parameters ​

Returns ​

Inherited from ​

fetchTimeOffset() ​

Returns ​

Inherited from ​

generateNewOrderId() ​

Returns ​

Inherited from ​

get() ​

Parameters ​

Returns ​

Inherited from ​

get24hrChangeStatistics() ​

Call Signature ​

Parameters ​

Returns ​

Call Signature ​

Returns ​

getAccountCommissionRate() ​

Parameters ​

Returns ​

getAccountInformation() ​

Returns ​

Deprecated ​

getAccountInformationV3() ​

Returns ​

getAccountTrades() ​

Parameters ​

Returns ​

getADLQuantileEstimation() ​

Parameters ​

Returns ​

getAggregateTrades() ​

Parameters ​

Returns ​

getAlgoOrder() ​

Parameters ​

Returns ​

getAllAlgoOrders() ​

Parameters ​

Returns ​

Class: USDMClient

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

apiLimitLastUpdated

Inherited from

apiLimitTrackers

Inherited from

Methods

acceptConvertQuote()

Parameters

Returns

cancelAlgoOrder()

Parameters

Returns

cancelAllAlgoOpenOrders()

Parameters

Returns

cancelAllOpenOrders()

Parameters

Returns

cancelMultipleOrders()

Parameters

Returns

cancelOrder()

Parameters

Returns

closeFuturesUserDataListenKey()

Returns

delete()

Parameters

Returns

Inherited from

deletePrivate()

Parameters

Returns

Inherited from

fetchTimeOffset()

Returns

Inherited from

generateNewOrderId()

Returns

Inherited from

get()

Parameters

Returns

Inherited from

get24hrChangeStatistics()

Call Signature

Parameters

Returns

Call Signature

Returns

getAccountCommissionRate()

Parameters

Returns

getAccountInformation()

Returns

Deprecated

getAccountInformationV3()

Returns

getAccountTrades()

Parameters

Returns

getADLQuantileEstimation()

Parameters

Returns

getAggregateTrades()

Parameters

Returns

getAlgoOrder()

Parameters

Returns

getAllAlgoOrders()

Parameters

Returns