eodhd

v1.0.0

Published

a month ago

Official Node.js/TypeScript library for EODHD Financial Data APIs

0High
0Medium
0Low

eodhd financial-data stock-market api stocks etf forex crypto fundamentals options eod historical-data real-time websocket typescript

eodhd

Official Node.js/TypeScript library for EODHD Financial Data APIs.

Access 150,000+ tickers across 70+ exchanges — historical prices, fundamentals, options, news, real-time WebSocket streaming, and more.

Installation

npm install eodhd

Quick Start

import { EODHDClient } from 'eodhd';

const client = new EODHDClient({ apiToken: 'YOUR_API_TOKEN' });

// Get historical prices
const prices = await client.eod('AAPL.US', { from: '2024-01-01', to: '2024-12-31' });
console.log(prices[0]);
// { date: '2024-01-02', open: 187.15, high: 188.44, low: 183.89, close: 185.64, adjusted_close: 184.53, volume: 82488700 }

// Get live price
const quote = await client.realTime('AAPL.US');
console.log(`${quote.code}: $${quote.close} (${quote.change_p}%)`);

// Search for stocks
const results = await client.search('Tesla', { limit: 5 });

API Reference

All methods return Promises. Ticker format is SYMBOL.EXCHANGE (e.g. AAPL.US, VOD.LSE, BTC-USD.CC).

Historical & Price Data

// End-of-day historical prices
const eod = await client.eod('AAPL.US', {
  from: '2024-01-01',
  to: '2024-12-31',
  period: 'd', // 'd' (daily), 'w' (weekly), 'm' (monthly)
  order: 'a',  // 'a' (ascending), 'd' (descending)
});

// Intraday data
const intraday = await client.intraday('AAPL.US', {
  interval: '5m', // '1m', '5m', '1h'
  from: '1704067200',
  to: '1704153600',
});

// Live (delayed) stock price
const live = await client.realTime('AAPL.US');

// Multiple tickers in one call
const liveMulti = await client.realTime('AAPL.US', { s: 'MSFT.US,GOOG.US' });

// US extended delayed quotes (batch)
const usQuotes = await client.usQuoteDelayed({ s: 'AAPL,MSFT,GOOG' });

// Bulk EOD data for entire exchange
const bulkUs = await client.bulkEod('US', { date: '2024-12-31' });

// Historical dividends
const dividends = await client.dividends('AAPL.US', { from: '2020-01-01' });

// Historical splits
const splits = await client.splits('AAPL.US');

// Historical market capitalization
const marketCap = await client.historicalMarketCap('AAPL.US', { from: '2024-01-01' });

// US tick-level data
const ticks = await client.ticks({ s: 'AAPL', from: 1704067200, to: 1704070800 });

Fundamentals

// Full company fundamentals
const fundamentals = await client.fundamentals('AAPL.US');

// Filter specific sections
const general = await client.fundamentals('AAPL.US', { filter: 'General' });
const financials = await client.fundamentals('AAPL.US', { filter: 'Financials' });

// Bulk fundamentals for an exchange
const bulkFund = await client.bulkFundamentals('US', { symbols: 'AAPL,MSFT,GOOG' });

// Company logo (PNG)
const logoPng = await client.logo('AAPL.US'); // returns ArrayBuffer

// Company logo (SVG)
const logoSvg = await client.logoSvg('AAPL.US'); // returns ArrayBuffer

Calendar Events

// Upcoming earnings
const earnings = await client.calendar.earnings({
  from: '2025-03-01',
  to: '2025-03-31',
  symbols: 'AAPL.US,MSFT.US',
});

// Earnings trends
const trends = await client.calendar.trends({ symbols: 'AAPL.US,MSFT.US' });

// Upcoming IPOs
const ipos = await client.calendar.ipos({ from: '2025-03-01', to: '2025-06-01' });

// Upcoming splits
const splits = await client.calendar.splits({ from: '2025-03-01', to: '2025-06-01' });

// Upcoming dividends
const dividends = await client.calendar.dividends({
  'filter[date_from]': '2025-03-01',
  'filter[date_to]': '2025-03-31',
});

News & Sentiment

// Financial news
const news = await client.news({ s: 'AAPL.US', limit: 10 });

// Filter by tag
const techNews = await client.news({ t: 'technology', limit: 20 });

// Sentiment data
const sentiment = await client.sentiments({ s: 'AAPL.US', from: '2025-01-01' });

