Package 'crypto2'

Get historic crypto currency market data from CoinGecko

Description

Companion to crypto_history() but for CoinGecko. Returns daily OHLC, volume, and market-cap timeseries in a tibble whose column names match the crypto2 CMC output.

Usage

cg_history(
  coin_list = NULL,
  convert = "USD",
  limit = NULL,
  start_date = NULL,
  end_date = NULL,
  interval = NULL,
  requestLimit = 400,
  sleep = 0,
  wait = 60,
  finalWait = FALSE,
  single_id = TRUE,
  date_convention = c("end_of_day", "raw")
)

Arguments

coin_list	string if NULL retrieve all currently existing coins (cg_list()), or provide list of crypto currencies in the cg_list() / cg_listings() format.
convert	(default: "USD"). Be aware that the CoinGecko free tier typically supports only "USD" and "BTC" reliably.
limit	integer Return the top n records, default is all tokens.
start_date, end_date	date Filter the returned timeseries to this date window after fetching.
interval	string Always coerced to "daily" – CoinGecko website endpoints return daily granularity for full-history pulls. Hourly is not available without an API key.
requestLimit	Kept for parity with crypto_history() – ignored (CoinGecko returns full history per coin in one call).
sleep	integer (default 0) Seconds to sleep between API requests. The internal client enforces a polite floor to stay within CoinGecko's per-minute budget.
wait	waiting time before retry in case of fail (default 60).
finalWait	Sleep 60s after the last call (mirrors crypto_history()).
single_id	Kept for parity with crypto_history() – ignored; CoinGecko endpoints are always single-coin per call.
date_convention	Either "end_of_day" (the default) or "raw". CoinGecko's native daily series timestamps each point at 00:00:00 UTC of date X, which is the same physical instant as 23:59:59 UTC of date X-1 – i.e. CG labels it as the start-of-day rather than the close-of-day. CMC (and crypto_history()) label that instant as date X-1 (the day that just ended), which is also the standard asset-pricing convention used by CRSP/Compustat and major academic datasets. With "end_of_day" (default) cg_history() shifts CG's midnight ticks by -1 day so close[X] / close[X-1] - 1 is the return earned during date X, matching CMC. Pass "raw" to keep CG's native start-of-day labelling.

Details

No API key is required. When the requested coin's numeric id is missing in coin_list, cg_id_mapping() is consulted to recover it. If a coin cannot be resolved at all, it is silently skipped.

Free-tier coverage: close, volume and market cap are returned for the full lifetime of each coin – typically from the coin's listing date forward. The OHLC quartet (open / high / low) is capped at the most recent 365 days on the free tier; for older windows those three columns come back NA while close remains populated from the price stream. For a one-shot complete backfill of OHLC over the full history see vignette("coingecko-pro-backfill").

Value

Crypto currency historic OHLC market data in a tibble:

id	CoinGecko internal numeric id (NA if unknown).
slug, name, symbol	Coin identifiers.
timestamp	POSIXct (UTC), midnight of the trading day.
ref_cur_id	Quote currency code (e.g. "usd").
ref_cur_name	Upper-cased quote currency.
open, high, low, close	Daily OHLC; close is back-filled from the price-charts series when OHLC candles are unavailable.
volume	Daily total volume.
market_cap	Daily market cap.
time_open, time_high, time_low, time_close	NA – CoinGecko does not expose intra-day OHLC timestamps in these endpoints.

Examples

## Not run: 
# Top 50 by market cap, full available history
top50 <- cg_list()[1:50, ]
hist  <- cg_history(top50)

# Bitcoin only, last year
btc <- cg_history(cg_list()[1, ],
                  start_date = Sys.Date() - 365,
                  end_date   = Sys.Date())

## End(Not run)

---

Fetch CoinGecko history by numeric ID (incl. partial survivorship-bias correction)

Description

Companion to cg_history() that addresses coins by their numeric CoinGecko ID instead of their slug. Useful in two scenarios:

Usage

cg_history_by_id(
  ids = NULL,
  what = c("price", "market_cap", "ohlc"),
  vs_currency = "usd",
  start_date = NULL,
  end_date = NULL,
  coin_list = NULL,
  sleep = 0.6,
  wait = 60,
  max_retries = 3,
  quiet = FALSE,
  finalWait = FALSE,
  date_convention = c("end_of_day", "raw")
)

