Skip to main content

Overview

The Market Data API provides access to real-time stock quotes and comprehensive equity details.

Methods

getEquityDetails(symbols)

// Single symbol
const details = await client.marketData.getEquityDetails('AAPL');

// Multiple symbols
const details = await client.marketData.getEquityDetails(['AAPL', 'GOOGL', 'MSFT']);

details.forEach(equity => {
  console.log(`${equity.symbol}: $${equity.price}`);
  console.log(`  Market Cap: $${equity.marketCap}`);
  console.log(`  P/E Ratio: ${equity.peRatio}`);
});

search(query)

const results = await client.marketData.search('Apple');

TypeScript Types

interface EquityDetails {
  symbol: string;
  name: string;
  price: number;
  marketCap: number;
  peRatio: number;
  week52High: number;
  week52Low: number;
  dividendYield: number;
}

Examples

const symbols = ['AAPL', 'GOOGL', 'MSFT'];
const details = await client.marketData.getEquityDetails(symbols);

details.forEach(equity => {
  console.log(`${equity.symbol}: $${equity.price} (P/E: ${equity.peRatio})`);
});