Interface UserDataStreamApiInterface

UserDataStreamApi - interface

UserDataStreamApi

interface UserDataStreamApiInterface {
    userDataStreamPing(
        requestParameters: UserDataStreamPingRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamPingResponse>>;
    userDataStreamStart(
        requestParameters?: UserDataStreamStartRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamStartResponse>>;
    userDataStreamStop(
        requestParameters: UserDataStreamStopRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamStopResponse>>;
    userDataStreamSubscribe(
        requestParameters?: UserDataStreamSubscribeRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>;
    userDataStreamUnsubscribe(
        requestParameters?: UserDataStreamUnsubscribeRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>;
}

Implemented by

SpotWebsocketAPI.UserDataStreamApi

Index

Methods

userDataStreamPing userDataStreamStart userDataStreamStop userDataStreamSubscribe userDataStreamUnsubscribe

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
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:50

userDataStreamStart

userDataStreamStart(
requestParameters?: UserDataStreamStartRequest,
): Promise<WebsocketApiResponse<UserDataStreamStartResponse>>
Start a new user data stream. Weight: 2
Parameters
- OptionalrequestParameters: UserDataStreamStartRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamStartResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:64

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
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:78

userDataStreamSubscribe

userDataStreamSubscribe(
requestParameters?: UserDataStreamSubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Subscribe to the User Data Stream in the current WebSocket connection. Weight: 2
Parameters
- OptionalrequestParameters: UserDataStreamSubscribeRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:92

userDataStreamUnsubscribe

userDataStreamUnsubscribe(
requestParameters?: UserDataStreamUnsubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Stop listening to the User Data Stream in the current WebSocket connection. Weight: 2
Parameters
- OptionalrequestParameters: UserDataStreamUnsubscribeRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:106