Interface: WsAPITopicRequestParamMap<TWSKey = `WsKey`>

Request parameters expected per operation.

Each "key" here is the name of the command/operation.
Each "value" here has the parameters required for the command.

Make sure to add new topics to WS_API_Operations and the response param map too.

Type Parameters

Type Parameter	Default type
`TWSKey`	`WsKey`

Properties

Property	Type	Description
`account.balance`	`WSAPIRecvWindowTimestamp`	-
`account.commission`	`WSAPIAccountCommissionWSAPIRequest`	-
`account.position`	`WSAPIRecvWindowTimestamp`	Futures account requests & parameters: https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
`account.rateLimits.orders`	\| `void` \| `WSAPIRecvWindowTimestamp`	-
`account.status`	\| `void` \| `TWSKey` extends `WsAPIFuturesWsKey` ? `WSAPIRecvWindowTimestamp` : `WSAPIAccountInformationRequest`	Account requests & parameters: - Spot: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests - Futures: https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
`algoOrder.cancel`	`WSAPIFuturesAlgoOrderCancelRequest`	-
`algoOrder.place`	`WSAPINewFuturesAlgoOrderRequest`	-
`allOrderLists`	`void` \| `WSAPIAllOrderListsRequest`	-
`allOrders`	`WSAPIAllOrdersRequest`	-
`avgPrice`	`WSAPIAvgPriceRequest`	-
`blockTrades.historical`	`WSAPIBlockTradesHistoricalRequest`	-
`depth`	`TWSKey` extends `WsAPIFuturesWsKey` ? `WSAPIFuturesOrderBookRequest` : `WSAPIOrderBookRequest`	Market data requests & parameters: - Spot: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/market-data-requests - Futures: https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api
`exchangeInfo`	`void` \| `WSAPIExchangeInfoRequest`	-
`executionRules`	`void` \| `WSAPIExecutionRulesRequest`	-
`GET_PROPERTY`	`never`	-
`klines`	`WSAPIKlinesRequest`	-
`LIST_SUBSCRIPTIONS`	`never`	-
`myAllocations`	`WSAPIMyAllocationsRequest`	-
`myPreventedMatches`	`WSAPIMyPreventedMatchesRequest`	-
`myTrades`	`WSAPIMyTradesRequest`	-
`openOrderLists.status`	`WSAPIRecvWindowTimestamp`	-
`openOrders.cancelAll`	`WSAPIOpenOrdersCancelAllRequest`	-
`openOrders.status`	`WSAPIOpenOrdersStatusRequest`	-
`order.amend.keepPriority`	`WSAPIOrderAmendKeepPriorityRequest`	-
`order.cancel`	`TWSKey` extends `WsAPIFuturesWsKey` ? `WSAPIFuturesOrderCancelRequest` : `WSAPIOrderCancelRequest`	-
`order.cancelReplace`	`WSAPIOrderCancelReplaceRequest`	-
`order.modify`	`WSAPIFuturesOrderModifyRequest`	-
`order.place`	(`TWSKey` extends `WsAPIFuturesWsKey` ? `WSAPINewFuturesOrderRequest`<`numberInString`> : `WSAPINewSpotOrderRequest`) & `object`	Trading requests & parameters: - Spot: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests - Futures: https://developers.binance.com/docs/derivatives/usds-margined-futures/trading/websocket-api
`order.status`	`TWSKey` extends `WsAPIFuturesWsKey` ? `WSAPIFuturesOrderStatusRequest` : `WSAPIOrderStatusRequest`	-
`order.test`	`WSAPIOrderTestRequest`	-
`orderList.cancel`	`WSAPIOrderListCancelRequest`	-
`orderList.place`	`WSAPIOrderListPlaceRequest`	Order list requests & parameters:
`orderList.place.oco`	`WSAPIOrderListPlaceOCORequest`	-
`orderList.place.opo`	`WSAPIOrderListPlaceOPORequest`	-
`orderList.place.opoco`	`WSAPIOrderListPlaceOPOCORequest`	-
`orderList.place.oto`	`WSAPIOrderListPlaceOTORequest`	-
`orderList.place.otoco`	`WSAPIOrderListPlaceOTOCORequest`	-
`orderList.status`	`WSAPIOrderListStatusRequest`	-
`ping`	`void`	General requests & parameters: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/general-requests
`referencePrice`	`WSAPIReferencePriceRequest`	-
`referencePrice.calculation`	`WSAPIReferencePriceCalculationRequest`	-
`session.logon`	`WSAPISessionLogonRequest`	Authentication commands & parameters: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
`session.logout`	`void`	-
`session.status`	`void`	-
`SET_PROPERTY`	`never`	-
`sor.order.place`	`WSAPISOROrderPlaceRequest`	SOR requests & parameters:
`sor.order.test`	`WSAPISOROrderTestRequest`	-
`SUBSCRIBE`	`never`	-
`ticker`	`WSAPITickerRequest`	-
`ticker.24hr`	`void` \| `WSAPITicker24hrRequest`	-
`ticker.book`	`void` \| `TWSKey` extends `WsAPIFuturesWsKey` ? \| `WSAPIFuturesTickerBookRequest` \| `undefined` : `WSAPITickerBookRequest` \| `undefined`	-
`ticker.price`	`void` \| `TWSKey` extends `WsAPIFuturesWsKey` ? \| `WSAPIFuturesTickerPriceRequest` \| `undefined` : `WSAPITickerPriceRequest` \| `undefined`	-
`ticker.tradingDay`	`WSAPITickerTradingDayRequest`	-
`time`	`void`	-
`trades.aggregate`	`WSAPITradesAggregateRequest`	-
`trades.historical`	`WSAPITradesHistoricalRequest`	-
`trades.recent`	`WSAPITradesRecentRequest`	-
`uiKlines`	`WSAPIKlinesRequest`	-
`UNSUBSCRIBE`	`never`	-
`userDataStream.ping`	`WSAPIUserDataListenKeyRequest`	-
`userDataStream.start`	`object`	User data stream: - Spot: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/user-data-stream-requests - Futures: https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api Note: for the user data stream, use the subscribe*UserDataStream() methods from the WS Client.
`userDataStream.start.apiKey`	`string`	-
`userDataStream.stop`	`WSAPIUserDataListenKeyRequest`	-
`userDataStream.subscribe`	`void`	-
`userDataStream.subscribe.listenToken`	`object`	User data streams, margin:
`userDataStream.subscribe.listenToken.listenToken`	`string`	-
`userDataStream.subscribe.signature`	`object`	-
`userDataStream.subscribe.signature.timestamp`	`number`	-
`userDataStream.unsubscribe`	`void`	-
`v2/account.balance`	`WSAPIRecvWindowTimestamp`	-
`v2/account.position`	`WSAPIRecvWindowTimestamp`	-
`v2/account.status`	`WSAPIRecvWindowTimestamp`	-

Interface: WsAPITopicRequestParamMap<TWSKey = WsKey> ​

Type Parameters ​

Properties ​

Interface: WsAPITopicRequestParamMap<TWSKey = `WsKey`>

Type Parameters

Properties