// News word weights
const weights = await client.newsWordWeights({
  s: 'AAPL.US',
  'filter[date_from]': '2025-01-01',
  'filter[date_to]': '2025-01-31',
});

Technical Indicators

// SMA, EMA, RSI, MACD, Bollinger Bands, and more
const sma = await client.technical('AAPL.US', {
  function: 'sma',
  period: 50,
  from: '2025-01-01',
  order: 'a',
});

const rsi = await client.technical('AAPL.US', {
  function: 'rsi',
  period: 14,
  from: '2025-01-01',
});

const bbands = await client.technical('AAPL.US', {
  function: 'bbands',
  period: 20,
  from: '2025-01-01',
});

// Available functions: sma, ema, wma, macd, rsi, stochastic, stochrsi,
// dmi, adx, atr, cci, sar, beta, bbands, volatility, avgvol, avgvolccy,
// splitadjusted, slope, stddev

Screening & Search

// Stock screener
const screened = await client.screener({
  sort: 'market_capitalization.desc',
  filters: JSON.stringify([['market_capitalization', '>', 1000000000]]),
  limit: 10,
});

// Search stocks/ETFs/bonds
const results = await client.search('Apple', {
  limit: 10,
  type: 'stock', // 'all', 'stock', 'etf', 'fund', 'bond', 'index', 'crypto'
});

// ID mapping (ISIN, CUSIP, FIGI, LEI, CIK)
const mapped = await client.idMapping({ 'filter[isin]': 'US0378331005' });

Exchanges

// List all exchanges
const exchanges = await client.exchanges.list();

// Tickers for an exchange
const tickers = await client.exchanges.symbols('US', { type: 'common_stock' });

// Exchange details with trading hours
const details = await client.exchanges.details('US');

// Symbol change history
const changes = await client.exchanges.symbolChangeHistory({ from: '2024-01-01' });

Macro & Economic Data

// Macroeconomic indicators
const gdp = await client.macroIndicator('USA', { indicator: 'gdp_current_usd' });
const inflation = await client.macroIndicator('USA', { indicator: 'inflation_consumer_prices_annual' });

// Economic events calendar
const events = await client.economicEvents({
  from: '2025-03-01',
  to: '2025-03-31',
  country: 'US',
});

US Treasury Rates

const bills = await client.treasury.billRates({ from: '2025-01-01' });
const yields = await client.treasury.yieldRates({ from: '2025-01-01' });
const longTerm = await client.treasury.longTermRates({ from: '2025-01-01' });
const realYield = await client.treasury.realYieldRates({ from: '2025-01-01' });

CBOE Europe Indices

const indices = await client.cboe.indices();
const index = await client.cboe.index({
  'filter[index_code]': 'BUK100P',
  'filter[feed_type]': 'constituent',
  'filter[date]': '2025-01-15',
});

Corporate Actions

// Insider transactions (SEC Form 4)
const insiders = await client.insiderTransactions({
  code: 'AAPL',
  from: '2025-01-01',
  limit: 100,
});

User Info

const user = await client.user();
// { name: '...', subscriptionType: '...', apiRequests: 42, dailyRateLimit: 100000, ... }

WebSocket (Real-time Streaming)

// Connect to real-time US trades feed
const ws = client.websocket('us', ['AAPL', 'TSLA', 'MSFT']);

ws.on('data', (tick) => {
  console.log(`${tick.s}: $${tick.p} x${tick.v} @ ${new Date(tick.t)}`);
});

ws.on('error', (err) => console.error(err));
ws.on('close', () => console.log('Disconnected'));

// Available feeds: 'us' (trades), 'us-quote' (quotes), 'forex', 'crypto'

// Close when done
ws.close();

WebSocket options:

const ws = client.websocket('forex', ['EURUSD', 'GBPUSD'], {
  maxReconnectAttempts: 10, // default: 5
  reconnectInterval: 5000,  // default: 3000ms
});

Marketplace APIs

Unicorn Bay — US Options

// List underlying symbols with options data
const symbols = await client.marketplace.unicornbay.options.underlyingSymbols({
  'page[limit]': 100,
});

// Options contracts
const contracts = await client.marketplace.unicornbay.options.contracts({
  'filter[underlying_symbol]': 'AAPL',
  'filter[type]': 'call',
  'filter[exp_date_from]': '2025-06-01',
  'page[limit]': 50,
});

// Options EOD data
const optionsEod = await client.marketplace.unicornbay.options.eod({
  'filter[underlying_symbol]': 'AAPL',
  'filter[exp_date_eq]': '2025-06-20',
});

