Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

investing-com-api

odrail50MIT5.0.3TypeScript support: included

Unofficial APIs for Investing.com website.

investing, api, investing.com, finance, markets, nasdaq, futures, currency, exchange, etf

readme

Investing.com Unofficial APIs

Coverage Status Maintainability npm

NPM

Unofficial APIs for Investing.com website.

Install

npm i investing-com-api

APIs

getHistoricalData

Not all parameters are mandatory.

Input params

  • params Object (required)
    • input String: input string, provide a valid investing.com pairId. (Required)
    • resolution String: resolution of the response.
      • Valid values:
        • '5' (5 minutes)
        • '60' (1 hour)
        • '300' (5 hours)
        • 'D' (1 day, Default)
        • 'W' (week)
        • 'M' (month)
    • from Date: a Date object to indicate the start of the period (Required)
    • to Date: a Date object to indicate the end of the period (Required)

Output

{
  date: number;        // Timestamp of the data point
  price_open: number;  // Opening price
  price_high: number;  // Highest price during the period
  price_low: number;   // Lowest price during the period
  price_close: number; // Closing price
}[]

Example

import { getHistoricalData } = from 'investing-com-api'

async function main() {
  try {
    const historicalData = await getHistoricalData({
      input: '46925',
      resolution: 'D',
      from: new Date('2024-10-15T00:00:00.000Z'),
      to: new Date('2024-10-22T00:00:00.000Z'),
    })
  } catch (err) {
    console.error(err);
  }
}

Response

[
  {
    date: 1659398400000,
    price_open: 1.0264,
    price_high: 1.0294,
    price_low: 1.0155,
    price_close: 1.0157,
    volume: 10
  },
  {
    date: 1659484800000,
    price_open: 1.0158,
    price_high: 1.0209,
    price_low: 1.0126,
    price_close: 1.0136,
    volume: 15
  },
  ...
]

Run tests

npm test

Run lint

npm run lint

Thanks to