An R Client for the "Fixer.io" Currency API

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. The full API documentation is available at < https://fixer.io/documentation>.


License:MIT CRAN_Status_Badge GitHubtag Travis-CI BuildStatus AppVeyor BuildStatus CoverageStatus DOI

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:

  • Current exchange rates, accessed using fixer_latest() (available with free account)
  • Historical exchange rates on a given date, using fixer_historical() (available on all paid accounts)
  • Conversion from one currency to another, either currently or on a specific date, using fixer_convert() (available on all paid accounts)
  • A time series of up to 365 days showing daily exchange rates over that time, using fixer_time_series() (available on “professional” and higher grade accounts)
  • Exchange rate fluctuations over a period of up to 365 days, using fixer_fluctuation() (available on “professional plus” and “enterprise” grade accounts)

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},
  }

News

fixerapi 0.1.6

  • Fixed #1, where ifelse() stripping attributes from variables caused errors in fixer_historical().

  • Added error messages to fixer_convert() for amounts >=100,000 and <=0.

  • Added conversion from UNIX time to yyyy-mm-dd HH:mm:ss for fixer_convert().

  • Improved date handling in fixer_fluctuation() and fixer_time_series().

  • Increased test scenarios.

fixerapi 0.1.5

  • Fixed bug with fixer_convert() data parameter.

  • Improved code coverage and documentation

  • fixer_account_type() now sets account type as "free" unless "paid" is used as a parameter, rather than giving an error.

fixerapi 0.1.4

  • Fixed account type missing bug with HTTPS

fixerapi 0.1.3

  • Removed need to declare account type

  • Fixed error that broke entire fixer_convert() function

fixerapi 0.1.2

  • Included proper citation information

  • Fixed some spelling mistakes and improved clarity of vignette text

fixerapi 0.1.1

  • Fixed name and description to comply with CRAN policies.

fixerapi 0.1.0

  • First package release.

  • Added a NEWS.md file to track changes to the package.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("fixerapi")

0.1.6 by Evan Odell, 10 months ago


https://docs.evanodell.com/fixerapi


Report a bug at https://github.com/evanodell/fixerapi/issues


Browse source code at https://github.com/cran/fixerapi


Authors: Evan Odell [aut, cre]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports jsonlite, tibble, tidyr

Suggests testthat, covr, knitr, rmarkdown


See at CRAN