Arguments

ids	Integer vector of numeric IDs to fetch. Default NULL -> uses cg_list()$id (active universe). To extend coverage to delisted coins, supply the union of historically-observed IDs from your accumulated snapshots.
what	Subset of streams to fetch. Any combination of "price", "market_cap", and "ohlc". Default all three.
vs_currency	Quote currency, default "usd".
start_date, end_date	Client-side date filter applied after fetch. NULL returns full history.
coin_list	Optional cg_list() output used to join slug / name / symbol onto recovered rows for coins still in the active universe. If NULL, calls cg_list() automatically. Set to FALSE to skip the join (rows then have only id).
sleep, wait, max_retries	Rate-limit knobs. Defaults 0.6 / 60 / 3 match cg_history().
quiet	If FALSE, prints a progress bar.
finalWait	Sleep 60 s after the last call (mirrors crypto_history()).
date_convention	Either "end_of_day" (the default) or "raw". See cg_history() for the explanation – this argument applies the same -1 day shift to midnight-UTC ticks so dates align with the CMC / CRSP / Compustat end-of-day convention.

Details

1. Coins that have been delisted and whose slug no longer resolves.

2. Cronjob-style accumulation: when you persist cg_list() snapshots over time, the union of all numeric IDs ever observed is the survivorship-bias-corrected universe. cg_history_by_id() lets you refetch each historical ID directly without needing its current slug to still resolve.

Important caveats – please read:

• The numeric-ID space is sparse, not dense. Blind iteration over 1:N does NOT recover the full universe – most numeric IDs in that range have no data. The default ids = NULL therefore uses the active universe from cg_list(), not a numeric range. To recover delisted coins you must supply the IDs explicitly (e.g., the union of accumulated cg_list() snapshots, or the historic mapping from cg_id_mapping()).

• Slug recovery for delisted coins is not generally available on the free tier. Active coins get their slug/name joined back in from cg_list(); rows whose numeric ID is no longer in the active universe come back with slug = NA and name = NA. Use the id column as the join key in downstream code. For a one-shot complete recovery of the full historic universe see vignette("coingecko-pro-backfill").

Value

Tibble with one row per (id, date) using crypto2-compatible column names. Columns:

id	CoinGecko numeric id (always populated).
slug, name, symbol	Coin identifiers – NA for ids no longer in the active universe (i.e. delisted on the slug side).
timestamp	POSIXct UTC midnight of the trading day.
ref_cur_id, ref_cur_name	Quote currency.
open, high, low, close, volume, market_cap	Daily values.

Examples

## Not run: 
# Scan first 200 numeric IDs (will include both active and delisted coins)
h <- cg_history_by_id(ids = 1:200, what = c("price", "market_cap"))

# Full sweep -- survivorship-bias-free price history of the entire
# CoinGecko universe. Slow (10+ hours). Run via cronjob package.
h_all <- cg_history_by_id()

## End(Not run)

---

Historic CoinGecko id/slug mapping (incl. delisted coins)

Description

The free CoinGecko API only exposes coins currently tracked, so coins that get delisted after their listing day disappear from ⁠/coins/list⁠. A separate, periodically updated archive of ⁠(numeric_id, slug, symbol, name, harvested_at)⁠ rows is hosted at a stable companion location. This function downloads and caches it so callers (e.g. cg_list(), cg_history()) can transparently fall back to historic identifiers without ceremony.

Usage

cg_id_mapping(refresh = FALSE, quiet = FALSE)

Arguments

refresh	Force re-download even if a cached file exists in tempdir(). Default FALSE.
quiet	Suppress the one-line "historic data current until ..." message. Default FALSE.

Details

The mapping is fetched once per session and cached in tempdir(). If the network is unavailable, a small bundled sample of reference coins is used as a fallback. When quiet = FALSE (default), a single one-line message is emitted on first successful download stating the harvest date.

Value

Tibble with columns id (integer numeric CoinGecko id), slug (character), symbol (character), name (character), harvested_at (Date) – one row per historic coin. Returns an empty tibble with the correct schema if neither the network mapping nor the bundled sample can be loaded.

