cg_get_coins_markets: Get coins markets

Description Usage Arguments Value Reference Examples

View source: R/cg_get_coins_markets.R

Description

List all supported coins price, market cap, volume, and market related data. Use this to obtain all the coins market data (price, market cap, volume).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
cg_get_coins_markets(
  vs_currency = "usd",
  ids = NULL,
  category = NULL,
  order = "market_cap_desc",
  per_page = 10,
  page = 1,
  sparkline = TRUE,
  price_change_percentage = NULL
)

Arguments

vs_currency

string The target currency of market data (usd, eur, jpy, etc.).

ids

string The ids of the coin, comma separated crytocurrency symbols (base).

category

string Filter by coin category, only "decentralized_finance_defi" and "stablecoins" are supported at the moment.

order

string Valid values: market_cap_desc, market_cap_asc, gecko_desc, gecko_asc, volume_desc, volume_asc, id_desc, id_asc.

per_page

integer Valid values: 1 - 250.

page

integer Page through results.

sparkline

boolean Include sparkline 7 days data. Valid values: true, false.

price_change_percentage

string Include price change percentage in 1h, 24h, 7d, 14d, 30d, 200d, or 1y; comma-separated e.g. "1h,24h,7d".

Value

Returns a "data.frame".

Reference

See /coins/markets in the API documentation.

Examples

1
2
cg_get_coins_markets()
cg_get_coins_markets(order = "volume_desc", per_page = 25)

eltownes/CryptoR documentation built on Dec. 20, 2021, 4:21 a.m.