Interface MarketApiInterface

MarketApi - interface MarketApi

interface MarketApiInterface {
    candlestickStream(
        requestParameters: CandlestickStreamRequest,
    ): WebsocketStream<CandlestickStreamResponse>;
    marketStatsStream(
        requestParameters: MarketStatsStreamRequest,
    ): WebsocketStream<MarketStatsStreamResponse>;
    priceStream(
        requestParameters: PriceStreamRequest,
    ): WebsocketStream<PriceStreamResponse>;
    realTimeTradesStream(
        requestParameters: RealTimeTradesStreamRequest,
    ): WebsocketStream<RealTimeTradesStreamResponse>;
}

Implemented by

MarketApi

Index

Methods

candlestickStream marketStatsStream priceStream realTimeTradesStream

Methods

candlestickStream

candlestickStream(
requestParameters: CandlestickStreamRequest,
): WebsocketStream<CandlestickStreamResponse>
Push token candlestick (K-line) data in real time. The current (unclosed) candle keeps updating as new trades occur.

Update Speed: Real-time
Parameters
- requestParameters: CandlestickStreamRequest
  Request parameters.
Returns WebsocketStream<CandlestickStreamResponse>

Throws

Memberof
MarketApiInterface
- Defined in clients/web3-wallet/src/websocket-streams/modules/market-api.ts:150

marketStatsStream

marketStatsStream(
requestParameters: MarketStatsStreamRequest,
): WebsocketStream<MarketStatsStreamResponse>
Push token market data. Rate-limited to at most once per second per token: if a token's data changes within a 1-second window, the latest snapshot is pushed once (multiple changes are coalesced into the latest value); if there is no change, nothing is pushed.

Update Speed: Real-time
Parameters
- requestParameters: MarketStatsStreamRequest
  Request parameters.
Returns WebsocketStream<MarketStatsStreamResponse>

Throws

Memberof
MarketApiInterface
- Defined in clients/web3-wallet/src/websocket-streams/modules/market-api.ts:166

priceStream

priceStream(
requestParameters: PriceStreamRequest,
): WebsocketStream<PriceStreamResponse>
Push token price updates. Triggered every time a token's price changes.

Update Speed: Real-time
Parameters
- requestParameters: PriceStreamRequest
  Request parameters.
Returns WebsocketStream<PriceStreamResponse>

Throws

Memberof
MarketApiInterface
- Defined in clients/web3-wallet/src/websocket-streams/modules/market-api.ts:182

realTimeTradesStream

realTimeTradesStream(
requestParameters: RealTimeTradesStreamRequest,
): WebsocketStream<RealTimeTradesStreamResponse>
Push real-time token trade history. Triggered on every new transaction.

Update Speed: Real-time
Parameters
- requestParameters: RealTimeTradesStreamRequest
  Request parameters.
Returns WebsocketStream<RealTimeTradesStreamResponse>

Throws

Memberof
MarketApiInterface
- Defined in clients/web3-wallet/src/websocket-streams/modules/market-api.ts:196