get_pairs {cryptowatchR}

Get pair of currencies

Description

Get details on pairs of (crypto)currencies.

Usage

get_pairs(pair = NULL, api_key = NULL, allowance = FALSE)

Arguments

pair

A string containing a pair symbol, e.g. btcusd (optional argument). Run get_pairs() to get all available pairs of currencies.

api_key

A string containing the API key. See https://docs.cryptowat.ch/rest-api/rate-limit to learn how to create an account and how to generate an API key.

allowance

A logical (default is FALSE). If TRUE the function returns a list which includes allowance information, i.e. cost of the request, remaining credits and your account name.

Value

A list or data.frame containing data on pairs.

References

See https://docs.cryptowat.ch/rest-api for further information

See Also

get_markets, get_assets, get_exchanges

Examples

## Not run: 
# Get all available pairs of currencies
df.pairs <- get_pairs()
# Get details on the pair Bitcoin-USD
pair.btcusd <- get_pairs("btcusd")

## End(Not run)