investing-com-api/index.d.ts

Unofficial APIs for Investing.com website.

declare module "investing-com-api" {

  export interface GetHistoricalDataParams {
    input: string,
    resolution?: '5' | '15' | '60' | '300' | 'D' | 'W' | 'M',
    from: Date,
    to: Date
  }

  export type PairId = string
  export type ChartResponse = [number, number, number, number, number, number]
  export type GetHistoricalDataFn = (params: GetHistoricalDataParams) => Promise<InvestmentData[]>

  // Structure of a single data point response
  export interface InvestmentData {
    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
  }

  export type GetHistoricalDataResponse = 
    | {
      s: "ok"
      t: number[]
      o: number[]
      h: number[]
      l: number[]
      c: number[]
      v: number[]
      vac: number[]
      vo: number[]
  } 
  | { s: "no_data", nextTime: number }
  | string[]

  export function getHistoricalData(
    params: GetHistoricalDataParams
  ): Promise<InvestmentData[]>;
}