Class UserDataStreamApi

UserDataStreamApi - object-oriented interface UserDataStreamApi

Implements

MarginTradingRestAPI.UserDataStreamApiInterface

Index

Constructors

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

Constructors

constructor

new UserDataStreamApi(
configuration: ConfigurationRestAPI,
): MarginTradingRestAPI.UserDataStreamApi
Parameters
- configuration: ConfigurationRestAPI
Returns MarginTradingRestAPI.UserDataStreamApi
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:193

Methods

closeUserDataStream

closeUserDataStream(): Promise<RestApiResponse<void>>
Close out a user data stream.

Weight(UID): 3000

Security Type: USER_STREAM

Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.closeUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:211

keepaliveUserDataStream

keepaliveUserDataStream(
requestParameters: MarginTradingRestAPI.KeepaliveUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Keepalive a user data stream to prevent a time out.

Weight(UID): 1

Security Type: USER_STREAM
Parameters
- requestParameters: MarginTradingRestAPI.KeepaliveUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.keepaliveUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:239

startUserDataStream

startUserDataStream(): Promise<
RestApiResponse<MarginTradingRestAPI.StartUserDataStreamResponse>,
>
Start a new user data stream.

Weight(UID): 1

Security Type: USER_STREAM

Returns Promise<RestApiResponse<MarginTradingRestAPI.StartUserDataStreamResponse>>
Throws
Memberof
UserDataStreamApi

See
Binance API Documentation
Implementation of UserDataStreamApiInterface.startUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:270