Examples

## Not run: 
mapping <- cg_id_mapping()
delisted <- dplyr::anti_join(mapping,
  cg_list() %>% dplyr::select(slug), by = "slug")

## End(Not run)

---

Retrieve per-coin metadata from CoinGecko (CMC-compatible columns)

Description

Companion to crypto_info() but for CoinGecko. Pulls descriptive metadata (description, categories, logos, contract addresses across chains, links) for each coin in coin_list. Uses the documented public API endpoint api.coingecko.com/api/v3/coins/{slug} (no key required; ~30 req/min).

Usage

cg_info(
  coin_list = NULL,
  limit = NULL,
  requestLimit = 1,
  sleep = 0,
  finalWait = FALSE
)

Arguments

coin_list	string if NULL retrieve all currently existing coins (cg_list()), or provide list of cryptocurrencies in the cg_list() / cg_listings() format.
limit	integer Return the top n records, default is all tokens.
requestLimit	Kept for parity with crypto_info() – ignored (CoinGecko endpoint is one coin per call).
sleep	integer (default 0) Seconds to sleep between API requests. The internal client enforces a polite floor (default ⁠2.5s⁠) to stay under the Demo-tier 30 req/min cap.
finalWait	Sleep 60s after the last call (mirrors crypto_info()).

Details

Column names mirror crypto_info() where there is a direct equivalent, and add a few CG-specific fields (platforms, categories).

Value

Tibble with one row per coin:

id	CoinGecko internal numeric id (from image$thumb).
name, symbol, slug	Coin identifiers.
category	"coin" if asset_platform_id is NA, else "token".
description	English description (HTML stripped to text).
logo	URL of the large coin logo.
status	Status notice from CoinGecko (public_notice field).
notice	Additional notices (additional_notices joined).
date_added	Date the coin was added to CoinGecko (genesis_date when set, else NA).
date_launched	Same as date_added for CG (no separate launch field exposed).
categories	List-column of coin categories.
platforms	List-column: per-chain contract addresses.
web_slug	CoinGecko canonical web slug (sometimes differs from API slug).
country_origin	Country of project origin (often empty).
sentiment_votes_up_percentage, sentiment_votes_down_percentage	Community sentiment percentages.
watchlist_portfolio_users	Number of CG users watching this coin.
url	List-column of resource URLs (homepage, whitepaper, blockchain explorers, forums, repos, chats, announcements, subreddit, twitter).

Examples

## Not run: 
info <- cg_info(cg_list(top_n = 50))

## End(Not run)

---

Retrieves name, CG id, symbol, slug, rank, an activity flag as well as activity dates on CoinGecko for all coins

Description

Companion to crypto_list() but for CoinGecko. Returns the active universe as a tibble using the same column conventions as crypto_list(), so downstream code that consumes a CMC coin list also consumes this one.

Usage

cg_list(only_active = TRUE, add_untracked = FALSE)

Arguments

only_active	Shall the code only retrieve active coins (TRUE = default) or include historically-known but currently-inactive coins (FALSE)? When FALSE, cg_id_mapping() is consulted for the extra slugs.
add_untracked	Kept for API parity with crypto_list() – CoinGecko does not have an "untracked" listing status, so the argument is silently ignored.

Details

Because CoinGecko prunes delisted coins from its public database, the free-tier API alone only returns coins currently active on the platform. When only_active = FALSE, the function transparently merges in historically-known coins via cg_id_mapping(); a single one-line message is emitted indicating how current that mapping is.

Value

List of (active and historically existing) cryptocurrencies in a tibble:

id	CoinGecko internal numeric id (unique identifier).
name	Coin name.
symbol	Coin symbol (not-unique).
slug	CoinGecko URL slug (unique).
rank	Current market-cap rank on CoinGecko (NA for delisted or unranked coins).
is_active	Flag showing whether the coin is currently active (1) or only historically present (0).
first_historical_data	First time listed on CoinGecko (currently only populated for coins present in the historic mapping).
last_historical_data	Last time listed on CoinGecko, today's date if still active.

