Interface UserDataStreamApiInterface

UserDataStreamApi - interface

UserDataStreamApi

interface UserDataStreamApiInterface {
    sessionSubscriptions(
        requestParameters?: SessionSubscriptionsRequest,
    ): Promise<WebsocketApiResponse<SessionSubscriptionsResponse>>;
    userDataStreamSubscribe(
        requestParameters?: UserDataStreamSubscribeRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>;
    userDataStreamSubscribeSignature(
        requestParameters?: UserDataStreamSubscribeSignatureRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>;
    userDataStreamUnsubscribe(
        requestParameters?: UserDataStreamUnsubscribeRequest,
    ): Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>;
}

Implemented by

SpotWebsocketAPI.UserDataStreamApi

Index

Methods

sessionSubscriptions userDataStreamSubscribe userDataStreamSubscribeSignature userDataStreamUnsubscribe

Methods

sessionSubscriptions

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

Users should track the corresponding subscription status of related accounts as needed.

Weight(IP): 2

Security Type: NONE

Notes: Data Source:* Memory
Parameters
- OptionalrequestParameters: SessionSubscriptionsRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SessionSubscriptionsResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:46

userDataStreamSubscribe

userDataStreamSubscribe(
requestParameters?: UserDataStreamSubscribeRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Subscribe to the User Data Stream in the current WebSocket connection.

Notes:*
- This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to session.logon.
- To check the subscription status, use session.status, see the userDataStream flag indicating you have an active subscription.
- User Data Stream events are available in both JSON and SBE sessions.
- Please refer to User Data Streams for the event format details.
- For SBE, only SBE schema 2:1 or later is supported.
Weight(IP): 2

Security Type: USER_STREAM
Parameters
- OptionalrequestParameters: UserDataStreamSubscribeRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:70

userDataStreamSubscribeSignature

userDataStreamSubscribeSignature(
requestParameters?: UserDataStreamSubscribeSignatureRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Weight(IP): 2

Security Type: USER_STREAM

Notes: Data Source:* Memory
Parameters
- OptionalrequestParameters: UserDataStreamSubscribeSignatureRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:88

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(IP): 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