Unicorn Bay — S&P Global Indices

// List all S&P/Dow Jones indices
const indices = await client.marketplace.unicornbay.spglobal.list();

// Index components (current)
const components = await client.marketplace.unicornbay.spglobal.components('GSPC.INDX');

// Historical components
const historical = await client.marketplace.unicornbay.spglobal.components('GSPC.INDX', {
  historical: true,
  from: '2024-01-01',
  to: '2024-12-31',
});

Unicorn Bay — Tick Data & Logos

// Tick data
const ticks = await client.marketplace.unicornbay.tickdata('AAPL');

// Stock logo
const logo = await client.marketplace.unicornbay.logo('AAPL.US');

Trading Hours

const markets = await client.marketplace.tradinghours.markets();
const details = await client.marketplace.tradinghours.details({ market: 'US.NASDAQ' });
const status = await client.marketplace.tradinghours.status({ market: 'US.NASDAQ' });
const lookup = await client.marketplace.tradinghours.lookup({ 'filter[symbol]': 'AAPL' });

PRAAMS — Investment Analytics

// Equity risk scoring
const equityRisk = await client.marketplace.praams.analyseEquityByTicker('AAPL.US');
const equityRiskIsin = await client.marketplace.praams.analyseEquityByIsin('US0378331005');

// Bond analysis
const bondAnalysis = await client.marketplace.praams.analyseBond('US912828Z880');

// Bank financials
const bankIncome = await client.marketplace.praams.bankIncomeStatementByTicker('JPM.US');
const bankBalance = await client.marketplace.praams.bankBalanceSheetByTicker('JPM.US');

// Smart equity screener
const equities = await client.marketplace.praams.exploreEquity(
  { skip: 0, take: 20 },
  { regions: ['North America'], sectors: ['Technology'] },
);

// Smart bond screener
const bonds = await client.marketplace.praams.exploreBond(
  { skip: 0, take: 20 },
  { yieldMin: 3.0, durationMax: 5.0 },
);

// Reports (PDF) — requires email for delivery
const report = await client.marketplace.praams.reportEquityByTicker('AAPL.US', { email: '[email protected]' });

InvestVerte — ESG Data

const companies = await client.marketplace.investverte.companies();
const countries = await client.marketplace.investverte.countries();
const sectors = await client.marketplace.investverte.sectors();

// Company ESG ratings
const esg = await client.marketplace.investverte.esg('AAPL.US', { year: 2024 });

// Country ESG ratings
const countryEsg = await client.marketplace.investverte.country('US');

// Sector ESG ratings
const sectorEsg = await client.marketplace.investverte.sector('Technology');

Error Handling

import { EODHDClient, EODHDError } from 'eodhd';

try {
  const data = await client.eod('INVALID.XX');
} catch (err) {
  if (err instanceof EODHDError) {
    console.log(err.statusCode); // 404
    console.log(err.message);    // "EODHD API Error (404): ..."
  }
}

Configuration

const client = new EODHDClient({
  apiToken: 'YOUR_API_TOKEN',       // required
  baseUrl: 'https://eodhd.com/api', // optional, default
  timeout: 30000,                    // optional, ms, default 30s
});

Requirements

Node.js >= 20 (uses native fetch)
Also works in Deno, Bun, and modern browsers
Optional: ws package for WebSocket in Node.js (browsers use native WebSocket)

TypeScript

Full TypeScript support with typed parameters and responses:

import { EODHDClient, EodDataPoint, RealTimeQuote, SearchResult } from 'eodhd';

const client = new EODHDClient({ apiToken: 'xxx' });
const prices: EodDataPoint[] = await client.eod('AAPL.US');
const quote: RealTimeQuote = await client.realTime('AAPL.US');
const results: SearchResult[] = await client.search('Apple');

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

eodhd

Installation

Quick Start

API Reference

Historical & Price Data

Fundamentals

Calendar Events

News & Sentiment

Technical Indicators

Screening & Search

Exchanges

Macro & Economic Data

US Treasury Rates

CBOE Europe Indices

Corporate Actions

User Info

WebSocket (Real-time Streaming)

Marketplace APIs

Unicorn Bay — US Options

Unicorn Bay — S&P Global Indices

Unicorn Bay — Tick Data & Logos

Trading Hours

PRAAMS — Investment Analytics

InvestVerte — ESG Data

Error Handling

Configuration

Requirements

TypeScript

License

Links