get_percent_top_balance: Get the percent of circulable supply for a crypto that is at...

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

Get the percent of circulable supply for a crypto that is at deposited in large accoints

Description

This function calls top 1 that is the percent (in decimal form) of the crypto in wallets containing the largest top 1 wallets are excluded.

Usage

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

Arguments

asset	This is the asset to get information on. The list of available assets is on the GN API site
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

Details

NOTE: FOr BTC this is entities (cluster of wallets) for others this is wallets

Value

Returns a tibble with columns for the datetime, and percent

Examples

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

## End(Not run)

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