Class TradeDataStreamApi

TradeDataStreamApi - object-oriented interface TradeDataStreamApi

Implements

TradeDataStreamApiInterface

Index

Constructors

Methods

closeIsolatedMarginUserDataStream closeMarginUserDataStream keepaliveIsolatedMarginUserDataStream keepaliveMarginUserDataStream startIsolatedMarginUserDataStream startMarginUserDataStream

Constructors

constructor

new TradeDataStreamApi(configuration: ConfigurationRestAPI): TradeDataStreamApi
Parameters
- configuration: ConfigurationRestAPI
Returns TradeDataStreamApi
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:402

Methods

closeIsolatedMarginUserDataStream

closeIsolatedMarginUserDataStream(
requestParameters: CloseIsolatedMarginUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Close out a isolated margin user data stream.

Weight: 3000
Parameters
- requestParameters: CloseIsolatedMarginUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.closeIsolatedMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:419

closeMarginUserDataStream

closeMarginUserDataStream(
requestParameters: CloseMarginUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Close out a Margin user data stream.

Weight: 3000
Parameters
- requestParameters: CloseMarginUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.closeMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:449

keepaliveIsolatedMarginUserDataStream

keepaliveIsolatedMarginUserDataStream(
requestParameters: KeepaliveIsolatedMarginUserDataStreamRequest,
): Promise<RestApiResponse<void>>
Keepalive an isolated margin user data stream to prevent a time out.

Weight: 1
Parameters
- requestParameters: KeepaliveIsolatedMarginUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.keepaliveIsolatedMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:477

keepaliveMarginUserDataStream

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

Weight: 1
Parameters
- requestParameters: KeepaliveMarginUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<void>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.keepaliveMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:507

startIsolatedMarginUserDataStream

startIsolatedMarginUserDataStream(
requestParameters: StartIsolatedMarginUserDataStreamRequest,
): Promise<RestApiResponse<StartIsolatedMarginUserDataStreamResponse>>
Start a new isolated margin 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
- requestParameters: StartIsolatedMarginUserDataStreamRequest
  Request parameters.
Returns Promise<RestApiResponse<StartIsolatedMarginUserDataStreamResponse>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.startIsolatedMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:536

startMarginUserDataStream

startMarginUserDataStream(): Promise<
RestApiResponse<StartMarginUserDataStreamResponse>,
>
Start a new margin 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

Returns Promise<RestApiResponse<StartMarginUserDataStreamResponse>>
Throws
Memberof
TradeDataStreamApi

See
Binance API Documentation
Implementation of TradeDataStreamApiInterface.startMarginUserDataStream
- Defined in clients/margin-trading/src/rest-api/modules/trade-data-stream-api.ts:564

Class TradeDataStreamApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TradeDataStreamApi

Methods

closeIsolatedMarginUserDataStream

Parameters

Returns Promise<RestApiResponse<void>>

Throws

Memberof

See

closeMarginUserDataStream

Parameters

Returns Promise<RestApiResponse<void>>

Throws

Memberof

See

keepaliveIsolatedMarginUserDataStream

Parameters

Returns Promise<RestApiResponse<void>>

Throws

Memberof

See

keepaliveMarginUserDataStream

Parameters

Returns Promise<RestApiResponse<void>>

Throws

Memberof

See

startIsolatedMarginUserDataStream

Parameters

Returns Promise<RestApiResponse<StartIsolatedMarginUserDataStreamResponse>>

Throws

Memberof

See

startMarginUserDataStream

Returns Promise<RestApiResponse<StartMarginUserDataStreamResponse>>

Throws

Memberof

See

Settings

On This Page