@shadowlik/exchangeratesapi/index.ts

Foreign exchange rates API - exchangeratesapi.io

/**
 * API Wrapper (https://exchangeratesapi.io/)
 * @author Henrique Marques <henrique@marquesfernandes.com>
 */
import axios from 'axios';

// Currency Code - ISO 4217 (https://www.iban.com/currency-codes)
type code =  "CAD" | "HKD" | "ISK" | "PHP" | "DKK" | "HUF" | "CZK" |
             "AUD" | "RON" | "SEK" | "IDR" | "INR" | "BRL" | "RUB" |
             "HRK" | "JPY" | "THB" | "CHF" | "SGD" | "PLN" | "BGN" |
             "TRY" | "CNY" | "NOK" | "NZD" | "ZAR" | "USD" | "MXN" |
             "ILS" | "GBP" | "KRW" | "MYR" | "EUR";

// API Base URL
const url = 'https://api.exchangeratesapi.io';

// API Response
interface apiResponse {
    rates: code[];
    base: code;
    date: string;
};

/**
 * exchangeratesApiRequest
 *
 * @param {string} action
 * @param {code[]} symbols
 * @param {code} [base='USD']
 * @returns {Promise<apiResponse>}
 */
async function exchangeratesApiRequest(action: string, symbols: code[], base: code = 'USD'): Promise<apiResponse> {
    const urlSymbols = symbols.join(',');
    const options = {
        params: {
            base,
            symbols: urlSymbols,
        },
    };
    const { data } = await axios.get(`${url}/${action}`, options);

    return data;
};

/**
 *  Foreign exchange rates API with currency conversion
 *
 * @description Exchange rates API is a free service for current and historical foreign exchange rates published by the European Central Bank
 * @export
 * @class exchangeratesApi
 */
export default class exchangeratesApi {
    /**
     * Get the latest foreign exchange reference rates.
     *
     * @param {code[]} symbols
     * @param {code} base
     * @returns {Promise<apiResponse>}
     * @memberof exchangeratesApi
     */
    async latest(symbols: code[], base: code): Promise<apiResponse> {
        return await exchangeratesApiRequest('latest', symbols, base);
    };

    /**
     * Get historical rates for any day since 1999.
     *
     * @param {code[]} symbols
     * @param {code} base
     * @returns {Promise<apiResponse>}
     * @memberof exchangeratesApi
     */
    async general (symbols: code[], base: code): Promise<apiResponse> {
        return await exchangeratesApiRequest('', symbols, base);
    };

    /**
     * Get historical rates for a time period.
     *
     * @param {code[]} symbols
     * @param {code} base
     * @returns {Promise<apiResponse>}
     * @memberof exchangeratesApi
     */
    async history(symbols: code[], base: code): Promise<apiResponse> {
        return await exchangeratesApiRequest('history', symbols, base);
    };
};