Rate-limiting and retry parameters can be overridden globally via the package options crypto2.cg_sleep, crypto2.cg_wait, crypto2.cg_max_retries (defaults: 2.5s between calls, 60s wait before retry, 3 retries on rate-limit / network failure).

Examples

## Not run: 
# all coins currently tracked by CoinGecko
active_list <- cg_list(only_active = TRUE)

# active + historically-listed coins (uses cg_id_mapping())
full_list <- cg_list(only_active = FALSE)

## End(Not run)

---

Retrieves name, CG id, symbol, slug, rank, and quote data for current listings (CoinGecko)

Description

Companion to crypto_listings() but for CoinGecko. Returns one row per coin with current price/volume/market-cap fields plus percent-change windows. Column names mirror those of crypto_listings() so downstream code that already consumes a CMC listings tibble works on this tibble too.

Usage

cg_listings(
  which = "latest",
  convert = "USD",
  limit = 5000,
  start_date = NULL,
  end_date = NULL,
  interval = "day",
  quote = FALSE,
  sort = "cmc_rank",
  sort_dir = "asc",
  sleep = 0,
  wait = 60,
  finalWait = FALSE
)

Arguments

which	Always "latest" for CoinGecko free-tier. Other values produce a warning and are coerced to "latest".
convert	string (default: "USD"). The value is lower-cased and passed to CoinGecko as vs_currency. Common values: "USD", "BTC", "ETH", "EUR", "GBP".
limit	integer Return the top n records (default 5000 – matches crypto_listings()).
start_date, end_date, interval	Kept for API parity with crypto_listings() – ignored for CoinGecko (no historical-listings endpoint on the free tier).
quote	logical Kept for API parity. The CoinGecko ⁠/coins/markets⁠ endpoint always returns prices, so quote fields are always present; setting this to FALSE drops them from the returned tibble for parity with crypto_listings().
sort, sort_dir	Kept for parity. CoinGecko sorts by market_cap_desc on the underlying endpoint; the arguments are ignored.
sleep	integer (default 0) Seconds to sleep between API requests. Will be raised to at least 2.5 internally to stay under the Demo-tier 30 req/min cap.
wait	Seconds to wait before retrying after a 429 (default 60).
finalWait	Sleep 60s after the last call (mirrors crypto_listings()).

Details

CoinGecko free-tier limitations: only which = "latest" is supported. which = "historical" and which = "new" produce a warning and are coerced to "latest", because CoinGecko's free tier does not expose the historical cross-section. Snapshot this function periodically (daily / weekly via a cron job) to accumulate a survivorship-bias-corrected archive over time.

Value

Tibble with columns matching crypto_listings() where the corresponding CoinGecko field exists. See crypto_listings() for the column glossary; CoinGecko-specific extras (e.g. ath, atl) are appended at the end.

Examples

## Not run: 
# Full current snapshot (all coins with a market cap)
latest <- cg_listings(which = "latest", quote = TRUE)

# Top 1000 in BTC
latest_btc <- cg_listings(which = "latest", convert = "BTC", limit = 1000)

## End(Not run)

---

Retrieves historical quotes for the global aggregate market

Description

This code retrieves global quote data (latest/historic) from coinmarketcap.com.

Usage

crypto_global_quotes(
  which = "latest",
  convert = "USD",
  start_date = NULL,
  end_date = NULL,
  interval = "daily",
  quote = FALSE,
  requestLimit = 2200,
  sleep = 0,
  wait = 60,
  finalWait = FALSE
)

Arguments

which	string Shall the code retrieve the latest listing or a historic listing?
convert	string (default: USD) to one or more of available fiat or precious metals prices (fiat_list()). If more than one are selected please separate by comma (e.g. "USD,BTC"), only necessary if 'quote=TRUE'
start_date	string Start date to retrieve data from, format 'yyyymmdd'
end_date	string End date to retrieve data from, format 'yyyymmdd', if not provided, today will be assumed
interval	string Interval with which to sample data, default 'daily'. Must be one of ⁠"1d" "2d" "3d" "15d" "30d" "60d"⁠
quote	logical set to TRUE if you want to include price data (FALSE=default)
requestLimit	integer (default 2200) Maximum number of requests one API call can handle
sleep	integer (default 0) Seconds to sleep between API requests
wait	waiting time before retry in case of fail (needs to be larger than 60s in case the server blocks too many attempts, default=60)
finalWait	to avoid calling the web-api again with another command before 60s are over (TRUE=default)

