get_circulable_supply: Get the total amount of a coin that is availble at a given...

In James-Crypto-Research/GlassnodeR: Retreive Glassnode API Data and Return a Tidy Dataset

Get the total amount of a coin that is availble at a given moment

Description

Get the total amount of a coin that is availble at a given moment

Usage

get_circulable_supply(
  asset = "BTC",
  since = NULL,
  until = NULL,
  frequency = "24h",
  api_key = Sys.getenv("GN_API_KEY"),
  as_date = TRUE
)

Arguments

asset	The asset whose supply to get (see list on Glassnode)
since, until	A POSIX compatible date-time object. It's converted to a unix date number
frequency	A resolution for the data. See API documentation but it defaults to 24h
api_key	The API key to use. By default it will check the API_KEY environmental variable
as_date	A logical to return a date-time object or a date object for daily observations

Value

a tidy data frame of data

Examples

## Not run: 
# Need a valid API key to run
x <- get_circulable_supply()

## End(Not run)

James-Crypto-Research/GlassnodeR documentation built on Feb. 24, 2025, 3:21 p.m.