Class UserDataStreamApi

UserDataStreamApi - object-oriented interface UserDataStreamApi

Implements

UserDataStreamApiInterface

Index

Constructors

Methods

sessionSubscriptions userDataStreamSubscribe userDataStreamSubscribeSignature userDataStreamUnsubscribe

Constructors

constructor

new UserDataStreamApi(websocketBase: WebsocketAPIBase): UserDataStreamApi
Parameters
- websocketBase: WebsocketAPIBase
Returns UserDataStreamApi
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:162

Methods

sessionSubscriptions

sessionSubscriptions(
requestParameters?: SessionSubscriptionsRequest,
): Promise<WebsocketApiResponse<SessionSubscriptionsResponse>>
Weight: 2

Data Source*: Memory
Parameters
- requestParameters: SessionSubscriptionsRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<SessionSubscriptionsResponse>>
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.sessionSubscriptions
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:179

userDataStreamSubscribe

userDataStreamSubscribe(
requestParameters?: UserDataStreamSubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Subscribe to the User Data Stream in the current WebSocket connection. Weight: 2
Parameters
- requestParameters: UserDataStreamSubscribeRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.userDataStreamSubscribe
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:199

userDataStreamSubscribeSignature

userDataStreamSubscribeSignature(
requestParameters?: UserDataStreamSubscribeSignatureRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Weight: 2
Parameters
- requestParameters: UserDataStreamSubscribeSignatureRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.userDataStreamSubscribeSignature
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:219

userDataStreamUnsubscribe

userDataStreamUnsubscribe(
requestParameters?: UserDataStreamUnsubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Stop listening to the User Data Stream in the current WebSocket connection.

Note that session.logout will only close the subscription created with userdataStream.subscribe but not subscriptions opened with userDataStream.subscribe.signature. Weight: 2
Parameters
- requestParameters: UserDataStreamUnsubscribeRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.userDataStreamUnsubscribe
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:241