Interface UserDataStreamApiInterface

UserDataStreamApi - interface UserDataStreamApi

interface UserDataStreamApiInterface {
    deleteUserDataStream(
        requestParameters: DeleteUserDataStreamRequest,
    ): Promise<RestApiResponse<void>>;
    newUserDataStream(): Promise<RestApiResponse<NewUserDataStreamResponse>>;
    putUserDataStream(
        requestParameters: PutUserDataStreamRequest,
    ): Promise<RestApiResponse<void>>;
}

Implemented by

SpotRestAPI.UserDataStreamApi

Index

Methods

deleteUserDataStream newUserDataStream putUserDataStream

Methods

deleteUserDataStream

deleteUserDataStream(
requestParameters: DeleteUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Close out a user data stream. Weight: 2
Parameters
- requestParameters: DeleteUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:131

newUserDataStream

newUserDataStream(): Promise<RestApiResponse<NewUserDataStreamResponse>>
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. Weight: 2

Returns Promise<RestApiResponse<NewUserDataStreamResponse>>
Throws
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:143

putUserDataStream

putUserDataStream(
requestParameters: PutUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes. Weight: 2
Parameters
- requestParameters: PutUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApiInterface
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:154