Class: CoinMClient

Extends

• default

Constructors

Constructor

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

Parameters

Parameter	Type
restClientOptions?	RestClientOptions
requestOptions?	AxiosRequestConfig

Returns

CoinMClient

Overrides

BaseRestClient.constructor

Properties

apiLimitLastUpdated

apiLimitLastUpdated: number;

Inherited from

BaseRestClient.apiLimitLastUpdated

---

apiLimitTrackers

apiLimitTrackers: Record<ApiLimitHeader, number>;

Inherited from

BaseRestClient.apiLimitTrackers

Methods

cancelAlgoOrder()

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

Parameters

Parameter	Type
params	FuturesCancelAlgoOrderParams

Returns

Promise<FuturesCancelAlgoOrderResponse>

---

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()

get24hrChangeStatistics(params?: object): Promise<
  | ChangeStats24hr
| ChangeStats24hr[]>;

Parameters

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

Returns

Promise< | ChangeStats24hr | ChangeStats24hr[]>

---

getAccountCommissionRate()

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

Parameters

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

Returns

Promise<UserCommissionRate>

---

getAccountInformation()

getAccountInformation(): Promise<FuturesCoinMAccountInformation>;

Returns

Promise<FuturesCoinMAccountInformation>

---

getAccountTrades()

getAccountTrades(params: CoinMAccountTradeParams & object): Promise<CoinMPositionTrade[]>;

Parameters

Parameter	Type
params	CoinMAccountTradeParams & object

Returns

Promise<CoinMPositionTrade[]>

---

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[]>

---

getAllOpenOrders()

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

Parameters

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

Returns

Promise<OrderResult[]>

---

getAllOrders()

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

Parameters

Parameter	Type
params	GetAllOrdersParams

Returns

Promise<OrderResult[]>

---

getBalance()

getBalance(): Promise<FuturesCoinMAccountBalance[]>;

Account Endpoints

Returns

Promise<FuturesCoinMAccountBalance[]>

---

getBaseUrlKey()

getBaseUrlKey(): BinanceBaseUrlKey;

Returns

BinanceBaseUrlKey

Inherited from

BaseRestClient.getBaseUrlKey

---

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

---

getClassicPortfolioMarginAccount()

getClassicPortfolioMarginAccount(params: object): Promise<ClassicPortfolioMarginAccount>;

Portfolio Margin Endpoints

Parameters

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

Returns

Promise<ClassicPortfolioMarginAccount>

---

getClassicPortfolioMarginNotionalLimits()

getClassicPortfolioMarginNotionalLimits(params?: GetClassicPortfolioMarginNotionalLimitParams): Promise<{
  notionalLimits: ClassicPortfolioMarginNotionalLimit[];
}>;

Parameters

Parameter	Type
params?	GetClassicPortfolioMarginNotionalLimitParams

Returns

Promise<{ notionalLimits: ClassicPortfolioMarginNotionalLimit[]; }>

Deprecated

at 6th August, 2024

---

getCompositeSymbolIndex()

getCompositeSymbolIndex(params: FuturesCoinMBasisParams): Promise<any>;

Parameters

Parameter	Type
params	FuturesCoinMBasisParams

Returns

Promise<any>

---

getContinuousContractKlines()

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

Parameters

Parameter	Type
params	ContinuousContractKlinesParams

Returns

Promise<Kline[]>

---

getCurrentOpenOrder()

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

Parameters

Parameter	Type
params	GetOrderParams

Returns

Promise<OrderResult>

---

getCurrentPositionMode()

getCurrentPositionMode(): Promise<PositionModeResponse>;

Returns

Promise<PositionModeResponse>

---

getDownloadIdForFuturesOrderHistory()

