Skip to contents

Get historic crypto currency market data from CoinGecko

Source: R/cg_history.R
cg_history.Rd

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.

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.

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").

Examples

if (FALSE) { # \dontrun{
# 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())
} # }