Interface MarketDataApiInterface

MarketDataApi - interface MarketDataApi

interface MarketDataApiInterface {
    exchangeInfo(
        requestParameters?: StocksRestAPI.ExchangeInfoRequest,
    ): Promise<RestApiResponse<StocksRestAPI.ExchangeInfoResponse>>;
    latestQuote(
        requestParameters: LatestQuoteRequest,
    ): Promise<RestApiResponse<LatestQuoteResponse>>;
    tokenizedAssets(): Promise<RestApiResponse<TokenizedAssetsResponse>>;
}

Implemented by

StocksRestAPI.MarketDataApi

Index

Methods

exchangeInfo latestQuote tokenizedAssets

Methods

exchangeInfo

exchangeInfo(
requestParameters?: StocksRestAPI.ExchangeInfoRequest,
): Promise<RestApiResponse<StocksRestAPI.ExchangeInfoResponse>>
Returns current exchange trading rules and the list of tradable US-equity symbols. MARKET_DATA endpoint — requires an API key (X-MBX-APIKEY) but no signature. Response is served from a server-side cache.

Weight: 1

Security Type: MARKET_DATA
Parameters
- OptionalrequestParameters: StocksRestAPI.ExchangeInfoRequest
  Request parameters.
Returns Promise<RestApiResponse<StocksRestAPI.ExchangeInfoResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/stocks/src/rest-api/modules/market-data-api.ts:146

latestQuote

latestQuote(
requestParameters: LatestQuoteRequest,
): Promise<RestApiResponse<LatestQuoteResponse>>
Returns the latest best bid / best ask for a single US-equity ticker. The returned value is at most ~5 seconds stale. Returns an empty response body (not the literal null) when no quote is available for the supplied ticker (e.g. the ticker is unknown, halted, or de-listed).

Weight: 1

Security Type: MARKET_DATA
Parameters
- requestParameters: LatestQuoteRequest
  Request parameters.
Returns Promise<RestApiResponse<LatestQuoteResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/stocks/src/rest-api/modules/market-data-api.ts:162

tokenizedAssets

tokenizedAssets(): Promise<RestApiResponse<TokenizedAssetsResponse>>
Returns the list of all tokenized assets currently available for mint / redeem, together with each asset's underlying equity symbol and conversion multiplier. MARKET_DATA endpoint — requires an API key (X-MBX-APIKEY) but no signature. Response is served from a server-side cache.

Weight: 1

Security Type: MARKET_DATA

Returns Promise<RestApiResponse<TokenizedAssetsResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/stocks/src/rest-api/modules/market-data-api.ts:177