Class: WebsocketAPIClient

This is a minimal Websocket API wrapper around the WebsocketClient.

Some methods support passing in a custom "wsKey". This is a reference to which WS connection should be used to transmit that message. This is only useful if you wish to use an alternative wss domain that is supported by the SDK.

Note: To use testnet, don't set the wsKey - use testnet: true in the constructor instead.

Note: You can also directly use the sendWSAPIRequest() method to make WS API calls, but some may find the below methods slightly more intuitive.

Refer to the WS API promises example for a more detailed example on using sendWSAPIRequest() directly: https://github.com/tiagosiebler/binance/blob/master/examples/WebSockets/ws-api-raw-promises.ts#L108

Constructors

Constructor

new WebsocketAPIClient(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: object): WebsocketAPIClient;

Parameters

Parameter	Type	Description
options?	WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>	-
logger?	{ error: (...params: any) => void; info: (...params: any) => void; trace: (..._params: any) => void; }	-
logger.error?	(...params: any) => void	-
logger.info?	(...params: any) => void	-
logger.trace?	(..._params: any) => void	Ping/pong events and other raw messages that might be noisy. Enable this while troubleshooting.

Returns

WebsocketAPIClient

Methods

amendSpotOrderKeepPriority()

amendSpotOrderKeepPriority(params: WSAPIOrderAmendKeepPriorityRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<SpotAmendKeepPriorityResult>>;

Reduce the quantity of an existing open order.

Read for more info: https://developers.binance.com/docs/binance-spot-api-docs/faqs/order_amend_keep_priority

Parameters

Parameter	Type
params	WSAPIOrderAmendKeepPriorityRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<SpotAmendKeepPriorityResult>>

---

cancelAllSpotOpenOrders()

cancelAllSpotOpenOrders(params: WSAPIOpenOrdersCancelAllRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<(
  | WSAPIOrderCancel
| WSAPIOrderListCancelResponse)[]>>;

Cancel all open orders on a symbol Note: This includes orders that are part of an order list

Parameters

Parameter	Type
params	WSAPIOpenOrdersCancelAllRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<( | WSAPIOrderCancel | WSAPIOrderListCancelResponse)[]>>

---

cancelFuturesAlgoOrder()

cancelFuturesAlgoOrder(params: WSAPIFuturesAlgoOrderCancelRequest): Promise<WSAPIResponse<WSAPIFuturesAlgoOrderCancelResponse>>;

Cancel an active algo order.

Ref: https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Cancel-Algo-Order

Parameters

Parameter	Type	Description
params	WSAPIFuturesAlgoOrderCancelRequest	-

Returns

Promise<WSAPIResponse<WSAPIFuturesAlgoOrderCancelResponse>>

---

cancelFuturesOrder()

cancelFuturesOrder(market: "usdm" | "coinm", params: WSAPIFuturesOrderCancelRequest): Promise<WSAPIResponse<WSAPIFuturesOrder>>;

Cancel a futures order

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIFuturesOrderCancelRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesOrder>>

---

cancelReplaceSpotOrder()

cancelReplaceSpotOrder(params: WSAPIOrderCancelReplaceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderCancelReplaceResponse>>;

Cancel an existing order and immediately place a new order Note: If both cancelOrderId and cancelOrigClientOrderId parameters are specified, only cancelOrderId is used

Parameters

Parameter	Type
params	WSAPIOrderCancelReplaceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderCancelReplaceResponse>>

---

cancelSpotOrder()

cancelSpotOrder(params: WSAPIOrderCancelRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderCancel>>;

Cancel an active order Note: If both orderId and origClientOrderId parameters are specified, only orderId is used

Parameters

Parameter	Type
params	WSAPIOrderCancelRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderCancel>>

---

cancelSpotOrderList()

cancelSpotOrderList(params: WSAPIOrderListCancelRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListCancelResponse>>;

Cancel an active order list Note: If both orderListId and listClientOrderId parameters are specified, only orderListId is used

Parameters

Parameter	Type
params	WSAPIOrderListCancelRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListCancelResponse>>

---

clearUserDataStreamTimers()

clearUserDataStreamTimers(wsKey: WSAPIWsKey): void;

Consolidated method to clear any timers related to user data stream subscriptions for a given wsKey, if found.

Parameters

Parameter	Type	Description
wsKey	WSAPIWsKey	-

Returns

void

---

disconnectAll()

disconnectAll(): Promise<void>;

Returns

Promise<void>

---

getFuturesAccountBalance()

getFuturesAccountBalance(market: "usdm" | "coinm", params: WSAPIRecvWindowTimestamp): Promise<WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>>;

Get account balance information Note: Returns balance information for all assets

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIRecvWindowTimestamp

Returns

Promise<WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>>

---

getFuturesAccountBalanceV2()

getFuturesAccountBalanceV2(params: WSAPIRecvWindowTimestamp): Promise<WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>>;

Get account balance information (V2) Note: Returns balance information for all assets

Parameters

Parameter	Type
params	WSAPIRecvWindowTimestamp

Returns

Promise<WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>>

---

getFuturesAccountStatus()

getFuturesAccountStatus(market: "usdm" | "coinm", params: WSAPIRecvWindowTimestamp): Promise<WSAPIResponse<WSAPIFuturesAccountStatus>>;

Get account information Note: Returns detailed account information including positions and assets

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIRecvWindowTimestamp

Returns

Promise<WSAPIResponse<WSAPIFuturesAccountStatus>>

---

getFuturesAccountStatusV2()

getFuturesAccountStatusV2(params: WSAPIRecvWindowTimestamp): Promise<WSAPIResponse<WSAPIFuturesAccountStatus>>;

Get account information (V2) Note: Returns detailed account information including positions and assets

Parameters

Parameter	Type
params	WSAPIRecvWindowTimestamp

Returns

Promise<WSAPIResponse<WSAPIFuturesAccountStatus>>

---

getFuturesOrderBook()

getFuturesOrderBook(params: WSAPIFuturesOrderBookRequest): Promise<WSAPIResponse<WSAPIFuturesOrderBook>>;

Get current order book for futures Note: If you need to continuously monitor order book updates, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPIFuturesOrderBookRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesOrderBook>>

---

getFuturesOrderStatus()

getFuturesOrderStatus(market: "usdm" | "coinm", params: WSAPIFuturesOrderStatusRequest): Promise<WSAPIResponse<WSAPIFuturesOrder>>;

Query futures order status

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIFuturesOrderStatusRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesOrder>>

---

getFuturesPosition()

getFuturesPosition(market: "usdm" | "coinm", params: WSAPIFuturesPositionRequest): Promise<WSAPIResponse<WSAPIFuturesPosition[]>>;

Get current position information Note: Only symbols that have positions or open orders will be returned

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIFuturesPositionRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesPosition[]>>

---

getFuturesPositionV2()

getFuturesPositionV2(params: WSAPIFuturesPositionV2Request): Promise<WSAPIResponse<WSAPIFuturesPositionV2[]>>;

Get current position information (V2) Note: Only symbols that have positions or open orders will be returned

Parameters

Parameter	Type
params	WSAPIFuturesPositionV2Request

Returns

Promise<WSAPIResponse<WSAPIFuturesPositionV2[]>>

---

getFuturesSymbolOrderBookTicker()

getFuturesSymbolOrderBookTicker(params?: WSAPIFuturesTickerBookRequest): Promise<WSAPIResponse<
  | WSAPIFuturesBookTicker
| WSAPIFuturesBookTicker[]>>;

Get best price/qty on the order book for a futures symbol or symbols Note: If symbol is not provided, bookTickers for all symbols will be returned

Parameters

Parameter	Type
params?	WSAPIFuturesTickerBookRequest

Returns

Promise<WSAPIResponse< | WSAPIFuturesBookTicker | WSAPIFuturesBookTicker[]>>

---

getFuturesSymbolPriceTicker()

getFuturesSymbolPriceTicker(params?: WSAPIFuturesTickerPriceRequest): Promise<WSAPIResponse<
  | WSAPIFuturesPriceTicker
| WSAPIFuturesPriceTicker[]>>;

Get latest price for a futures symbol or symbols Note: If symbol is not provided, prices for all symbols will be returned

Parameters

Parameter	Type
params?	WSAPIFuturesTickerPriceRequest

Returns

Promise<WSAPIResponse< | WSAPIFuturesPriceTicker | WSAPIFuturesPriceTicker[]>>

---

getSpot24hrTicker()

getSpot24hrTicker(params?: WSAPITicker24hrRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIFullTicker
  | WSAPIMiniTicker
  | WSAPIFullTicker[]
| WSAPIMiniTicker[]>>;

Get 24-hour rolling window price change statistics Note: If you need to continuously monitor trading statistics, consider using WebSocket Streams

Parameters

Parameter	Type
params?	WSAPITicker24hrRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>>

---

getSpotAccountCommission()

getSpotAccountCommission(params: WSAPIAccountCommissionWSAPIRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIAccountCommission>>;

Get current account commission rates Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIAccountCommissionWSAPIRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIAccountCommission>>

---

getSpotAccountInformation()

getSpotAccountInformation(params: WSAPIAccountInformationRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIAccountInformation>>;

Query information about your account, including balances Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIAccountInformationRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIAccountInformation>>

---

getSpotAggregateTrades()

getSpotAggregateTrades(params: WSAPITradesAggregateRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIAggregateTrade[]>>;

Get aggregate trades Note: An aggregate trade represents one or more individual trades that fill at the same time

Parameters

Parameter	Type
params	WSAPITradesAggregateRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIAggregateTrade[]>>

---

getSpotAllocations()

getSpotAllocations(params: WSAPIMyAllocationsRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIAllocation[]>>;

Retrieves allocations resulting from SOR order placement Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIMyAllocationsRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIAllocation[]>>

---

getSpotAllOrderLists()

getSpotAllOrderLists(params: WSAPIAllOrderListsRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListStatusResponse[]>>;

Query information about all your order lists, filtered by time range Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIAllOrderListsRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListStatusResponse[]>>

---

getSpotAllOrders()

getSpotAllOrders(params: WSAPIAllOrdersRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrder[]>>;

Query information about all your orders – active, canceled, filled – filtered by time range Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIAllOrdersRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrder[]>>

---

getSpotAveragePrice()

getSpotAveragePrice(params: WSAPIAvgPriceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIAvgPrice>>;

Get current average price for a symbol

Parameters

Parameter	Type
params	WSAPIAvgPriceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIAvgPrice>>

---

getSpotExchangeInfo()

getSpotExchangeInfo(params?: WSAPIExchangeInfoRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<ExchangeInfo>>;

Query current exchange trading rules, rate limits, and symbol information

Parameters

Parameter	Type
params?	WSAPIExchangeInfoRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<ExchangeInfo>>

---

getSpotExecutionRules()

getSpotExecutionRules(params?: WSAPIExecutionRulesRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<SpotExecutionRulesResponse>>;

Query execution rules (e.g. PRICE_RANGE) for symbol(s) or by symbol status.

Parameters

Parameter	Type
params?	WSAPIExecutionRulesRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<SpotExecutionRulesResponse>>

---

getSpotHistoricalBlockTrades()

getSpotHistoricalBlockTrades(params: WSAPIBlockTradesHistoricalRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIBlockTrade[]>>;

Get historical block trades

Parameters

Parameter	Type
params	WSAPIBlockTradesHistoricalRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIBlockTrade[]>>

---

getSpotHistoricalTrades()

getSpotHistoricalTrades(params: WSAPITradesHistoricalRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPITrade[]>>;

Get historical trades Note: If fromId is not specified, the most recent trades are returned

Parameters

Parameter	Type
params	WSAPITradesHistoricalRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPITrade[]>>

---

getSpotKlines()

getSpotKlines(params: WSAPIKlinesRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIKline[]>>;

Get klines (candlestick bars) Note: If you need access to real-time kline updates, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPIKlinesRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIKline[]>>

---

getSpotMyTrades()

getSpotMyTrades(params: WSAPIMyTradesRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPITrade[]>>;

Query information about all your trades, filtered by time range Note: Weight: 20

Parameters

Parameter	Type
params	WSAPIMyTradesRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPITrade[]>>

---

getSpotOpenOrderLists()

getSpotOpenOrderLists(params: WSAPIRecvWindowTimestamp, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListStatusResponse[]>>;

Query execution status of all open order lists Note: If you need to continuously monitor order status updates, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPIRecvWindowTimestamp
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListStatusResponse[]>>

---

getSpotOpenOrders()

getSpotOpenOrders(params: WSAPIOpenOrdersStatusRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrder[]>>;

Query execution status of all open orders Note: If you need to continuously monitor order status updates, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPIOpenOrdersStatusRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrder[]>>

---

getSpotOrderBook()

getSpotOrderBook(params: WSAPIOrderBookRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderBook>>;

Get current order book Note: If you need to continuously monitor order book updates, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPIOrderBookRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderBook>>

---

getSpotOrderListStatus()

getSpotOrderListStatus(params: WSAPIOrderListStatusRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListStatusResponse>>;

Check execution status of an order list Note: If both origClientOrderId and orderListId parameters are specified, only origClientOrderId is used

Parameters

Parameter	Type
params	WSAPIOrderListStatusRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListStatusResponse>>

---

getSpotOrderRateLimits()

getSpotOrderRateLimits(params: WSAPIRecvWindowTimestamp, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIRateLimit[]>>;

Query your current unfilled order count for all intervals Note: Weight: 40

Parameters

Parameter	Type
params	WSAPIRecvWindowTimestamp
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIRateLimit[]>>

---

getSpotOrderStatus()

getSpotOrderStatus(params: WSAPIOrderStatusRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrder>>;

Check execution status of an order Note: If both orderId and origClientOrderId parameters are specified, only orderId is used

Parameters

Parameter	Type
params	WSAPIOrderStatusRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrder>>

---

getSpotPreventedMatches()

getSpotPreventedMatches(params: WSAPIMyPreventedMatchesRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIPreventedMatch[]>>;

Displays the list of orders that were expired due to STP Note: Weight varies based on query type (2-20)

Parameters

Parameter	Type
params	WSAPIMyPreventedMatchesRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIPreventedMatch[]>>

---

getSpotRecentTrades()

getSpotRecentTrades(params: WSAPITradesRecentRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPITrade[]>>;

Get recent trades Note: If you need access to real-time trading activity, consider using WebSocket Streams

Parameters

Parameter	Type
params	WSAPITradesRecentRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPITrade[]>>

---

getSpotReferencePrice()

getSpotReferencePrice(params: WSAPIReferencePriceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<SpotReferencePriceResult>>;

Query reference price for a symbol.

Parameters

Parameter	Type
params	WSAPIReferencePriceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<SpotReferencePriceResult>>

---

getSpotReferencePriceCalculation()

getSpotReferencePriceCalculation(params: WSAPIReferencePriceCalculationRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<SpotReferencePriceCalculationResponse>>;

Query how reference price is calculated for a symbol.

Parameters

Parameter	Type
params	WSAPIReferencePriceCalculationRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<SpotReferencePriceCalculationResponse>>

---

getSpotServerTime()

getSpotServerTime(wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIServerTime>>;

Test connectivity to the WebSocket API and get the current server time

Parameters

Parameter	Type
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIServerTime>>

---

getSpotSessionStatus()

getSpotSessionStatus(wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPISessionStatus>>;

Parameters

Parameter	Type
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPISessionStatus>>

---

getSpotSymbolOrderBookTicker()

getSpotSymbolOrderBookTicker(params?: WSAPITickerBookRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIBookTicker
| WSAPIBookTicker[]>>;

Get the current best price and quantity on the order book Note: If you need access to real-time order book ticker updates, consider using WebSocket Streams

Parameters

Parameter	Type
params?	WSAPITickerBookRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIBookTicker | WSAPIBookTicker[]>>

---

getSpotSymbolPriceTicker()

getSpotSymbolPriceTicker(params?: WSAPITickerPriceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIPriceTicker
| WSAPIPriceTicker[]>>;

Get the latest market price for a symbol Note: If you need access to real-time price updates, consider using WebSocket Streams

Parameters

Parameter	Type
params?	WSAPITickerPriceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIPriceTicker | WSAPIPriceTicker[]>>

---

getSpotTicker()

getSpotTicker(params: WSAPITickerRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIFullTicker
  | WSAPIMiniTicker
  | WSAPIFullTicker[]
| WSAPIMiniTicker[]>>;

Get rolling window price change statistics with a custom window Note: Window size precision is limited to 1 minute

Parameters

Parameter	Type
params	WSAPITickerRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>>

---

getSpotTradingDayTicker()

getSpotTradingDayTicker(params: WSAPITickerTradingDayRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIFullTicker
  | WSAPIMiniTicker
  | WSAPIFullTicker[]
| WSAPIMiniTicker[]>>;

Get price change statistics for a trading day

Parameters

Parameter	Type
params	WSAPITickerTradingDayRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>>

---

getSpotUIKlines()

getSpotUIKlines(params: WSAPIKlinesRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIKline[]>>;

Get klines (candlestick bars) optimized for presentation Note: This request is similar to klines, having the same parameters and response

Parameters

Parameter	Type
params	WSAPIKlinesRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIKline[]>>

---

getWSClient()

getWSClient(): WebsocketClient;

Returns

WebsocketClient

---

modifyFuturesOrder()

modifyFuturesOrder(market: "usdm" | "coinm", params: WSAPIFuturesOrderModifyRequest): Promise<WSAPIResponse<WSAPIFuturesOrder>>;

Modify an existing futures order

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPIFuturesOrderModifyRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesOrder>>

---

pingUserDataStreamForKey()

pingUserDataStreamForKey(params: WSAPIUserDataListenKeyRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<object>>;

Attempt to "ping" a listen key.

Note: for "Spot" markets, the listenKey workflow is deprecated, use subscribeUserDataStream() instead.

Parameters

Parameter	Type	Default value	Description
params	WSAPIUserDataListenKeyRequest	undefined	-
wsKey?	WSAPIWsKey	WS_KEY_MAP.mainWSAPI	-

Returns

Promise<WSAPIResponse<object>>

---

placeSpotOCOOrderList()

placeSpotOCOOrderList(params: WSAPIOrderListPlaceOCORequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new OCO (One-Cancels-the-Other) order list Note: Activation of one order immediately cancels the other

Parameters

Parameter	Type
params	WSAPIOrderListPlaceOCORequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotOPOCOOrderList()

placeSpotOPOCOOrderList(params: WSAPIOrderListPlaceOPOCORequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new OPOCO (One-Pays-One-Cancels-the-Other) order list Note: Combines OPO and OCO - working order pays for two pending orders, one cancels the other

Parameters

Parameter	Type
params	WSAPIOrderListPlaceOPOCORequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotOPOOrderList()

placeSpotOPOOrderList(params: WSAPIOrderListPlaceOPORequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new OPO (One-Pays-the-Other) order list Note: One order pays for the other - when the working order is filled, the pending order is placed

Parameters

Parameter	Type
params	WSAPIOrderListPlaceOPORequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotOrderList()

placeSpotOrderList(params: WSAPIOrderListPlaceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new order list Note: This is a deprecated endpoint, consider using placeOCOOrderList instead

Parameters

Parameter	Type
params	WSAPIOrderListPlaceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotOTOCOOrderList()

placeSpotOTOCOOrderList(params: WSAPIOrderListPlaceOTOCORequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new OTOCO (One-Triggers-One-Cancels-the-Other) order list Note: The pending orders are placed only when the working order is fully filled

Parameters

Parameter	Type
params	WSAPIOrderListPlaceOTOCORequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotOTOOrderList()

placeSpotOTOOrderList(params: WSAPIOrderListPlaceOTORequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>;

Place a new OTO (One-Triggers-the-Other) order list Note: The pending order is placed only when the working order is fully filled

Parameters

Parameter	Type
params	WSAPIOrderListPlaceOTORequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPIOrderListPlaceResponse>>

---

placeSpotSOROrder()

placeSpotSOROrder(params: WSAPISOROrderPlaceRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPISOROrderPlaceResponse>>;

Place a new order using Smart Order Routing (SOR) Note: Only supports LIMIT and MARKET orders. quoteOrderQty is not supported

Parameters

Parameter	Type
params	WSAPISOROrderPlaceRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPISOROrderPlaceResponse>>

---

setTimeOffsetMs()

setTimeOffsetMs(newOffset: number): void;

Parameters

Parameter	Type
newOffset	number

Returns

void

---

startUserDataStreamForKey()

startUserDataStreamForKey(params: object, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<{
  listenKey: string;
}>>;

Start the user data stream for an apiKey (passed as param).

Note: for "Spot" markets, the listenKey workflow is deprecated, use subscribeUserDataStream() instead.

Parameters

Parameter	Type	Default value	Description
params	{ apiKey: string; }	undefined	-
params.apiKey	string	undefined	-
wsKey?	WSAPIWsKey	WS_KEY_MAP.mainWSAPI	-

Returns

Promise<WSAPIResponse<{ listenKey: string; }>>

listenKey

---

stopUserDataStreamForKey()

stopUserDataStreamForKey(params: WSAPIUserDataListenKeyRequest, wsKey?: WSAPIWsKey): Promise<WSAPIResponse<object>>;

Stop the user data stream listen key.

Parameters

Parameter	Type	Default value	Description
params	WSAPIUserDataListenKeyRequest	undefined	-
wsKey?	WSAPIWsKey	WS_KEY_MAP.mainWSAPI	-

Returns

Promise<WSAPIResponse<object>>

---

submitNewFuturesAlgoOrder()

submitNewFuturesAlgoOrder(params: WSAPINewFuturesAlgoOrderRequest): Promise<WSAPIResponse<WSAPIFuturesAlgoOrder>>;

Send in a new algo order

Ref: https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/New-Algo-Order

Parameters

Parameter	Type
params	WSAPINewFuturesAlgoOrderRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesAlgoOrder>>

---

submitNewFuturesOrder()

submitNewFuturesOrder(market: "usdm" | "coinm", params: WSAPINewFuturesOrderRequest): Promise<WSAPIResponse<WSAPIFuturesOrder>>;

Submit a futures order

This endpoint is used for both USDM and COINM futures.

Parameters

Parameter	Type
market	"usdm" | "coinm"
params	WSAPINewFuturesOrderRequest

Returns

Promise<WSAPIResponse<WSAPIFuturesOrder>>

---

submitNewSpotOrder()

submitNewSpotOrder(params: WSAPINewSpotOrderRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<WSAPISpotOrderResponse>>;

Submit a spot order

Parameters

Parameter	Type
params	WSAPINewSpotOrderRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<WSAPISpotOrderResponse>>

---

subscribeUserDataStream()

subscribeUserDataStream(wsKey: WSAPIWsKey, isRefreshingToken?: boolean): Promise<
  | WSAPIResponse<object>
  | WSConnectedResult
| undefined>;

Request user data stream subscription on the currently authenticated connection.

If reconnected, this will automatically resubscribe unless you unsubscribe manually.

Parameters

Parameter	Type	Default value
wsKey	WSAPIWsKey	undefined
isRefreshingToken?	boolean	false

Returns

Promise< | WSAPIResponse<object> | WSConnectedResult | undefined>

---

testSpotConnectivity()

testSpotConnectivity(wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<object>>;

Test connectivity to the WebSocket API

Parameters

Parameter	Type
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse<object>>

---

testSpotOrder()

testSpotOrder(params: WSAPIOrderTestRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPIOrderTestResponse
| WSAPIOrderTestWithCommission>>;

Test order placement Note: Validates new order parameters and verifies your signature but does not send the order into the matching engine

Parameters

Parameter	Type
params	WSAPIOrderTestRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPIOrderTestResponse | WSAPIOrderTestWithCommission>>

---

testSpotSOROrder()

testSpotSOROrder(params: WSAPISOROrderTestRequest, wsKey?: WSAPIWsKeyMain): Promise<WSAPIResponse<
  | WSAPISOROrderTestResponse
| WSAPISOROrderTestResponseWithCommission>>;

Test new order creation and signature/recvWindow using Smart Order Routing (SOR) Note: Creates and validates a new order but does not send it into the matching engine

Parameters

Parameter	Type
params	WSAPISOROrderTestRequest
wsKey?	WSAPIWsKeyMain

Returns

Promise<WSAPIResponse< | WSAPISOROrderTestResponse | WSAPISOROrderTestResponseWithCommission>>

---

unsubscribeUserDataStream()

unsubscribeUserDataStream(wsKey: WSAPIWsKey): Promise<WSAPIResponse<{
  listenKey: string;
}>>;

Unsubscribe from the user data stream subscription on the currently authenticated connection.

If reconnected, this will also stop it from automatically resubscribing after reconnect.

Parameters

Parameter	Type
wsKey	WSAPIWsKey

Returns

Promise<WSAPIResponse<{ listenKey: string; }>>