Home

Documentation

1. Getting started
    1.1 Install
    1.2 Example
2. Documentation
    2.1 Setup
    2.2 Financial Data
        2.2.1 Technical Indicator
        2.2.2 Intraday Historical Data
        2.2.3 Options Data
        2.2.4 Live Stock Prices API
        2.2.5 Historical Splits, Dividends and Short Interest
            2.2.5.1 Splits
            2.2.5.2 Dividends
            2.2.5.3 Shorts
        2.2.6 Stock Price Data (End-Of-Day Historical Data)
    2.3. Exchanges (Stock Market)
        2.3.1 Search API for Stocks, ETFs, Mutual Funds and Indices
        2.3.2 ~~Trading Hours and Market Holidays~~
        2.3.3 Bulk API for EOD, Splits and Dividends
        2.3.4 Get Exchange Symbols

---

1. Getting started

1.1 Install

$ npm install eodhistoricaldata

1.2 Example

const eodAPI = require('eodhistoricaldata').default;
// import eodAPI from "eodhistoricaldata";

eodAPI.setup({apiToken: "OeAFFmMliFG5orCUuwAKQ8l4WWFQ67YX"});
(async () => {
	const eodRes = await eodAPI.eod("AAPL.US", {fmt: 'json', from: "2020-01-01"});
 	console.log(eodRes);
})();

// OR...

eodAPI.setup({apiToken: "OeAFFmMliFG5orCUuwAKQ8l4WWFQ67YX", exchangeCode: "US"});
(async () => {
	const eodRes = await eodAPI.eod("AAPL", {fmt: 'json', from: "2020-01-01"});
	console.log(eodRes);
})();

As you can see, you must set up the module with your api token (Get yours here) and (optionally) an exchange code (List of Codes). Once you completed the setup, you can use any function available bellow.

---

2. Documentation

2.1 Setup

eodAPI.setup(options)

• options
  • apiToken required
  • exchangeCode

Sets up the module with the API token and an exchange code

2.2 Financial Data

2.2.1 Technical Indicator (NOT READY)

eodAPI.technical(symbols, options)

• symbols required
• options
  • from
  • to
  • function
  • period
  • order
  • fmt

2.2.2 Intraday Historical Data (NOT READY)

eodAPI.intraday(symbols, options)

• symbols required
• options
  • from
  • to
  • interval
  • fmt

2.2.3 Options Data (NOT READY)

eodAPI.options(symbols, options)

• symbols required
• options
  • from
  • to
  • trade_date_from
  • trade_date_to
  • contract_name

2.2.4 Live Stock Prices API (NOT READY)

eodAPI.real-time(symbols, options)

• symbols required
• options
  • fmt

2.2.5 Historical Splits, Dividends and Short Interest

2.2.5.1 Splits (NOT READY)

eodAPI.splits(symbols, options)

• symbols required
• options
  • from
  • to

2.2.5.2 Dividends (NOT READY)

eodAPI.div(symbols, options)

• symbols required
• options
  • from
  • to

2.2.5.3 Shorts (NOT READY)

eodAPI.shorts(symbols, options)

• symbols required
• options
  • from
  • to

2.2.6 Stock Price Data (End-Of-Day Historical Data)

eodAPI.eod(symbols, options)

• symbols required
• options
  • from
  • to
  • period
  • order
  • filter
  • fmt

Sets up the module with the API token and an exchange code

2.3. Exchanges (Stock Market) (NOT READY)

2.3.1 Search API for Stocks, ETFs, Mutual Funds and Indices (NOT READY)

2.3.2 Trading Hours and Market Holidays

2.3.3 Bulk API for EOD, Splits and Dividends (NOT READY)

2.3.4 Get Exchange Symbols (NOT READY)