Interface UserDataStreamApiInterface

UserDataStreamApi - interface UserDataStreamApi

interface UserDataStreamApiInterface {
    closeUserDataStream(): Promise<RestApiResponse<void>>;
    keepaliveUserDataStream(
        requestParameters: MarginTradingRestAPI.KeepaliveUserDataStreamRequest,
    ): Promise<RestApiResponse<void>>;
    startUserDataStream(): Promise<
        RestApiResponse<MarginTradingRestAPI.StartUserDataStreamResponse>,
    >;
}

Implemented by

MarginTradingRestAPI.UserDataStreamApi

Index

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

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
UserDataStreamApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:140

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
UserDataStreamApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:154

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
UserDataStreamApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:169