-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
99 lines (73 loc) · 4.41 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[](https://opensource.org/licenses/MIT)
[](https://cran.r-project.org/package=fixerapi)
[](https://github.com/evanodell/fixerapi)
[](https://dgrtwo.shinyapps.io/cranview/)
[](https://github.com/evanodell/fixerapi/actions)
[](https://ci.appveyor.com/project/evanodell/fixerapi)
[](https://codecov.io/github/evanodell/fixerapi?branch=master)
[](https://zenodo.org/badge/latestdoi/127822432)
<!-- badges: end -->
# fixerapi
`fixerapi` is an R client for the [fixer.io](https://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](https://fixer.io/documentation), and additional details are available in the [vignette](https://docs.evanodell.com/fixerapi/articles/introduction.html)
## Installation
To install from CRAN, use:
``` r
install.packages("fixerapi")
```
You can install the development version from [GitHub](https://github.com/) with:
``` r
# 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](https://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.
```{r example, eval=FALSE}
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](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
This project is not affiliated with or supported by [fixer.io](https://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},
}
```