crypto_info: Retrieves info (urls, logo, description, tags, platform,...

View source: R/crypto_info.R

crypto_infoR Documentation

Retrieves info (urls, logo, description, tags, platform, date_added, notice, status) on CMC for given id or slug

Description

This code uses the web api. It retrieves data for all active, delisted and untracked coins! It does not require an 'API' key.

Usage

crypto_info(
  coin_list = NULL,
  limit = NULL,
  requestLimit = 300,
  sleep = 60,
  finalWait = TRUE
)

Arguments

coin_list

string if NULL retrieve all currently active coins (crypto_list()), or provide list of cryptocurrencies in the crypto_list() format (e.g. current and/or dead coins since 2015)

limit

integer Return the top n records, default is all tokens

requestLimit

limiting the length of request URLs when bundling the api calls

sleep

integer (default 60) Seconds to sleep between API requests

finalWait

to avoid calling the web-api again with another command before 60s are over (TRUE=default)

Value

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

id

CMC id (unique identifier)

name

Coin name

symbol

Coin symbol (not-unique)

slug

Coin URL slug (unique)

category

Coin category: "token" or "coin"

description

Coin description according to CMC

logo

CMC url of CC logo

subreddit

Name of subreddit community

notice

Markdown formatted notices from CMC

date_added

Date CC was added to the CMC database

twitter_username

Username of CCs twitter account

is_hidden

TBD

date_launched

Date CC was launched

self_reported_circulating_supply

Self reported circulating supply

self reported tags

Self_reported_tags

status

timestamp and other status messages

tags

Tibble of tags and tag categories

url

Tibble of various resource urls. Gives website, technical_doc (whitepaper), source_code, message_board, chat, announcement, reddit, twitter, (block) explorer urls

Platform

Metadata about the parent coin if available. Gives id, name, symbol, slug, and token address according to CMC

Examples

## Not run: 
# return info for bitcoin
coin_info <- crypto_info(limit=3)

## End(Not run)


crypto2 documentation built on July 18, 2022, 5:08 p.m.