Value

List of latest/new/historic listings of crypto currencies in a tibble (depending on the "which"-switch and whether "quote" is requested, the result may only contain some of the following variables):

btc_dominance	number Bitcoin's market dominance percentage by market cap.
eth_dominance	number Ethereum's market dominance percentage by market cap.
active_cryptocurrencies	number Count of active crypto currencies tracked by CMC This includes all crypto currencies with a listing_status of "active" or "listed".
total_cryptocurrencies	number Count of all crypto currencies tracked by CMC This includes "inactive" listing_status crypto currencies.
active_market_pairs	number Count of active market pairs tracked by CoinMarketCap across all exchanges.

#'

active_exchanges	number Count of active exchanges tracked by CMC This includes all exchanges with a listing_status of "active" or "listed".
total_exchanges	number Count of all exchanges tracked by CMC This includes "inactive" listing_status exchanges.
last_updated	Timestamp of when this record was last updated.
total_market_cap	number The sum of all individual cryptocurrency market capitalizations in the requested currency.
total_volume_24h	number The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all crypto currencies in the requested currency.
total_volume_24h_reported	number The sum of rolling 24 hour reported volume for all crypto currencies in the requested currency.

#'

altcoin_volume_24h	number The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all crypto currencies excluding Bitcoin in the requested currency.
altcoin_volume_24h_reported	number The sum of rolling 24 hour reported volume for all crypto currencies excluding Bitcoin in the requested currency.
altcoin_market_cap	number The sum of all individual cryptocurrency market capitalizations excluding Bitcoin in the requested currency.

Examples

## Not run: 
# return new listings from the last 30 days
new_quotes <- crypto_global_quotes(which="latest", quote=TRUE, convert="BTC")
# return all global quotes in the first week of January 2014
quotes_2014w1 <- crypto_global_quotes(which="historical", quote=TRUE,
  start_date = "20140101", end_date="20140107", interval="daily")

# report in two different currencies
listings_2014w1_USDBTC <- crypto_global_quotes(which="historical", quote=TRUE,
  start_date = "20200101", end_date="20240530", interval="daily", convert="BTC")

## End(Not run)

---

Get historic crypto currency market data

Description

Scrape the crypto currency historic market tables from 'CoinMarketCap' https://coinmarketcap.com and display the results in a dataframe/tibble. This can be used to conduct analysis on the crypto financial markets or to attempt to predict future market movements or trends.

Usage

crypto_history(
  coin_list = NULL,
  convert = "USD",
  limit = NULL,
  start_date = NULL,
  end_date = NULL,
  interval = NULL,
  requestLimit = 400,
  sleep = 0,
  wait = 60,
  finalWait = FALSE,
  single_id = TRUE
)

Arguments

coin_list	string if NULL retrieve all currently existing coins (crypto_list()), or provide list of crypto currencies in the crypto_list() or cryptoi_listings() format (e.g. current and/or dead coins since 2015)
convert	(default: USD) to one of available fiat prices (fiat_list()) or bitcoin 'BTC'. Be aware, that since 2024 only USD and BTC are available here!
limit	integer Return the top n records, default is all tokens
start_date	date Start date to retrieve data from
end_date	date End date to retrieve data from, if not provided, today will be assumed
interval	string Interval with which to sample data according to what seq() needs
requestLimit	limiting the length of request URLs when bundling the api calls
sleep	integer (default 60) Seconds to sleep between API requests
wait	waiting time before retry in case of fail (needs to be larger than 60s in case the server blocks too many attempts, default=60)
finalWait	to avoid calling the web-api again with another command before 60s are over (TRUE=default)
single_id	Download data coin by coin (as of May 2024 this is necessary)

Value

Crypto currency historic OHLC market data in a dataframe and additional information via attribute "info":

timestamp	Timestamp of entry in database
id	Coin market cap unique id
name	Coin name
symbol	Coin symbol
ref_cur_id	reference Currency id
ref_cur_name	reference Currency name
open	Market open
high	Market high
low	Market low
close	Market close
volume	Volume 24 hours
market_cap	Market cap - close x circulating supply
time_open	Timestamp of open
time_close	Timestamp of close
time_high	Timestamp of high
time_low	Timestamp of low

