Class UserStreamsApi

UserStreamsApi - interface UserStreamsApi

Implements

UserStreamsApiInterface

Index

Constructors

Methods

orderReportStream

Constructors

constructor

new UserStreamsApi(websocketBase: WebsocketStreamsBase): UserStreamsApi
Parameters
- websocketBase: WebsocketStreamsBase
Returns UserStreamsApi
- Defined in clients/stocks/src/websocket-streams/modules/user-streams-api.ts:95

Methods

orderReportStream

orderReportStream(
requestParameters: OrderReportStreamRequest,
): WebsocketStream<OrderReportStreamResponse>
Real-time push of the authenticated user's order state transitions — both open-state updates (ORDER_UPDATE) and terminal-state notifications (ORDER_TERMINAL). Prerequisite: obtain a listenKey via the Listen Key endpoint first.
Parameters
- requestParameters: OrderReportStreamRequest
  Request parameters.
Returns WebsocketStream<OrderReportStreamResponse>
Throws
Memberof
UserStreamsApi

See
Binance API Documentation
Implementation of UserStreamsApiInterface.orderReportStream
- Defined in clients/stocks/src/websocket-streams/modules/user-streams-api.ts:110