Interface: WsAPIOperationResponseMap

Response structure expected for each operation

Each "key" here is a command/request supported by the WS API
Each "value" here is the response schema for that command.

Indexable

[key: string]: unknown

Properties

Property	Type	Description
`account.balance`	`WSAPIResponse`<`WSAPIFuturesAccountBalanceItem`[]>	-
`account.commission`	`WSAPIResponse`<`WSAPIAccountCommission`>	-
`account.position`	`WSAPIResponse`<`WSAPIFuturesPosition`[]>	Futures account responses: https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
`account.rateLimits.orders`	`WSAPIResponse`<`WSAPIRateLimit`[]>	-
`account.status`	`WSAPIResponse`< \| `WSAPIAccountInformation` \| `WSAPIFuturesAccountStatus`>	Account responses: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests
`algoOrder.cancel`	`WSAPIResponse`<`WSAPIFuturesAlgoOrderCancelResponse`>	-
`algoOrder.place`	`WSAPIResponse`<`WSAPIFuturesAlgoOrder`>	-
`allOrderLists`	`WSAPIResponse`<`WSAPIOrderListStatusResponse`[]>	-
`allOrders`	`WSAPIResponse`<`WSAPIOrder`[]>	-
`avgPrice`	`WSAPIResponse`<`WSAPIAvgPrice`>	-
`blockTrades.historical`	`WSAPIResponse`<`WSAPIBlockTrade`[]>	-
`depth`	`WSAPIResponse`< \| `WSAPIOrderBook` \| `WSAPIFuturesOrderBook`>	Market data responses - 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`	`WSAPIResponse`< \| `FuturesExchangeInfo` \| `ExchangeInfo`>	-
`executionRules`	`WSAPIResponse`<`SpotExecutionRulesResponse`>	-
`GET_PROPERTY`	`never`	-
`klines`	`WSAPIResponse`<`WSAPIKline`[]>	-
`LIST_SUBSCRIPTIONS`	`never`	-
`myAllocations`	`WSAPIResponse`<`WSAPIAllocation`[]>	-
`myPreventedMatches`	`WSAPIResponse`<`WSAPIPreventedMatch`[]>	-
`myTrades`	`WSAPIResponse`<`WSAPITrade`[]>	-
`openOrderLists.status`	`WSAPIResponse`<`WSAPIOrderListStatusResponse`[]>	-
`openOrders.cancelAll`	`WSAPIResponse`<( \| `WSAPIOrderCancel` \| `WSAPIOrderListCancelResponse`)[]>	-
`openOrders.status`	`WSAPIResponse`< \| `WSAPIOrder`[] \| `WSAPIFuturesOrder`[]>	-
`order.cancel`	`WSAPIResponse`< \| `WSAPIOrderCancel` \| `WSAPIFuturesOrder`>	-
`order.cancelReplace`	`WSAPIResponse`<`WSAPIOrderCancelReplaceResponse`>	-
`order.modify`	`WSAPIResponse`<`WSAPIFuturesOrder`>	-
`order.place`	`WSAPIResponse`< \| `WSAPIFuturesOrder` \| `WSAPISpotOrderResponse`>	Trading responses - 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`	`WSAPIResponse`< \| `WSAPIOrder` \| `WSAPIFuturesOrder`>	-
`order.test`	`WSAPIResponse`< \| `WSAPIOrderTestResponse` \| `WSAPIOrderTestWithCommission`>	-
`orderList.cancel`	`WSAPIResponse`<`WSAPIOrderListCancelResponse`>	-
`orderList.place`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	Order list responses
`orderList.place.oco`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	-
`orderList.place.opo`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	-
`orderList.place.opoco`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	-
`orderList.place.oto`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	-
`orderList.place.otoco`	`WSAPIResponse`<`WSAPIOrderListPlaceResponse`>	-
`orderList.status`	`WSAPIResponse`<`WSAPIOrderListStatusResponse`>	-
`ping`	`unknown`	General responses: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/general-requests
`referencePrice`	`WSAPIResponse`<`SpotReferencePriceResult`>	-
`referencePrice.calculation`	`WSAPIResponse`<`SpotReferencePriceCalculationResponse`>	-
`session.login`	`WSAPIResponse`<`WSAPISessionStatus`>	Session authentication responses: https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/session-authentication https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
`session.logout`	`WSAPIResponse`<`WSAPISessionStatus`>	-
`session.status`	`WSAPIResponse`<`WSAPISessionStatus`>	-
`SET_PROPERTY`	`never`	-
`sor.order.place`	`WSAPIResponse`<`WSAPISOROrderPlaceResponse`>	SOR responses
`sor.order.test`	`WSAPIResponse`< \| `WSAPISOROrderTestResponse` \| `WSAPISOROrderTestResponseWithCommission`>	-
`SUBSCRIBE`	`never`	-
`ticker`	`WSAPIResponse`< \| `WSAPIFullTicker` \| `WSAPIMiniTicker` \| `WSAPIFullTicker`[] \| `WSAPIMiniTicker`[]>	-
`ticker.24hr`	`WSAPIResponse`< \| `WSAPIFullTicker` \| `WSAPIMiniTicker` \| `WSAPIFullTicker`[] \| `WSAPIMiniTicker`[]>	-
`ticker.book`	`WSAPIResponse`< \| `WSAPIBookTicker` \| `WSAPIFuturesBookTicker` \| `WSAPIBookTicker`[] \| `WSAPIFuturesBookTicker`[]>	-
`ticker.price`	`WSAPIResponse`< \| `WSAPIPriceTicker` \| `WSAPIFuturesPriceTicker` \| `WSAPIPriceTicker`[] \| `WSAPIFuturesPriceTicker`[]>	-
`ticker.tradingDay`	`WSAPIResponse`< \| `WSAPIFullTicker` \| `WSAPIMiniTicker` \| `WSAPIFullTicker`[] \| `WSAPIMiniTicker`[]>	-
`time`	`WSAPIResponse`<`WSAPIServerTime`>	-
`trades.aggregate`	`WSAPIResponse`<`WSAPIAggregateTrade`[]>	-
`trades.historical`	`WSAPIResponse`<`WSAPITrade`[]>	-
`trades.recent`	`WSAPIResponse`<`WSAPITrade`[]>	-
`uiKlines`	`WSAPIResponse`<`WSAPIKline`[]>	-
`UNSUBSCRIBE`	`never`	-
`userDataStream.ping`	`WSAPIResponse`<`object`>	-
`userDataStream.start`	`WSAPIResponse`<{ `listenKey`: `string`; }>	-
`userDataStream.stop`	`WSAPIResponse`<`object`>	-
`userDataStream.subscribe`	`WSAPIResponse`<`object`>	-
`userDataStream.subscribe.signature`	`WSAPIResponse`<`object`>	-
`userDataStream.unsubscribe`	`WSAPIResponse`<`object`>	-
`v2/account.balance`	`WSAPIResponse`<`WSAPIFuturesAccountBalanceItem`[]>	-
`v2/account.position`	`WSAPIResponse`<`WSAPIFuturesPositionV2`[]>	-
`v2/account.status`	`WSAPIResponse`<`WSAPIFuturesAccountStatus`>	-

Interface: WsAPIOperationResponseMap ​

Indexable ​

Properties ​

Interface: WsAPIOperationResponseMap

Indexable

Properties