Package {crypto2}

Title:	Download Crypto Currency Data from 'CoinMarketCap' and 'CoinGecko'
Version:	3.0.0
Date:	2026-10-07
Maintainer:	Sebastian Stoeckl <sebastian.stoeckl@uni.li>
URL:	https://github.com/sstoeckl/crypto2, https://www.sebastianstoeckl.com/crypto2/
Description:	Retrieves crypto currency information and historical prices as well as information on the exchanges they are listed on. Historical data contains daily open, high, low and close values for all crypto currencies. The package draws on two complementary sources: 'CoinMarketCap' https://coinmarketcap.com (primary, via the 'crypto_*' functions) and 'CoinGecko' https://www.coingecko.com (secondary, via the 'cg_*' functions). Both sources are queried without an 'API' key; the two function families return tibbles with identical column conventions so downstream pipelines work on either source.
License:	MIT + file LICENSE
Depends:	R (≥ 4.1.0)
Imports:	dplyr, tibble, tidyr, purrr, progress, stats, lubridate, jsonlite, cli, plyr, base64enc, janitor, httr
Encoding:	UTF-8
RoxygenNote:	7.3.3
Suggests:	spelling, testthat (≥ 3.0.0), digest, knitr, rmarkdown, arrow, withr
VignetteBuilder:	knitr
Language:	en-US
Config/testthat/edition:	3
NeedsCompilation:	no
Packaged:	2026-10-08 16:21:58 UTC; sebastian.stoeckl
Author:	Sebastian Stoeckl [aut, cre] (Package commissioner and maintainer.), Jesse Vent [ctb] (Creator of the crypto package that provided the idea and basis for this package.)
Repository:	CRAN
Date/Publication:	2026-10-08 17:20:02 UTC

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

Details

No API key is required. When the requested coin's numeric id is missing in coin_list, cg_id_mapping() is consulted to fill the id column.

All data come from CoinGecko's website chart endpoints; no API and no key are used. Coverage:

• Close, volume and market cap for the full lifetime of each coin, in any quote currency. In USD they come from CoinGecko's daily CSV export (one request per coin), otherwise from the website's chart data (two requests per coin).

• OHLC (open / high / low) is built from 4-hour candles (one extra request per coin) and covers the most recent 30 days; older rows have NA there. Longer windows are only offered as 4-day candles, which are not daily bars. For a one-shot complete OHLC backfill see vignette("coingecko-pro-backfill").

Only completed days are returned. If no close/volume/market-cap series can be retrieved for any requested coin, the function stops with an error (the source has most likely changed); if it fails for some coins only, a warning names them.

Fallback (opt-in). With options(crypto2.cg_api_fallback = TRUE), coins the website cannot serve are fetched from CoinGecko's public API instead, still without a key. Its daily history covers only the last 365 days, so this is off by default: a call that falls back warns and lists the affected coins in attr(result, "cg_api_fallback").

Value

Crypto currency historic OHLC market data in a tibble:

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

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:

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

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

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:

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

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:

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 every field of the ⁠/coins/markets⁠ endpoint: price, volume, 24h range, price and market-cap changes, all-time high/low and ROI. Column names mirror those of crypto_listings() where a CMC counterpart exists, so downstream code that already consumes a CMC listings tibble works on this tibble too.

Usage

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

Arguments

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.

Coverage. ⁠/coins/markets⁠ no longer lists wrapped, staked or bridged tokens (e.g. stETH, wstETH, WBTC, JitoSOL, bridged USDT). Their history is still available through cg_history(), but they will not appear in a cg_listings() snapshot.

Rate limits. No API key is used; the public endpoint allows only a handful of calls per minute. HTTP 429 and transient 408/502/503/504 responses are retried with exponential backoff (see wait and the crypto2.cg_max_retries option). If a page still fails after the last retry, paging stops and a warning names the failed page, so an incomplete result is never returned silently.

Value

Tibble with one row per coin. Always present: id, name, symbol, slug, date_added (always NA), last_updated (POSIXct, UTC), rank, market_cap, fully_diluted_market_cap, circulating_supply, total_supply, max_supply. With quote = TRUE additionally (CoinGecko field name in brackets):

Examples

## Not run: 
# Full current snapshot (all coins with a market cap), including prices
latest <- cg_listings()

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

## End(Not run)

URL Creator

Description

URL Creator

Usage

construct_url(path, v = 1)

Arguments

Value

A full URL string

checks the dater format (old/new) and converts to date

Description

checks the dater format (old/new) and converts to date

Usage

convert_date(date_str)

Arguments

Value

a correct date

Crosswalk between CoinMarketCap and CoinGecko coin ids

Description

Downloads the Open Crypto Pricing crosswalk, which links every CoinMarketCap id (as used by the ⁠crypto_*⁠ functions) to its CoinGecko coin (as used by the ⁠cg_*⁠ functions), including dead coins. Each pair is matched on contract addresses, project links, name/symbol and slug, cross-checked against DefiLlama, and confirmed on the price series of both providers. The file is updated weekly.

Usage

crypto_crosswalk(
  min_confidence = c("high", "medium", "low"),
  include_unmatched = FALSE,
  refresh = FALSE,
  quiet = FALSE
)

Arguments

Details

The file is downloaded once per session and cached in tempdir(). Parquet is used when the arrow package is installed, CSV otherwise.

Value

Tibble with one row per coin:

Source

Stoeckl & Pukrop (2026), Open Crypto Pricing, https://opencryptopricing.com. Licensed under CC BY 4.0: cite the source when you use or redistribute the crosswalk.

Examples

## Not run: 
cw <- crypto_crosswalk()

# CoinGecko history for the CMC top 100, via the crosswalk
top <- crypto_listings(limit = 100)
ids <- dplyr::inner_join(top, cw, by = c("id" = "cmc_id"))
hist <- cg_history(dplyr::select(ids, slug = cg_id, id = cg_numeric_id))

## 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

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):

#'

#'

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

Value

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

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

Value

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

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

Value

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

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 = NULL,
  start_date = NULL,
  end_date = NULL,
  interval = "day",
  quote = TRUE,
  sort = "cmc_rank",
  sort_dir = "asc",
  sleep = 0,
  wait = 60,
  finalWait = FALSE
)

Arguments

Details

For which = "historical" each day is fetched in pages of 5,000 coins and retried as a whole if a page fails. A day is returned complete or not at all: a day that still fails after the retries is dropped and named in a warning, never returned truncated.

CMC itself has been observed to return an incomplete day without any error: for 2024-01-07, requests from GitHub Actions runners received 2,552 coins while the same request from a desktop received all 9,002. When you run large downloads from a server, compare daily row counts with a run from another machine.

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):

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

Value

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

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

Value

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

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

Value

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

Examples

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

## End(Not run)

Parses json data from a string without revealing information about the source in case of an error

Description

Parses json data from a string without revealing information about the source in case of an error

Usage

safeFromJSON(...)

Arguments

Value

A parsed JSON object