Interface WebSocketStreamsApiInterface

WebSocketStreamsApi - interface WebSocketStreamsApi

interface WebSocketStreamsApiInterface {
    aggTrade(
        requestParameters: AggTradeRequest,
    ): WebsocketStream<AggTradeResponse>;
    allMarketRollingWindowTicker(
        requestParameters: AllMarketRollingWindowTickerRequest,
    ): WebsocketStream<AllMarketRollingWindowTickerResponse>;
    allMiniTicker(
        requestParameters?: AllMiniTickerRequest,
    ): WebsocketStream<AllMiniTickerResponse>;
    allTicker(
        requestParameters?: AllTickerRequest,
    ): WebsocketStream<AllTickerResponse>;
    avgPrice(
        requestParameters: SpotWebsocketStreams.AvgPriceRequest,
    ): WebsocketStream<SpotWebsocketStreams.AvgPriceResponse>;
    bookTicker(
        requestParameters: BookTickerRequest,
    ): WebsocketStream<BookTickerResponse>;
    diffBookDepth(
        requestParameters: DiffBookDepthRequest,
    ): WebsocketStream<DiffBookDepthResponse>;
    kline(requestParameters: KlineRequest): WebsocketStream<KlineResponse>;
    klineOffset(
        requestParameters: KlineOffsetRequest,
    ): WebsocketStream<KlineOffsetResponse>;
    miniTicker(
        requestParameters: MiniTickerRequest,
    ): WebsocketStream<MiniTickerResponse>;
    partialBookDepth(
        requestParameters: PartialBookDepthRequest,
    ): WebsocketStream<PartialBookDepthResponse>;
    rollingWindowTicker(
        requestParameters: RollingWindowTickerRequest,
    ): WebsocketStream<RollingWindowTickerResponse>;
    ticker(
        requestParameters: SpotWebsocketStreams.TickerRequest,
    ): WebsocketStream<SpotWebsocketStreams.TickerResponse>;
    trade(requestParameters: TradeRequest): WebsocketStream<TradeResponse>;
}

Implemented by

WebSocketStreamsApi

Index

Methods

aggTrade allMarketRollingWindowTicker allMiniTicker allTicker avgPrice bookTicker diffBookDepth kline klineOffset miniTicker partialBookDepth rollingWindowTicker ticker trade

Methods

aggTrade

aggTrade(requestParameters: AggTradeRequest): WebsocketStream<AggTradeResponse>
The Aggregate Trade Streams push trade information that is aggregated for a single taker order.
Parameters
- requestParameters: AggTradeRequest
  Request parameters.
Returns WebsocketStream<AggTradeResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:328

allMarketRollingWindowTicker

allMarketRollingWindowTicker(
requestParameters: AllMarketRollingWindowTickerRequest,
): WebsocketStream<AllMarketRollingWindowTickerResponse>
Rolling window ticker statistics for all market symbols, computed over multiple windows. Note that only tickers that have changed will be present in the array.
Parameters
- requestParameters: AllMarketRollingWindowTickerRequest
  Request parameters.
Returns WebsocketStream<AllMarketRollingWindowTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:341

allMiniTicker

allMiniTicker(
requestParameters?: AllMiniTickerRequest,
): WebsocketStream<AllMiniTickerResponse>
24hr rolling window mini-ticker statistics for all symbols that changed in an array. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs. Note that only tickers that have changed will be present in the array.
Parameters
- OptionalrequestParameters: AllMiniTickerRequest
  Request parameters.
Returns WebsocketStream<AllMiniTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:355

allTicker

allTicker(
requestParameters?: AllTickerRequest,
): WebsocketStream<AllTickerResponse>
24hr rolling window ticker statistics for all symbols that changed in an array. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs. Note that only tickers that have changed will be present in the array.
Parameters
- OptionalrequestParameters: AllTickerRequest
  Request parameters.
Returns WebsocketStream<AllTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:367

avgPrice

avgPrice(
requestParameters: SpotWebsocketStreams.AvgPriceRequest,
): WebsocketStream<SpotWebsocketStreams.AvgPriceResponse>
Average price streams push changes in the average price over a fixed time interval.
Parameters
- requestParameters: SpotWebsocketStreams.AvgPriceRequest
  Request parameters.
Returns WebsocketStream<SpotWebsocketStreams.AvgPriceResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:379

bookTicker

bookTicker(
requestParameters: BookTickerRequest,
): WebsocketStream<BookTickerResponse>
Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol. Multiple <symbol>@bookTicker streams can be subscribed to over one connection.
Parameters
- requestParameters: BookTickerRequest
  Request parameters.
