Class UserDataStreamApi

UserDataStreamApi - object-oriented interface UserDataStreamApi

Implements

SpotWebsocketAPI.UserDataStreamApiInterface

Index

Constructors

Methods

userDataStreamPing userDataStreamStart userDataStreamStop userDataStreamSubscribe userDataStreamUnsubscribe

Constructors

constructor

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

Methods

userDataStreamPing

userDataStreamPing(
requestParameters: UserDataStreamPingRequest,
): Promise<WebsocketApiResponse<UserDataStreamPingResponse>>
Ping a user data stream to keep it alive.

User data streams close automatically after 60 minutes, even if you're listening to them on WebSocket Streams. In order to keep the stream open, you have to regularly send pings using the userDataStream.ping request.

It is recommended to send a ping once every 30 minutes. Weight: 2
Parameters
- requestParameters: UserDataStreamPingRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamPingResponse>>
Memberof
UserDataStreamApi

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

userDataStreamStart

userDataStreamStart(
requestParameters?: UserDataStreamStartRequest,
): Promise<WebsocketApiResponse<UserDataStreamStartResponse>>
Start a new user data stream. Weight: 2
Parameters
- requestParameters: UserDataStreamStartRequest = {}
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamStartResponse>>
Memberof
UserDataStreamApi

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

userDataStreamStop

userDataStreamStop(
requestParameters: UserDataStreamStopRequest,
): Promise<WebsocketApiResponse<UserDataStreamStopResponse>>
Explicitly stop and close the user data stream. Weight: 2
Parameters
- requestParameters: UserDataStreamStopRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamStopResponse>>
Memberof
UserDataStreamApi

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

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:278

userDataStreamUnsubscribe

userDataStreamUnsubscribe(
requestParameters?: UserDataStreamUnsubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Stop listening to the User Data Stream in the current WebSocket connection. 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:298