Interface UserDataStreamsApiInterface

UserDataStreamsApi - interface

UserDataStreamsApi

interface UserDataStreamsApiInterface {
    closeUserDataStream(
        requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamRequest,
    ): Promise<
        WebsocketApiResponse<
            DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamResponse,
        >,
    >;
    keepaliveUserDataStream(
        requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.KeepaliveUserDataStreamRequest,
    ): Promise<
        WebsocketApiResponse<
            DerivativesTradingUsdsFuturesWebsocketAPI.KeepaliveUserDataStreamResponse,
        >,
    >;
    startUserDataStream(
        requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.StartUserDataStreamRequest,
    ): Promise<
        WebsocketApiResponse<
            DerivativesTradingUsdsFuturesWebsocketAPI.StartUserDataStreamResponse,
        >,
    >;
}

Implemented by

DerivativesTradingUsdsFuturesWebsocketAPI.UserDataStreamsApi

Index

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

Methods

closeUserDataStream

closeUserDataStream(
    requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamRequest,
): Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamResponse,
    >,
>
Close out a user data stream.

Weight: 1
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamRequest
  Request parameters.
Returns Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.CloseUserDataStreamResponse,
    >,
>
Memberof
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/websocket-api/modules/user-data-streams-api.ts:38

keepaliveUserDataStream

keepaliveUserDataStream(
    requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.KeepaliveUserDataStreamRequest,
): Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.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: 1
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesWebsocketAPI.KeepaliveUserDataStreamRequest
  Request parameters.
Returns Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.KeepaliveUserDataStreamResponse,
    >,
>
Memberof
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/websocket-api/modules/user-data-streams-api.ts:53

startUserDataStream

startUserDataStream(
    requestParameters?: DerivativesTradingUsdsFuturesWebsocketAPI.StartUserDataStreamRequest,
): Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.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: 1
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesWebsocketAPI.StartUserDataStreamRequest
  Request parameters.
Returns Promise<
    WebsocketApiResponse<
        DerivativesTradingUsdsFuturesWebsocketAPI.StartUserDataStreamResponse,
    >,
>
Memberof
UserDataStreamsApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/websocket-api/modules/user-data-streams-api.ts:68