Class PriceAPI

constructor

• new PriceAPI(apiClient): PriceAPI

• Parameters

  • apiClient: AxiosInstance

  Returns PriceAPI

Static Readonly URL

getPrices

• getPrices(epic, resolution, pointCount, pageSize?, pageNumber?): Promise<HistoricalPricesResponse>

• Returns historical prices for a particular instrument.

  Parameters

  • epic: string

    Instrument identifier
  • resolution: Resolution

    Time resolution
  • pointCount: number

    Limits the number of price points (not applicable if a date range has been specified)
  • pageSize: number = 0

    Number of candles per page of results (defaults to 0, no pagination)
  • pageNumber: number = 1

    Page of results to return (pagination)

  Returns Promise<HistoricalPricesResponse>

getPricesBetweenDates

• getPricesBetweenDates(epic, resolution, startDate, endDate, pageSize?, pageNumber?): Promise<HistoricalPricesResponse>

• Returns historical prices between given dates.

  Parameters

  • epic: string

    Instrument identifier
  • resolution: Resolution

    Time resolution
  • startDate: string

    Start date as ISO 8601 string, i.e. "2021-01-15T00:00:00.000Z"
  • endDate: string

    End date as ISO 8601 string, i.e. "2021-01-16T00:00:00.000Z"
  • pageSize: number = 0

    Number of candles per page of results (defaults to 0, no pagination)
  • pageNumber: number = 1

    Page of results to return (pagination)

  Returns Promise<HistoricalPricesResponse>

  Note

  Uses the v3 API response

  See

  https://labs.ig.com/reference/prices-epic.html