License: MIT CRAN_Status_Badge GitHub tag Travis-CI Build Status AppVeyor Build Status Coverage Status DOI

fixerapi

fixerapi is an R client for the fixer.io currency conversion and exchange rate API. The API requires registration and some features are only available on paid accounts. Full API documentation is available here, and additional details are available in the vignette

Installation

To install from CRAN, use:

install.packages("fixerapi")

You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("evanodell/fixerapi")

Using fixerapi

To access a tibble with the name and currency symbol (a three letter code) for all currencies available through the API, use fixer_symbols().

There are five currency exchange query types, which fixer.io calls endpoints. They are:

With the exception of fixer_convert(), which is limited to two currencies, all functions give an option for a base currency that is indexed to 1 and other currencies are compared to – the default is the Euro – and to limit the currencies it is compared with, using the symbols parameter, which takes a character vector of currency symbols. If no symbols are specified, all available currencies are returned.

library(fixer)
today_symbols <- fixer_latest(base = "EUR", 
                              symbols = c("JPY", "GBP", "USD", "CAD", "CHF"))

print(today_symbols)

#> A tibble: 5 x 2
#>   name    value
#>   <chr>   <dbl>
#> 1 JPY   131.   
#> 2 GBP     0.873
#> 3 USD     1.23 
#> 4 CAD     1.57 
#> 5 CHF     1.18 

The example above shows some exchange rates on 2018-04-03.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

This project is not affiliated with or supported by fixer.io.

To cite package fixerapi in publications use:

Odell E (2018). fixerapi: An R Client for the “Fixer.io” Currency API. doi: 10.5281/zenodo.1211687 (URL: http://doi.org/10.5281/zenodo.1211687), R package version 0.1.6, <URL: https://docs.evanodell.com/fixerapi>.

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {{fixerapi}: An R Client for the "Fixer.io" Currency API},
    author = {Evan Odell},
    year = {2018},
    note = {R package version 0.1.6},
    doi = {10.5281/zenodo.1211687},
    url = {https://docs.evanodell.com/fixerapi},
  }