polygon.io/src/rest/forex/realTimeCurrencyConversion.ts

Isomorphic Javascript client for Polygon.io Stocks, Forex, and Crypto APIs

// CF: https://polygon.io/docs/#!/Forex--Currencies/get_v1_conversion_from_to

import { get, IPolygonQuery } from "../transport/request";

export interface IRealTimeConversionQuery extends IPolygonQuery {
  amount: number;
  precision: number;
}
export interface ILastTradeForex {
  price: number;
  exchange: number;
  timestamp: number;
}
export interface IRealTimeConversion {
  status: string;
  from: string;
  to: string;
  initialAmount: number;
  converted: number;
  lastTrade: ILastTradeForex;
  symbol?: string;
}

export const realTimeCurrencyConversion = (
  apiKey: string,
  apiBase: string,
  from: string,
  to: string,
  query: IRealTimeConversionQuery
): Promise<IRealTimeConversion> =>
  get(`/v1/conversion/${from}/${to}`, apiKey, apiBase, query);