-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
119 lines (90 loc) · 5.07 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# cryptor
[](https://travis-ci.org/blairj09/cryptor)
[](https://ci.appveyor.com/project/blairj09/cryptor)
[](https://codecov.io/github/blairj09/cryptor?branch=master)
[](https://cran.r-project.org/package=cryptor)
[](https://www.tidyverse.org/lifecycle/#experimental)
`cryptor` provides a basic wrapper around the public API provided by [CryptoCompare](https://www.cryptocompare.com). CryptoCompare has provided a very comprehensive [public cryptocurrency API](https://min-api.cryptocompare.com). This package strives to create a clean and intuitive R interface for that API.
## Installation
You can install `cryptor` from github with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("blairj09/cryptor")
```
## Usage
This package comes with several functions that map directly to CryptoCompare [API endpoints](https://min-api.cryptocompare.com). These functions center on price and other coin details for various cryptorcurrencies. CryptoCompare integrates with several exchanges and the exchange to be queried can often be requested. However, the default exchange of CCCAGG often works the best. The following outlines common use cases for various functions.
```{r load-package}
library(cryptor)
```
### Available Exchanges
Possible exchanges to query can be requested using the `get_exchanges()` function. This returns a comprehensive tibble of available exchanges along with each market available on that exchange.
```{r get-exchanges}
exchanges <- get_exchanges()
head(exchanges)
```
In this case, the `exchange` column contains the name of the exchange while the `coin` column contains the coin and the `market` column contains the market supported for `coin` on a given `exchange`. All possible exchanges can be identified by running `unique(get_exchanges()$exchage)`.
### Available Coins
All coins supported by the API and correspanding details can be obtained using the `get_coins()` function.
```{r get-coins}
coins <- get_coins()
head(coins)
```
### Current Price Data
There are two main functions for retreiving current price data. `get_price()` simply returns the price of the requested coins. `get_price_details()` returns current price data along with open, close, and other 24 hour price statistics. Price functions take two main parameters: `fsym(s)` and `tsym(s)`. These parameters specify the requested coin(s) (`fsym(s)`) and the currency the price is reported in (`tsym(s)`). The following examples illustrate getting price data for Bitcoin (BTC) and Etherium (ETH) in terms of US Dollars (USD).
```{r get-price}
get_price(c("BTC", "ETH"), "USD")
```
```{r get-price-details}
get_price_details(c("BTC", "ETH"), "USD")
```
### Historical Price Data
Historical price data can be retreived using `get_historical_price()`. Price can be obtained at the daily, hourly, or minute level. Minute level data is only available for the past 7 days. Anything beyond 7 days must be either daily or hourly data. The following example demonstrates how to get NEO to USD data for the past 7 days.
*As a note, it seems that the API sometimes returns all historical entries, regardless of the limit provided.*
```{r historical-price}
btc_price_history <- get_historical_price("NEO", "USD")
head(btc_price_history)
```
### Snapshot Data
CrytpoCompare provides endpoints for "snapshot data". These endpoints provide summarized data about individual coins and coin pairs.
```{r coin-snapshot}
btc_snapshot <- get_coin_snapshot(1182)
names(btc_snapshot)
```
```{r pair-snapshot}
get_pair_snapshot("BTC", "ETH")
```
### Social Data
One of the most impressive features of the CryptoCompare API is the ability to query some basic social stats for a given coin. The data provided contains details about the coin's github repositories, page view data from CryptoCompare's main website, and a listing of similar coins. This data can be accessed as follows:
```{r social-stats}
# Social stats for Bitcoin
eth_social_stats <- get_social(1182)
str(eth_social_stats)
```
### Pairs Data
Details about top cryptocurrency pairs (by volume) can be retrived using `get_top_pairs()`.
```{r top-pairs}
# Top ETH pairs
get_top_pairs("ETH")
```
### API Limits
The API has hour, minute, and second call rate limits. These limits, along with calls made against the limit, can be retrieved using `get_api_limit()` as follows:
```{r api-limits}
# Second limit
get_api_limit("second")
# Minute limit
get_api_limit("minute")
# Hour limit
get_api_limit("hour")
```