coinmarketcap_metadata {cryptotrackr}

coinmarketcap_metadata

Description

coinmarketcap_metadata

Usage

coinmarketcap_metadata(
  api_key,
  id = NULL,
  slug = NULL,
  symbol = NULL,
  address = NULL,
  aux = "urls,logo,description,tags,platform,date_added,notice,status",
  timeout_seconds = 60
)

Arguments

api_key

your CoinMarketCap API key

id

the id of the asset you wish to query. The default value is NULL; however, each request must include either an id, slug, symbol, or contract address. You can also pass multiple comma-separated values.

slug

the slug of the asset you wish to query. The default value is NULL. You can also pass multiple comma-separated values.

symbol

the symbol of the asset you wish to query. The default value is NULL. You can also pass multiple comma-separated values.

address

the contract address of the asset you wish to query. The default calue is NULL. You can also pass multiple comma-separated values.

aux

Optionally specify a comma-separated list of supplemental data fields to return. Pass "urls,logo,description,tags,platform,date_added, notice,status" to include all auxiliary fields. This function will include all auxiliary fields by default.

timeout_seconds

seconds until the query times out. Default is 60.

Value

returns a list which includes a dataframe for each asset you requested. The dataframe will contain CoinMarketCap metadata for the asset.

Examples

## Not run: 
api_key <- "..."
metadata <- coinmarketcap_metadata(api_key, symbol = "BTC")
## End(Not run)