Interface MarketDataApiInterface

MarketDataApi - interface MarketDataApi

interface MarketDataApiInterface {
    aggregatedTrades(
        requestParameters: AggregatedTradesRequest,
    ): Promise<RestApiResponse<AggregatedTradesResponse>>;
    fullDepth(
        requestParameters: FullDepthRequest,
    ): Promise<RestApiResponse<FullDepthResponse>>;
    getExchangeInfo(): Promise<RestApiResponse<GetExchangeInfoResponse>>;
    klines(
        requestParameters: AlphaRestAPI.KlinesRequest,
    ): Promise<RestApiResponse<AlphaRestAPI.KlinesResponse>>;
    ticker(
        requestParameters: AlphaRestAPI.TickerRequest,
    ): Promise<RestApiResponse<AlphaRestAPI.TickerResponse>>;
    tokenList(): Promise<RestApiResponse<TokenListResponse>>;
}

Implemented by

AlphaRestAPI.MarketDataApi

Index

Methods

aggregatedTrades fullDepth getExchangeInfo klines ticker tokenList

Methods

aggregatedTrades

aggregatedTrades(
requestParameters: AggregatedTradesRequest,
): Promise<RestApiResponse<AggregatedTradesResponse>>
Retrieves compressed, aggregated historical trades for a specific symbol. Useful for recent trade history.
Parameters
- requestParameters: AggregatedTradesRequest
  Request parameters.
Returns Promise<RestApiResponse<AggregatedTradesResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:278

fullDepth

fullDepth(
requestParameters: FullDepthRequest,
): Promise<RestApiResponse<FullDepthResponse>>
Fetches the full order book depth (UI & API orders) for a symbol, including bid and ask orders with their prices and quantities.
Parameters
- requestParameters: FullDepthRequest
  Request parameters.
Returns Promise<RestApiResponse<FullDepthResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:290

getExchangeInfo

getExchangeInfo(): Promise<RestApiResponse<GetExchangeInfoResponse>>
Fetches general exchange information, such as supported symbols, rate limits, and server time.

Returns Promise<RestApiResponse<GetExchangeInfoResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:299

klines

klines(
requestParameters: AlphaRestAPI.KlinesRequest,
): Promise<RestApiResponse<AlphaRestAPI.KlinesResponse>>
Fetches Kline/candlestick bars for a symbol, which include open/high/low/close prices and volume over intervals. Useful for charting and analysis.
Parameters
- requestParameters: AlphaRestAPI.KlinesRequest
  Request parameters.
Returns Promise<RestApiResponse<AlphaRestAPI.KlinesResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:309

ticker

ticker(
requestParameters: AlphaRestAPI.TickerRequest,
): Promise<RestApiResponse<AlphaRestAPI.TickerResponse>>
Gets the 24-hour rolling window price change statistics for a symbol, including volume and price changes.
Parameters
- requestParameters: AlphaRestAPI.TickerRequest
  Request parameters.
Returns Promise<RestApiResponse<AlphaRestAPI.TickerResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:319

tokenList

tokenList(): Promise<RestApiResponse<TokenListResponse>>
Retrieves a list of all available ALPHA tokens, including their IDs and symbols. Use this to find the token ID for constructing symbols in other endpoints.

Returns Promise<RestApiResponse<TokenListResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/alpha/src/rest-api/modules/market-data-api.ts:328