getDownloadIdForFuturesOrderHistory(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Parameters

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

Returns

Promise<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

---

getDownloadIdForFuturesTradeHistory()

getDownloadIdForFuturesTradeHistory(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Parameters

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

Returns

Promise<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

---

getDownloadIdForFuturesTransactionHistory()

getDownloadIdForFuturesTransactionHistory(params: object): Promise<{
  avgCostTimestampOfLast30d: number;
  downloadId: string;
}>;

Get a download id for futures transaction history (GET /dapi/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<{ avgCostTimestampOfLast30d: number; downloadId: string; }>

---

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[]>

---

getFundingRate()

getFundingRate(params?: object): Promise<FundingRate[]>;

Parameters

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

Returns

Promise<FundingRate[]>

---

getFundingRateHistory()

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

Parameters

Parameter	Type
params?	Partial<BasicSymbolPaginatedParams>

Returns

Promise<FundingRateHistory[]>

---

getFuturesOrderHistoryDownloadLink()

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

Parameters

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

Returns

Promise<FuturesTransactionHistoryDownloadLink>

---

getFuturesTradeHistoryDownloadLink()

getFuturesTradeHistoryDownloadLink(params: object): Promise<FuturesTransactionHistoryDownloadLink>;

Parameters

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

Returns

Promise<FuturesTransactionHistoryDownloadLink>

---

getFuturesTransactionHistoryDownloadLink()

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

Parameters

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

Returns

Promise<FuturesTransactionHistoryDownloadLink>

---

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>

---

getHistoricalTrades()

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

Parameters

Parameter	Type
params	HistoricalTradesParams

Returns

Promise<RawFuturesTrade[]>

---

getIncomeHistory()

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

Query income history (GET /dapi/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>;

possibly

Parameters

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

Returns

Promise<IndexPriceConstituents>

Deprecated

Only in old documentation, not in new one

---

getIndexPriceKlines()

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

Parameters

Parameter	Type
params	IndexPriceKlinesParams

Returns

Promise<Kline[]>

---

getKlines()

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

Parameters

Parameter	Type
params	KlinesParams

Returns

Promise<Kline[]>

---

getMarkPrice()

getMarkPrice(params?: object): Promise<
  | MarkPrice
| MarkPrice[]>;

Index Price and Mark Price

Parameters

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

Returns

Promise< | MarkPrice | MarkPrice[]>

---

getMarkPriceKlines()

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

Parameters

Parameter	Type
params	SymbolKlinePaginatedParams

Returns

Promise<Kline[]>

---

getNotionalAndLeverageBrackets()

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

Notional Bracket for Symbol (NOT "pair")

Parameters

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

Returns

Promise< | SymbolLeverageBracketsResult | SymbolLeverageBracketsResult[]>

---

getOpenAlgoOrders()

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

Parameters

Parameter	Type
params?	FuturesQueryOpenAlgoOrdersParams

Returns

Promise<FuturesAlgoOrderResponse[]>

---

getOpenInterest()

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

Parameters

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

Returns

Promise<CoinMOpenInterest>

---

getOpenInterestStatistics()

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

Parameters

Parameter	Type
params	FuturesDataPaginatedParams

Returns

Promise<any>

---

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: GetOrderModifyHistoryParams): Promise<OrderAmendment[]>;

Parameters

Parameter	Type
params	GetOrderModifyHistoryParams

Returns

Promise<OrderAmendment[]>

---

getPositionMarginChangeHistory()

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

Parameters

Parameter	Type
params	GetPositionMarginChangeHistoryParams

Returns

Promise<any>

---

getPositions()

getPositions(params?: object): Promise<PositionRisk[]>;

Parameters

Parameter	Type
params?	{ marginAsset?: string; pair?: string; }
params.marginAsset?	string
params.pair?	string

Returns

Promise<PositionRisk[]>

---

getPremiumIndexKlines()

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

Parameters

Parameter	Type
params	KlinesParams

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[]>;

possibly

Parameters

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

Returns

Promise<QuarterlyContractSettlementPrice[]>

Deprecated

Only in old documentation, not in new one

---

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[]>

---

getServerTime()

getServerTime(): Promise<number>;

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

Returns

Promise<number>

Overrides

BaseRestClient.getServerTime

---

getSymbolOrderBookTicker()

getSymbolOrderBookTicker(params?: object): Promise<CoinMSymbolOrderBookTicker[]>;

Parameters

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

Returns

Promise<CoinMSymbolOrderBookTicker[]>

---

getSymbolPriceTicker()

getSymbolPriceTicker(params?: object): Promise<
  | SymbolPrice
| SymbolPrice[]>;

Parameters

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

Returns

Promise< | SymbolPrice | SymbolPrice[]>

---

getTakerBuySellVolume()

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

Parameters

Parameter	Type
params	FuturesCoinMTakerBuySellVolumeParams

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: FuturesCoinMLongShortAccountRatioParams): Promise<any>;

Parameters

Parameter	Type
params	FuturesCoinMLongShortAccountRatioParams

Returns

Promise<any>

---

getTopTradersLongShortPositionRatio()

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

Parameters

Parameter	Type
params	FuturesDataPaginatedParams & object

Returns

Promise<any>

---

keepAliveFuturesUserDataListenKey()

keepAliveFuturesUserDataListenKey(): Promise<object>;

Returns

Promise<object>

---

modifyMultipleOrders()

modifyMultipleOrders(orders: ModifyFuturesOrderParams<number>[]): Promise<(
  | NewOrderError
| ModifyFuturesOrderResult)[]>;

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.

Parameters

Parameter	Type
orders	ModifyFuturesOrderParams<number>[]

Returns

Promise<( | NewOrderError | ModifyFuturesOrderResult)[]>

---

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

---

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>;

Parameters

Parameter	Type
params	SetLeverageParams

Returns

Promise<SetLeverageResult>

---

setMarginType()

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

Parameters

Parameter	Type
params	SetMarginTypeParams

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

---

submitMultipleOrders()

submitMultipleOrders(orders: NewFuturesOrderParams<string>[]): 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.

Known issue: quantity and price should be sent as strings

Parameters

Parameter	Type
orders	NewFuturesOrderParams<string>[]

Returns

Promise<( | NewOrderResult | NewOrderError)[]>

---

submitNewAlgoOrder()

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

Algo Order Endpoints (Effective 2026-06-30, CM-UM integration) Conditional orders migrate to Algo Service on COIN-M

Parameters

Parameter	Type
params	FuturesNewAlgoOrderParams

Returns

Promise<FuturesAlgoOrderResponse>

---

submitNewOrder()

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

Trade Endpoints

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

Returns

Promise<object>