Interface MarketStreamsApiInterface

MarketStreamsApi - interface MarketStreamsApi

interface MarketStreamsApiInterface {
    calendarStream(
        requestParameters?: CalendarStreamRequest,
    ): WebsocketStream<CalendarStreamResponse>;
    klineStream(
        requestParameters: StocksWebsocketStreams.KlineStreamRequest,
    ): WebsocketStream<StocksWebsocketStreams.KlineStreamResponse>;
    priceStream(
        requestParameters?: PriceStreamRequest,
    ): WebsocketStream<PriceStreamResponse>;
    quoteStream(
        requestParameters: QuoteStreamRequest,
    ): WebsocketStream<QuoteStreamResponse>;
    tradabilityStream(
        requestParameters: TradabilityStreamRequest,
    ): WebsocketStream<TradabilityStreamResponse>;
    tradingStatusStream(
        requestParameters: TradingStatusStreamRequest,
    ): WebsocketStream<TradingStatusStreamResponse>;
}

Implemented by

MarketStreamsApi

Index

Methods

calendarStream klineStream priceStream quoteStream tradabilityStream tradingStatusStream

Methods

calendarStream

calendarStream(
requestParameters?: CalendarStreamRequest,
): WebsocketStream<CalendarStreamResponse>
Single-stream broadcast of market-phase transitions. One message per transition; no periodic heartbeat payload. Server polls every 5 seconds. Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- OptionalrequestParameters: CalendarStreamRequest
  Request parameters.
Returns WebsocketStream<CalendarStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:145

klineStream

klineStream(
requestParameters: StocksWebsocketStreams.KlineStreamRequest,
): WebsocketStream<StocksWebsocketStreams.KlineStreamResponse>
Per-symbol candlestick updates. One stream per (symbol, interval) combination. Supported intervals: 5m, 1h, 1d, 1w, 1M. Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- requestParameters: StocksWebsocketStreams.KlineStreamRequest
  Request parameters.
Returns WebsocketStream<StocksWebsocketStreams.KlineStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:159

priceStream

priceStream(
requestParameters?: PriceStreamRequest,
): WebsocketStream<PriceStreamResponse>
Push-all price snapshot, polled every 3 seconds. One message carries the latest price for every active US-equity symbol. Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- OptionalrequestParameters: PriceStreamRequest
  Request parameters.
Returns WebsocketStream<PriceStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:171

quoteStream

quoteStream(
requestParameters: QuoteStreamRequest,
): WebsocketStream<QuoteStreamResponse>
Per-symbol real-time best-bid / best-ask. Each symbol has its own stream. Per-symbol throttle: at most one push per symbol every 200 ms. Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- requestParameters: QuoteStreamRequest
  Request parameters.
Returns WebsocketStream<QuoteStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:183

tradabilityStream

tradabilityStream(
requestParameters: TradabilityStreamRequest,
): WebsocketStream<TradabilityStreamResponse>
Per-symbol push whenever the tradable direction of a symbol changes. Pushed only when the value actually changes (new value ≠ old value). Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- requestParameters: TradabilityStreamRequest
  Request parameters.
Returns WebsocketStream<TradabilityStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:195

tradingStatusStream

tradingStatusStream(
requestParameters: TradingStatusStreamRequest,
): WebsocketStream<TradingStatusStreamResponse>
Per-symbol trading-status transitions (halts, resumes, SSR, LULD pauses, etc.). Events that do not match a known status/reason rule are not pushed. Also reachable via the SUBSCRIBE/UNSUBSCRIBE RPC — see Subscribing via RPC.
Parameters
- requestParameters: TradingStatusStreamRequest
  Request parameters.
Returns WebsocketStream<TradingStatusStreamResponse>
Throws
Memberof
MarketStreamsApiInterface
- Defined in clients/stocks/src/websocket-streams/modules/market-streams-api.ts:209

Interface MarketStreamsApiInterface

Implemented by

Index

Methods

Methods

calendarStream

Parameters

Returns WebsocketStream<CalendarStreamResponse>

Throws

Memberof

klineStream

Parameters

Returns WebsocketStream<StocksWebsocketStreams.KlineStreamResponse>

Throws

Memberof

priceStream

Parameters

Returns WebsocketStream<PriceStreamResponse>

Throws

Memberof

quoteStream

Parameters

Returns WebsocketStream<QuoteStreamResponse>

Throws

Memberof

tradabilityStream

Parameters

Returns WebsocketStream<TradabilityStreamResponse>

Throws

Memberof

tradingStatusStream

Parameters

Returns WebsocketStream<TradingStatusStreamResponse>

Throws

Memberof

Settings

On This Page