coinmarketcap_id_map {cryptotrackr}

coinmarketcap_id_map

Description

coinmarketcap_id_map

Usage

coinmarketcap_id_map(
  api_key,
  listing_status = "active",
  start = "1",
  limit = NULL,
  sort = "id",
  symbol = NULL,
  aux = "platform,first_historical_data,last_historical_data,is_active,status",
  timeout_seconds = 60
)

Arguments

api_key

your CoinMarketCap API key

listing_status

you can choose "active", "inactive", or "untracked". Multiple options can be passed if they are comma-separated. Choosing "active" will return only active cryptocurrencies. Choosing "inactive" will return cryptocurrencies which are inactive. Choosing "untracked" will return a list of cryptocurrencies which are listed by CoinMarketCap but do not yet meet their methodology requirements to have tracked markets available. The default is "active".

start

you can use this parameter to offset your first result. The default value is "1".

limit

an optional string value between 1 and 5000 which tells CoinMarketCap how many results to return. The default value is NULL.

sort

the field used to sort your results. The two acceptable values are "id" and "cmc_rank". The default value is "id".

symbol

Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. The default value is NULL.

aux

Optionally specify a comma-separated list of supplemental data fields to return. Pass "platform,first_historical_data,last_historical_data, is_active,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 dataframe which includes the id mapping for CoinMarketCap cryptocurrencies along with other metadata related to the currencies.

Examples

## Not run: 
api_key <- "..."
id_map <- coinmarketcap_id_map(api_key)
## End(Not run)