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

UserDataStreamApi

Index

Methods

sessionSubscriptions userDataStreamSubscribe userDataStreamSubscribeSignature userDataStreamUnsubscribe

Methods

sessionSubscriptions

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

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. 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:60

userDataStreamSubscribeSignature

userDataStreamSubscribeSignature(
requestParameters?: UserDataStreamSubscribeSignatureRequest,
): Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Weight: 2
Parameters
- OptionalrequestParameters: UserDataStreamSubscribeSignatureRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamSubscribeSignatureResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:74

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
- OptionalrequestParameters: UserDataStreamUnsubscribeRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<UserDataStreamUnsubscribeResponse>>
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/websocket-api/modules/user-data-stream-api.ts:90