README.md

In raybuhr/freeCurrencyApiR: R friendly interface for https://free.currencyconverterapi.com API

freeCurrencyApiR

freeCurrencyApiR provides functions for getting current and historical currency exchange rates. Please refer to The Free Currency Converter API https://free.currencyconverterapi.com for all endpoints available and rate limits.

From the website:

Rate Limits of the Free API
Conversion Pairs per Request: 2
Number of Requests per Hour: 100
Date Range in History: 8 Days
Allowed Back in History: 1 Year(s)

Currency values are updated every 60 minutes. 
If you need a realtime web service or a service that updates more frequently, 
you may checkout the premium service at CurrencyConverterAPI.com.

Install

devtools::install_github("raybuhr/freeCurrencyApiR")

Setup

This is only required once, right after install.

You will need to signup to get an API key. Once you get the email with your key and confirm your email address by clicking through the included link, add this key to your .Renviron. If you are unfamiliar with this, you can run

usethis::edit_r_environ()

This will open up the .Renviron file for you to edit. Add a new line like this

FREE_CURRENCY_API_KEY=c224f8b5ee2f30e42256

Restart your R Session.

Examples

Get lists of the countries and currencies available:

currencies <- free_currency_api_list_currencies()
currencies$results[[1]]

## $currencyName
## [1] "Albanian Lek"
## 
## $currencySymbol
## [1] "Lek"
## 
## $id
## [1] "ALL"

countries <- free_currency_api_list_countries()
countries$results[[42]]

## $alpha3
## [1] "ARG"
## 
## $currencyId
## [1] "ARS"
## 
## $currencyName
## [1] "Argentine peso"
## 
## $currencySymbol
## [1] "$"
## 
## $id
## [1] "AR"
## 
## $name
## [1] "Argentina"

Get the current exchange rate between two currencies (based on a 60 minute refresh cache):

free_currency_api_get_current(currency_from = "USD", currency_to = "CNY", compact = "ultra")

## $USD_CNY
## [1] 6.714204

Get a data.frame of daily historical exchange rates between two currencies (No idea when the daily rate snapshot is taken):

free_currency_api_get_historical(
  currency_from = "USD", currency_to = "INR", 
  start_date = "2018-04-01", end_date = "2018-04-08"
)

##         date from  to   rate
## 1 2018-04-01  USD INR 65.110
## 2 2018-04-02  USD INR 65.120
## 3 2018-04-03  USD INR 64.989
## 4 2018-04-04  USD INR 65.039
## 5 2018-04-05  USD INR 64.880
## 6 2018-04-06  USD INR 64.920
## 7 2018-04-07  USD INR 64.920
## 8 2018-04-08  USD INR 64.920

Bugs/Issues

Report at https://github.com/raybuhr/freeCurrencyApiR/issues

Contributing

Feel free to provide pull requests!

raybuhr/freeCurrencyApiR documentation built on May 23, 2019, 2:48 p.m.