README.md

alt text Cran Cran Cran Cran Rdoc

Historical Cryptocurrency Prices For ALL Tokens!

Now providing support for the CMC professional API Easily interact with the professional API for CoinMarketCap through use of the keychain and rstudioapi packages.

Additional information on setup and usage can be found here. R-Studio and using Keyring

Retrieves all the open, high, low, close values for all cryptocurrencies. This retrieves data from CoinMarketCap's historical prices, exchange details and current prices API.

Prerequisites

Below are the high level dependencies for the package to install correctly.

R (>= 3.4.0), rvest, xml2

# Ubuntu 
sudo apt install libxml2-dev libcurl4-openssl-dev libssl-dev

Installing

The crypto R-package is installable through CRAN or through github.

# Installing via CRAN
install.packages("crypto", dependencies = TRUE)

# Installing via Github
devtools::install_github("jessevent/crypto")

Package Usage

These are the main functions that are added so far and a brief summary of what they do. Additional parameters are viewable in the documentation for each function.

Please note that CoinMarketCap have recently introduced a rate limiter on their service of 30 calls per minute, this package will now run slower to accomodate for the rate limit.

Please give this package a star if you find it helpful

library(crypto)

# Retrieve crypto market history for all-to-n coins
?getCoins
will_i_get_rich <- crypto_history(limit=50)

# Retrieve crypto market history for specific coin
?getCoins
will_i_get_rich_from <- crypto_history("kin")

# Get list of coins and rank
?listCoins
rich_list <- crypto_list()

# Retrieve current crypto market details
?getPrices
am_i_rich_now <- crypto_prices()

# Convert and/or summarise market history into xts object
?crypto2xts
when_will_i_get_rich <- crypto_xts(will_i_get_rich, "week")

# Get timeseries market data for token for displaying in charts
?daily_market
show_me_getting_rich <- crypto_timeseries('bitcoin')

# Get timeseries global market data for all coins or alt coins for displaying in charts
?global_market
show_me_everyone_getting_rich <- crypto_global_market()

Package Issues

Please run the below before raising an issue, then include the output from sessionInfo()

crypto::repair_dependencies()

print(sessionInfo())

Built With :heart_eyes_cat: R

Author/License

This project is licensed under the MIT License - see the file for details

Acknowledgments

ERC-20: 0x375923Bf82F0b728d23A5704261a6e16341fd860 XRP: rK59semLsuJZEWftxBFhWuNE6uhznjz2bK LTC: LWpiZMd2cEyqCdrZrs9TjsouTLWbFFxwCj



heguevel/Crypto documentation built on July 24, 2020, 12:25 a.m.