Returns WebsocketStream<BookTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:392

diffBookDepth

diffBookDepth(
requestParameters: DiffBookDepthRequest,
): WebsocketStream<DiffBookDepthResponse>
Order book price and quantity depth updates used to locally manage an order book.
Parameters
- requestParameters: DiffBookDepthRequest
  Request parameters.
Returns WebsocketStream<DiffBookDepthResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:404

kline

kline(requestParameters: KlineRequest): WebsocketStream<KlineResponse>
The Kline/Candlestick Stream push updates to the current klines/candlestick every second in UTC+0 timezone
Parameters
- requestParameters: KlineRequest
  Request parameters.
Returns WebsocketStream<KlineResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:418

klineOffset

klineOffset(
requestParameters: KlineOffsetRequest,
): WebsocketStream<KlineOffsetResponse>
The Kline/Candlestick Stream push updates to the current klines/candlestick every second in UTC+8 timezone
Parameters
- requestParameters: KlineOffsetRequest
  Request parameters.
Returns WebsocketStream<KlineOffsetResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:430

miniTicker

miniTicker(
requestParameters: MiniTickerRequest,
): WebsocketStream<MiniTickerResponse>
24hr rolling window mini-ticker statistics. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.
Parameters
- requestParameters: MiniTickerRequest
  Request parameters.
Returns WebsocketStream<MiniTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:442

partialBookDepth

partialBookDepth(
requestParameters: PartialBookDepthRequest,
): WebsocketStream<PartialBookDepthResponse>
Top <levels> bids and asks, pushed every second. Valid <levels> are 5, 10, or 20.
Parameters
- requestParameters: PartialBookDepthRequest
  Request parameters.
Returns WebsocketStream<PartialBookDepthResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:454

rollingWindowTicker

rollingWindowTicker(
requestParameters: RollingWindowTickerRequest,
): WebsocketStream<RollingWindowTickerResponse>
Rolling window ticker statistics for a single symbol, computed over multiple windows.
Parameters
- requestParameters: RollingWindowTickerRequest
  Request parameters.
Returns WebsocketStream<RollingWindowTickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:468

ticker

ticker(
requestParameters: SpotWebsocketStreams.TickerRequest,
): WebsocketStream<SpotWebsocketStreams.TickerResponse>
24hr rolling window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.
Parameters
- requestParameters: SpotWebsocketStreams.TickerRequest
  Request parameters.
Returns WebsocketStream<SpotWebsocketStreams.TickerResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:482

trade

trade(requestParameters: TradeRequest): WebsocketStream<TradeResponse>
The Trade Streams push raw trade information; each trade has a unique buyer and seller.
Parameters
- requestParameters: TradeRequest
  Request parameters.
Returns WebsocketStream<TradeResponse>
Throws
Memberof
WebSocketStreamsApiInterface
- Defined in clients/spot/src/websocket-streams/modules/web-socket-streams-api.ts:494

Interface WebSocketStreamsApiInterface

Implemented by

Index

Methods

Methods

aggTrade

Parameters

Returns WebsocketStream<AggTradeResponse>

Throws

Memberof

allMarketRollingWindowTicker

Parameters

Returns WebsocketStream<AllMarketRollingWindowTickerResponse>

Throws

Memberof

allMiniTicker

Parameters

Returns WebsocketStream<AllMiniTickerResponse>

Throws

Memberof

allTicker

Parameters

Returns WebsocketStream<AllTickerResponse>

Throws

Memberof

avgPrice

Parameters

Returns WebsocketStream<SpotWebsocketStreams.AvgPriceResponse>

Throws

Memberof

bookTicker

Parameters

Returns WebsocketStream<BookTickerResponse>

Throws

Memberof

diffBookDepth

Parameters

Returns WebsocketStream<DiffBookDepthResponse>

Throws

Memberof

kline

Parameters

Returns WebsocketStream<KlineResponse>

Throws

Memberof

klineOffset

Parameters

Returns WebsocketStream<KlineOffsetResponse>

Throws

Memberof

miniTicker

Parameters

Returns WebsocketStream<MiniTickerResponse>

Throws

Memberof

partialBookDepth

Parameters

Returns WebsocketStream<PartialBookDepthResponse>

Throws

Memberof

rollingWindowTicker

Parameters

Returns WebsocketStream<RollingWindowTickerResponse>

Throws

Memberof

ticker

Parameters

Returns WebsocketStream<SpotWebsocketStreams.TickerResponse>

Throws

Memberof

trade

Parameters

Returns WebsocketStream<TradeResponse>

Throws

Memberof

Settings

On This Page