Interface UserDataStreamsApiInterface

UserDataStreamsApi - interface UserDataStreamsApi

interface UserDataStreamsApiInterface {
    closeUserDataStream(): Promise<RestApiResponse<void>>;
    keepaliveUserDataStream(): Promise<RestApiResponse<void>>;
    startUserDataStream(): Promise<
        RestApiResponse<
            DerivativesTradingOptionsRestAPI.StartUserDataStreamResponse,
        >,
    >;
}

Implemented by

DerivativesTradingOptionsRestAPI.UserDataStreamsApi

Index

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

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
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/user-data-streams-api.ts:133

keepaliveUserDataStream

keepaliveUserDataStream(): 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 60 minutes.

Weight(IP): 1

Security Type: USER_STREAM

Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/user-data-streams-api.ts:148

startUserDataStream

startUserDataStream(): Promise<
    RestApiResponse<
        DerivativesTradingOptionsRestAPI.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<
        DerivativesTradingOptionsRestAPI.StartUserDataStreamResponse,
    >,
>
Throws
Memberof
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/user-data-streams-api.ts:161