Class UserDataStreamsApi

UserDataStreamsApi - object-oriented interface UserDataStreamsApi

Implements

DerivativesTradingUsdsFuturesRestAPI.UserDataStreamsApiInterface

Index

Constructors

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

Constructors

constructor

new UserDataStreamsApi(
configuration: ConfigurationRestAPI,
): DerivativesTradingUsdsFuturesRestAPI.UserDataStreamsApi
Parameters
- configuration: ConfigurationRestAPI
Returns DerivativesTradingUsdsFuturesRestAPI.UserDataStreamsApi
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/user-data-streams-api.ts:178

Methods

closeUserDataStream

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

Weight(IP): 1

Security Type: USER_STREAM

Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamsApi

See
Binance API Documentation
Implementation of UserDataStreamsApiInterface.closeUserDataStream
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/user-data-streams-api.ts:196

keepaliveUserDataStream

keepaliveUserDataStream(): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.KeepaliveUserDataStreamResponse,
    >,
>
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 60 minutes.

Weight(IP): 1

Security Type: USER_STREAM

Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.KeepaliveUserDataStreamResponse,
    >,
>
Throws
Memberof
UserDataStreamsApi

See
Binance API Documentation
Implementation of UserDataStreamsApiInterface.keepaliveUserDataStream
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/user-data-streams-api.ts:225

startUserDataStream

startUserDataStream(): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.StartUserDataStreamResponse,
    >,
>
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

Weight(IP): 1

Security Type: USER_STREAM

Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.StartUserDataStreamResponse,
    >,
>
Throws
Memberof
UserDataStreamsApi

See
Binance API Documentation
Implementation of UserDataStreamsApiInterface.startUserDataStream
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/user-data-streams-api.ts:257