This is the main function of the crypto package. If you want to retrieve ALL active coins then do not pass an argument to crypto_history(), alternatively pass the coin name.

Examples

## Not run: 

# Retrieving market history for ALL crypto currencies
all_coins <- crypto_history(limit = 2)
one_coin <- crypto_history(limit = 1, convert="BTC")

# Retrieving market history since 2020 for ALL crypto currencies
all_coins <- crypto_history(start_date = '2020-01-01',limit=10)

# Retrieve 2015 history for all 2015 crypto currencies
coin_list_2015 <- crypto_list(only_active=TRUE) %>%
              dplyr::filter(first_historical_data<="2015-12-31",
              last_historical_data>="2015-01-01")
coins_2015 <- crypto_history(coin_list = coin_list_2015,
              start_date = "2015-01-01", end_date="2015-12-31", limit=20, interval="30d")
# retrieve hourly bitcoin data for 2 days
btc_hourly <- crypto_history(coin_list = coin_list_2015,
              start_date = "2015-01-01", end_date="2015-01-03", limit=1, interval="1h")


## End(Not run)

---

Retrieves info (urls, logo, description, tags, platform, date_added, notice, status,...) on CMC for given id

Description

This code retrieves data for all specified coins!

Usage

crypto_info(
  coin_list = NULL,
  limit = NULL,
  requestLimit = 1,
  sleep = 0,
  finalWait = FALSE
)

Arguments

coin_list	string if NULL retrieve all currently active coins (crypto_list()), or provide list of cryptocurrencies in the crypto_list() or cryptoi_listings() format (e.g. current and/or dead coins since 2015)
limit	integer Return the top n records, default is all tokens
requestLimit	(default: 1) limiting the length of request URLs when bundling the api calls (currently needs to be 1)
sleep	integer (default: 0) Seconds to sleep between API requests
finalWait	to avoid calling the web-api again with another command before 60s are over (FALSE=default)

Value

List of (active and historically existing) cryptocurrencies in a tibble:

id	CMC id (unique identifier)
name	Coin name
symbol	Coin symbol (not-unique)
slug	Coin URL slug (unique)
category	Coin category: "token" or "coin"
description	Coin description according to CMC
logo	CMC url of CC logo
status	Status message from CMC
notice	Markdown formatted notices from CMC
alert_type	Type of alert on CMC
alert_link	Message link to alert
date_added	Date CC was added to the CMC database
date_launched	Date CC was launched
is_audited	Boolean if CC is audited
flags	Boolean flags for various topics
self_reported_circulating_supply	Self reported circulating supply
tags	Tibble of tags and tag categories
faq_description	FAQ description from CMC
url	Tibble of various resource urls. Gives website, technical_doc (whitepaper), source_code, message_board, chat, announcement, reddit, twitter, (block) explorer urls
platform	Metadata about the parent coin if available. Gives id, name, symbol, slug, and token address according to CMC

Examples

## Not run: 
# return info for bitcoin
coin_info <- crypto_info(limit=10)

## End(Not run)

---

Retrieves name, CMC id, symbol, slug, rank, an activity flag as well as activity dates on CMC for all coins

Description

This code uses the web api. It retrieves data for all historic and all active coins and does not require an 'API' key.

Usage

crypto_list(only_active = TRUE, add_untracked = FALSE)

Arguments

only_active	Shall the code only retrieve active coins (TRUE=default) or include inactive coins (FALSE)
add_untracked	Shall the code additionally retrieve untracked coins (FALSE=default)

Value

List of (active and historically existing) cryptocurrencies in a tibble:

id	CMC id (unique identifier)
name	Coin name
symbol	Coin symbol (not-unique)
slug	Coin URL slug (unique)
rank	Current rank on CMC (if still active)
is_active	Flag showing whether coin is active (1), inactive(0) or untracked (-1)
first_historical_data	First time listed on CMC
last_historical_data	Last time listed on CMC, today's date if still listed

Examples

