Class Api

Api - interface Api

Implements

AlphaWebsocketStreams.ApiInterface

Index

Constructors

Methods

aggregateTradeStream allBookTickerStream allMiniTickerStream allTickerStream allTokens24hTickerStream bookTickerStream contractKlineStream fullDepthStream klineStream miniTickerStream partialDepthStream tickerStream tradeStream

Constructors

constructor

new Api(websocketBase: WebsocketStreamsBase): AlphaWebsocketStreams.Api
Parameters
- websocketBase: WebsocketStreamsBase
Returns AlphaWebsocketStreams.Api
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:741

Methods

aggregateTradeStream

aggregateTradeStream(
requestParameters: AggregateTradeStreamRequest,
): WebsocketStream<AggregateTradeStreamResponse>
Pushes aggregate trade updates for a symbol.
Parameters
- requestParameters: AggregateTradeStreamRequest
  Request parameters.
Returns WebsocketStream<AggregateTradeStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.aggregateTradeStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:756

allBookTickerStream

allBookTickerStream(
requestParameters?: AllBookTickerStreamRequest,
): WebsocketStream<AllBookTickerStreamResponse>
Pushes best bid/ask updates for all symbols.
Parameters
- requestParameters: AllBookTickerStreamRequest = {}
  Request parameters.
Returns WebsocketStream<AllBookTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.allBookTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:781

allMiniTickerStream

allMiniTickerStream(
requestParameters?: AllMiniTickerStreamRequest,
): WebsocketStream<AllMiniTickerStreamResponse>
Pushes mini ticker statistics for all symbols.
Parameters
- requestParameters: AllMiniTickerStreamRequest = {}
  Request parameters.
Returns WebsocketStream<AllMiniTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.allMiniTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:803

allTickerStream

allTickerStream(
requestParameters?: AllTickerStreamRequest,
): WebsocketStream<AllTickerStreamResponse>
Pushes full ticker statistics for all symbols.
Parameters
- requestParameters: AllTickerStreamRequest = {}
  Request parameters.
Returns WebsocketStream<AllTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.allTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:825

allTokens24hTickerStream

allTokens24hTickerStream(
requestParameters?: AllTokens24hTickerStreamRequest,
): WebsocketStream<AllTokens24hTickerStreamResponse>
Pushes 24h ticker-like metrics for all tokens.
Parameters
- requestParameters: AllTokens24hTickerStreamRequest = {}
  Request parameters.
Returns WebsocketStream<AllTokens24hTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.allTokens24hTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:847

bookTickerStream

bookTickerStream(
requestParameters: BookTickerStreamRequest,
): WebsocketStream<BookTickerStreamResponse>
Pushes best bid/ask updates for a symbol.
Parameters
- requestParameters: BookTickerStreamRequest
  Request parameters.
Returns WebsocketStream<BookTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.bookTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:869

contractKlineStream

contractKlineStream(
requestParameters: ContractKlineStreamRequest,
): WebsocketStream<ContractKlineStreamResponse>
Pushes kline updates by contractAddress@chainId.
Parameters
- requestParameters: ContractKlineStreamRequest
  Request parameters.
Returns WebsocketStream<ContractKlineStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.contractKlineStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:894

fullDepthStream

fullDepthStream(
requestParameters: FullDepthStreamRequest,
): WebsocketStream<FullDepthStreamResponse>
Returns all available depth, including UI and API orders.
Parameters
- requestParameters: FullDepthStreamRequest
  Request parameters.
Returns WebsocketStream<FullDepthStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.fullDepthStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:921

klineStream

klineStream(
requestParameters: KlineStreamRequest,
): WebsocketStream<KlineStreamResponse>
Pushes kline updates for a symbol.
Parameters
- requestParameters: KlineStreamRequest
  Request parameters.
Returns WebsocketStream<KlineStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.klineStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:947

miniTickerStream

miniTickerStream(
requestParameters: MiniTickerStreamRequest,
): WebsocketStream<MiniTickerStreamResponse>
Pushes 24h rolling mini ticker statistics.
Parameters
- requestParameters: MiniTickerStreamRequest
  Request parameters.
Returns WebsocketStream<MiniTickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.miniTickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:973

partialDepthStream

partialDepthStream(
requestParameters: PartialDepthStreamRequest,
): WebsocketStream<PartialDepthStreamResponse>
Pushes partial depth updates (UI orders only).
Parameters
- requestParameters: PartialDepthStreamRequest
  Request parameters.
Returns WebsocketStream<PartialDepthStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.partialDepthStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:998

tickerStream

tickerStream(
requestParameters: TickerStreamRequest,
): WebsocketStream<TickerStreamResponse>
Pushes full 24h rolling ticker statistics.
Parameters
- requestParameters: TickerStreamRequest
  Request parameters.
Returns WebsocketStream<TickerStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.tickerStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:1025

tradeStream

tradeStream(
requestParameters: TradeStreamRequest,
): WebsocketStream<TradeStreamResponse>
Pushes raw trade updates for a symbol.
Parameters
- requestParameters: TradeStreamRequest
  Request parameters.
Returns WebsocketStream<TradeStreamResponse>
Throws
Memberof
Api

See
Binance API Documentation
Implementation of ApiInterface.tradeStream
- Defined in clients/alpha/src/websocket-streams/modules/api.ts:1050

Class Api

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AlphaWebsocketStreams.Api

Methods

aggregateTradeStream

Parameters

Returns WebsocketStream<AggregateTradeStreamResponse>

Throws

Memberof

See

allBookTickerStream

Parameters

Returns WebsocketStream<AllBookTickerStreamResponse>

Throws

Memberof

See

allMiniTickerStream

Parameters

Returns WebsocketStream<AllMiniTickerStreamResponse>

Throws

Memberof

See

allTickerStream

Parameters

Returns WebsocketStream<AllTickerStreamResponse>

Throws

Memberof

See

allTokens24hTickerStream

Parameters

Returns WebsocketStream<AllTokens24hTickerStreamResponse>

Throws

Memberof

See

bookTickerStream

Parameters

Returns WebsocketStream<BookTickerStreamResponse>

Throws

Memberof

See

contractKlineStream

Parameters

Returns WebsocketStream<ContractKlineStreamResponse>

Throws

Memberof

See

fullDepthStream

Parameters

Returns WebsocketStream<FullDepthStreamResponse>

Throws

Memberof

See

klineStream

Parameters

Returns WebsocketStream<KlineStreamResponse>

Throws

Memberof

See

miniTickerStream

Parameters

Returns WebsocketStream<MiniTickerStreamResponse>

Throws

Memberof

See

partialDepthStream

Parameters

Returns WebsocketStream<PartialDepthStreamResponse>

Throws

Memberof

See

tickerStream

Parameters

Returns WebsocketStream<TickerStreamResponse>

Throws