Class UserDataStreamApi

UserDataStreamApi - object-oriented interface UserDataStreamApi

Implements

SpotRestAPI.UserDataStreamApiInterface

Index

Constructors

Methods

deleteUserDataStream newUserDataStream putUserDataStream

Constructors

constructor

new UserDataStreamApi(
configuration: ConfigurationRestAPI,
): SpotRestAPI.UserDataStreamApi
Parameters
- configuration: ConfigurationRestAPI
Returns SpotRestAPI.UserDataStreamApi
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:197

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
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.deleteUserDataStream
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:213

newUserDataStream

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

Returns Promise<RestApiResponse<NewUserDataStreamResponse>>
Throws
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.newUserDataStream
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:240

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.

This request does not require signature. Weight: 2
Parameters
- requestParameters: PutUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.putUserDataStream
- Defined in clients/spot/src/rest-api/modules/user-data-stream-api.ts:265