## Not run: 
# return all coins
active_list <- crypto_list(only_active=TRUE)
all_but_untracked_list <- crypto_list(only_active=FALSE)
full_list <- crypto_list(only_active=FALSE,add_untracked=TRUE)

# return all coins active in 2015
coin_list_2015 <- active_list %>%
dplyr::filter(first_historical_data<="2015-12-31",
              last_historical_data>="2015-01-01")

## End(Not run)

---

Retrieves name, CMC id, symbol, slug, rank, an activity flag as well as activity dates on CMC for all coins

Description

This code retrieves listing data (latest/new/historic).

Usage

crypto_listings(
  which = "latest",
  convert = "USD",
  limit = 5000,
  start_date = NULL,
  end_date = NULL,
  interval = "day",
  quote = FALSE,
  sort = "cmc_rank",
  sort_dir = "asc",
  sleep = 0,
  wait = 60,
  finalWait = FALSE
)

Arguments

which	string Shall the code retrieve the latest listing, the new listings or a historic listing?
convert	string (default: USD) to one of available fiat prices (fiat_list()). If more than one are selected please separate by comma (e.g. "USD,BTC"), only necessary if 'quote=TRUE'
limit	integer Return the top n records
start_date	string Start date to retrieve data from, format 'yyyymmdd'
end_date	string End date to retrieve data from, format 'yyyymmdd', if not provided, today will be assumed
interval	string Interval with which to sample data according to what seq() needs
quote	logical set to TRUE if you want to include price data (FALSE=default)
sort	(May 2024: currently not available) string use to sort results, possible values: "name", "symbol", "market_cap", "price", "circulating_supply", "total_supply", "max_supply", "num_market_pairs", "volume_24h", "volume_7d", "volume_30d", "percent_change_1h", "percent_change_24h", "percent_change_7d". Especially useful if you only want to download the top x entries using "limit" (deprecated for "new")
sort_dir	(May 2024: currently not available) string used to specify the direction of the sort in "sort". Possible values are "asc" (DEFAULT) and "desc"
sleep	integer (default 0) Seconds to sleep between API requests
wait	waiting time before retry in case of fail (needs to be larger than 60s in case the server blocks too many attempts, default=60)
finalWait	to avoid calling the web-api again with another command before 60s are over (TRUE=default)

Value

List of latest/new/historic listings of cryptocurrencies in a tibble (depending on the "which"-switch and whether "quote" is requested, the result may only contain some of the following variables):

id	CMC id (unique identifier)
name	Coin name
symbol	Coin symbol (not-unique)
slug	Coin URL slug (unique)
date_added	Date when the coin was added to the dataset
last_updated	Last update of the data in the database
rank	Current rank on CMC (if still active)
market_cap	market cap - close x circulating supply
market_cap_by_total_supply	market cap - close x total supply
market_cap_dominance	market cap dominance
fully_diluted_market_cap	fully diluted market cap
self_reported_market_cap	is the source of the market cap self-reported
self_reported_circulating_supply	is the source of the circulating supply self-reported
tvl_ratio	percentage of total value locked
price	latest average price
circulating_supply	approx. number of coins in circulation
total_supply	approx. total amount of coins in existence right now (minus any coins that have been verifiably burned)
max_supply	CMC approx. of max amount of coins that will ever exist in the lifetime of the currency
num_market_pairs	number of market pairs across all exchanges this coin
tvl	total value locked
volume_24h	Volume 24 hours
volume_change_24h	Volume change in 24 hours
percent_change_1h	1 hour return
percent_change_24h	24 hour return
percent_change_7d	7 day return
percent_change_30d	30 day return
percent_change_60d	60 day return
percent_change_90d	90 day return

Examples

## Not run: 
# return new listings from the last 30 days
new_listings <- crypto_listings(which="new", quote=FALSE, limit=50000)
new_listings2 <- crypto_listings(which="new", quote=TRUE, convert="BTC")

# return latest listing (last available data of all CC including quotes)
latest_listings <- crypto_listings(which="latest", quote=FALSE, limit=50000)
latest_listings2 <- crypto_listings(which="latest", quote=TRUE, convert="BTC")

# return the first 10 listings in the first week of January 2024
listings_2024w1 <- crypto_listings(which="historical", quote=TRUE,
      start_date = "20240101", end_date="20240102", interval="day", limit=10)

