get_assets: Get asset details

View source: R/get_assets.R

get_assetsR Documentation

Get asset details

Description

Get asset information on cryptocurrencies.

Usage

get_assets(asset = NULL, api_key = NULL, allowance = FALSE)

Arguments

asset

A string containing an asset symbol, e.g. btc (optional argument). Run get_assets() to get all available assets.

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 assets.

References

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

See Also

get_markets, get_exchanges, get_pairs

Examples

## Not run: 
# Get all assets available on 'Cryptowatch'
df_assets <- get_assets()
# Bitcoin asset details
asset_btc <- get_assets("btc")

## End(Not run)


lorenzbr/cryptowatchR documentation built on April 15, 2022, 4:41 a.m.