Interface UserDataStreamApiInterface

UserDataStreamApi - interface UserDataStreamApi

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

Implemented by

MarginTradingRestAPI.UserDataStreamApi

Index

Methods

closeUserDataStream closeUserDataStreamV2 keepaliveUserDataStream keepaliveUserDataStreamV2 startUserDataStream startUserDataStreamV2

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:232

closeUserDataStreamV2

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

Weight(IP): 1

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:245

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:259

keepaliveUserDataStreamV2

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

Weight(IP): 1

Security Type: USER_STREAM
Parameters
- requestParameters: KeepaliveUserDataStreamV2Request
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
UserDataStreamApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:275

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:290

startUserDataStreamV2

startUserDataStreamV2(): Promise<RestApiResponse<StartUserDataStreamV2Response>>
Start a new user data stream.

Weight(IP): 1

Security Type: USER_STREAM

Returns Promise<RestApiResponse<StartUserDataStreamV2Response>>
Throws
Memberof
UserDataStreamApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/user-data-stream-api.ts:303