# only download the top 10 crypto currencies based on their market capitalization
# DOES NOT WORK ANY MORE

# for historically accurate snapshots (e.g. for backtesting crypto investments)
# you need to download the entire history on one day including price information:
listings_20200202 <- crypto_listings(which="historical", quote=TRUE,
      start_date="20200202", end_date="20200202")
listings_20240202 <- crypto_listings(which="historical", quote=TRUE,
      start_date="20240202", end_date="20240202", limit=50000)
# note the much larger amount in CCs in 2024, as well as the existence of many
more variables in the dataset

## End(Not run)

---

Retrieves info (urls,logo,description,tags,platform,date_added,notice,status) on CMC for given exchange slug

Description

This code uses the web api. It retrieves data for all active, delisted and untracked exchanges! It does not require an 'API' key.

Usage

exchange_info(
  exchange_list = NULL,
  limit = NULL,
  requestLimit = 1,
  sleep = 0,
  finalWait = FALSE
)

Arguments

exchange_list	string if NULL retrieve all currently active exchanges (exchange_list()), or provide list of exchanges in the exchange_list() format (e.g. current and/or delisted)
limit	integer Return the top n records, default is all exchanges
requestLimit	limiting the length of request URLs when bundling the api calls
sleep	integer (default 60) Seconds to sleep between API requests
finalWait	to avoid calling the web-api again with another command before 60s are over (TRUE=default)

Value

List of (active and historically existing) exchanges in a tibble:

id	CMC exchange id (unique identifier)
name	Exchange name
slug	Exchange URL slug (unique)
description	Exchange description according to CMC
notice	Exchange notice (markdown formatted) according to CMC
logo	CMC url of CC logo
type	Type of exchange
date_launched	Launch date of this exchange
is_hidden	TBD
is_redistributable	TBD
maker_fee	Exchanges maker fee
taker_fee	Exchanges maker fee
platform_id	Platform id on CMC
dex_status	Decentralized exchange status
wallet_source_status	Wallet source status
status	Activity status on CMC
tags	Tibble of tags and tag categories
urls	Tibble of various resource urls. Gives website, blog, fee, twitter.
countries	Tibble of countries the exchange is active in
fiats	Tibble of fiat currencies the exchange trades in

Examples

## Not run: 
# return info for the first three exchanges
exchange_info <- exchange_info(limit=10)

## End(Not run)

---

Retrieves name, CMC id, symbol, slug, rank, an activity flag as well as activity dates on CMC for all coins

Description

This code uses the web api. It retrieves data for all historic and all active exchanges and does not require an 'API' key.

Usage

exchange_list(only_active = TRUE, add_untracked = FALSE)

Arguments

only_active	Shall the code only retrieve active exchanges (TRUE=default) or include inactive coins (FALSE)
add_untracked	Shall the code additionally retrieve untracked exchanges (FALSE=default)

Value

List of (active and historically existing) exchanges in a tibble:

id	CMC exchange id (unique identifier)
name	Exchange name
slug	Exchange URL slug (unique)
is_active	Flag showing whether exchange is active (1), inactive(0) or untracked (-1)
first_historical_data	First time listed on CMC
last_historical_data	Last time listed on CMC, today's date if still listed

Examples

## Not run: 
# return all exchanges
ex_active_list <- exchange_list(only_active=TRUE)
ex_all_but_untracked_list <- exchange_list(only_active=FALSE)
ex_full_list <- exchange_list(only_active=FALSE,add_untracked=TRUE)

## End(Not run)

---

Retrieves list of all CMC supported fiat currencies available to convert cryptocurrencies

Description

This code retrieves data for all available fiat currencies that are available on the website.

Usage

fiat_list(include_metals = FALSE)

Arguments

include_metals

Shall the results include precious metals (TRUE) or not (FALSE=default). Update: As of May 2024 no more metals are included in this file

Value

List of (active and historically existing) cryptocurrencies in a tibble:

id	CMC id (unique identifier)
symbol	Coin symbol (not-unique)
name	Coin name
sign	Fiat currency sign

Examples

## Not run: 
# return fiat currencies available through the CMC api
fiat_list <- fiat_list()

## End(Not run)

---