Package 'unirateapi'

Create a UniRate API client

Description

Constructs a client for the UniRate currency exchange rate API. The returned object is a list of functions (methods); call them with $, e.g. client$get_rate("USD", "EUR").

Usage

unirate_client(
  api_key,
  base_url = "https://api.unirateapi.com",
  timeout = 30,
  http_fetch = NULL
)

Arguments

api_key	Your UniRate API key. Get a free key at https://unirateapi.com.
base_url	API base URL. Defaults to "https://api.unirateapi.com".
timeout	Request timeout in seconds. Defaults to 30.
http_fetch	Optional fetch function for dependency injection (mainly for testing). It receives a single URL string and must return list(status = <integer>, body = <character>). Defaults to a curl-backed fetcher.

Value

A unirate_client object exposing the following methods:

get_rate(from = "USD", to = NULL, format = "json", callback = NULL)

Current exchange rate. Returns a single numeric when to is set, otherwise a named numeric vector of all rates for from.

convert(to, amount = 1, from = "USD", format = "json", callback = NULL)

Convert amount from one currency to another. Returns a numeric.

get_supported_currencies(format = "json", callback = NULL)

Character vector of supported currency codes.

get_historical_rate(date, amount = 1, from = "USD", to = NULL, format = "json", callback = NULL)

Historical rate/conversion on a date (Pro tier).

get_historical_rates(date, amount = 1, base = "USD", format = "json", callback = NULL)

All historical rates for a base on a date (Pro tier).

convert_historical(amount, from, to, date, format = "json", callback = NULL)

Convert using a historical rate (Pro tier).

get_time_series(start_date, end_date, amount = 1, base = "USD", currencies = NULL, format = "json", callback = NULL)

Time series of rates over a date range (Pro tier).

get_historical_limits(format = "json", callback = NULL)

Historical coverage per currency (Pro tier).

get_vat_rates(country = NULL, format = "json", callback = NULL)

VAT rates for all countries, or a single country when country is set.

get_vat_rate(country, format = "json", callback = NULL)

VAT data for a single country.

When format is not "json", methods return the raw response body as a character string.

Examples

## Not run: 
client <- unirate_client(Sys.getenv("UNIRATE_API_KEY"))
client$get_rate("USD", "EUR")
client$convert(to = "EUR", amount = 100, from = "USD")
client$get_supported_currencies()

## End(Not run)

---