Class RiskDataStreamApi

RiskDataStreamApi - object-oriented interface RiskDataStreamApi

Implements

RiskDataStreamApiInterface

Index

Constructors

Methods

closeUserDataStream keepaliveUserDataStream startUserDataStream

Constructors

constructor

new RiskDataStreamApi(configuration: ConfigurationRestAPI): RiskDataStreamApi
Parameters
- configuration: ConfigurationRestAPI
Returns RiskDataStreamApi
- Defined in clients/margin-trading/src/rest-api/modules/risk-data-stream-api.ts:170

Methods

closeUserDataStream

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

Weight: 3000

Returns Promise<RestApiResponse<void>>
Throws
Memberof
RiskDataStreamApi

See
Binance API Documentation
Implementation of RiskDataStreamApiInterface.closeUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/risk-data-stream-api.ts:186

keepaliveUserDataStream

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

Weight: 1
Parameters
- requestParameters: MarginTradingRestAPI.KeepaliveUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
RiskDataStreamApi

See
Binance API Documentation
Implementation of RiskDataStreamApiInterface.keepaliveUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/risk-data-stream-api.ts:210

startUserDataStream

startUserDataStream(): Promise<
RestApiResponse<MarginTradingRestAPI.StartUserDataStreamResponse>,
>
Start a new user data stream.

Weight: 1

Returns Promise<RestApiResponse<MarginTradingRestAPI.StartUserDataStreamResponse>>
Throws
Memberof
RiskDataStreamApi

See
Binance API Documentation
Implementation of RiskDataStreamApiInterface.startUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/risk-data-stream-api.ts:237