cryptoQuotes: Open access to cryptocurrency market data

:information_source: About

The cryptoQuotes-package is a high-level API client for accessing public market data endpoints on major cryptocurrency exchanges. It supports open, high, low, close and volume (OHLC-V) data and a variety of sentiment indicators; the market data is high quality and can be retrieved in intervals ranging from seconds to months. All the market data is accessed and processed without relying on crawlers, or API keys, ensuring an open, and reliable, access for researchers, traders and students alike. There are currently 5 supported cryptocurrency exchanges,

All data is returned as xts-objects which enables seamless interaction with with quantmod and TTR, for developing and evaluating trading strategies or general purpose cryptocurrency market analysis with a historical or temporal perspective.

:information_source: Overview

The cryptoQuotes-package has two main features; retrieving cryptocurrency market data, and charting. The market data consists of OHLC-V data and sentiment indicators; including, but not limited to, cryptocurrency fear and greed index, long-short ratio and open interest. All market data is retrieved using the family of get_*-functions. To get a full overview of the package and functionality please see the documentation on pkgdown.

Note: Given the nature of crypotcurrency data and general legislative restrictions, some exchanges may not work in your geolocation.

Below is a quick overview of the package and basic usage examples on retrieving and charting Bitcoin (BTC) OHLC-V and long-short ratio in 30 minute intervals.

:information_source: Cryptocurrency market data

OHLC-V

All supported exchanges and markets are listed in the table below, alongside the available range of intervals available from the respective exchanges,

## BTC OHLC prices
## from Binance spot market
## in 30 minute intervals
BTC <- cryptoQuotes::get_quote(
  ticker   = 'BTCUSDT',
  source   = 'binance',
  futures  = FALSE,
  interval = '30m',
  from     = Sys.Date() - 1 
)

Sentiment indicators

The sentiment indicators available in the cryptoQuotes-package can be divided in two; derived indicators and market indicators. The former is calculated based on, for example, the price actions such as the Moving Average Convergence Divergence (MACD) indicator. The latter are public indicators such as the long-short ratio or fear and greed index; these are retrieved using the family of get_*-functions, while the derived indicators can be created using, for example, TTR.

In this overview we are focusing on market indicators made public by the cryptocurrency exchanges. For a full overview of sentiment indicators please refer to the documentation on pkgdown. All supported market indicators by exchange are listed in the table below,

## BTC OHLC prices
## from Binance spot market
## in 30 minute intervals
BTC_LS <- cryptoQuotes::get_lsratio(
  ticker   = 'BTCUSDT',
  source   = 'binance',
  interval = '30m',
  from     = Sys.Date() - 1 
)

:information_source: Charting

Charting in the cryptoQuotes-package is built on plotly for interactivity. It supports light and dark themes, and accounts for color-deficiency via the options-argument in the chart()-function.

Charting with indicators

The OHLC-V data and the sentiment indicator can be charted using the chart()-function,

## Chart BTC
## using klines, SMA
## Bollinger Bands and
## long-short ratio
cryptoQuotes::chart(
  ticker = BTC,
  main   = cryptoQuotes::kline(),
  sub    = list(
    cryptoQuotes::lsr(ratio = BTC_LS),
    cryptoQuotes::volume()
  ),
  indicator = list(
    cryptoQuotes::sma(n = 7),
    cryptoQuotes::sma(n = 14),
    cryptoQuotes::sma(n = 21),
    cryptoQuotes::bollinger_bands()
  )
)

## Chart BTC
## using klines, SMA
## Bollinger Bands and 
## ling-short ratio with color-deficiency
cryptoQuotes::chart(
  ticker = BTC,
  main   = cryptoQuotes::kline(),
  sub    = list(
    cryptoQuotes::lsr(ratio = BTC_LS),
    cryptoQuotes::volume()
  ),
  indicator = list(
    cryptoQuotes::sma(n = 7),
    cryptoQuotes::sma(n = 14),
    cryptoQuotes::sma(n = 21),
    cryptoQuotes::bollinger_bands()
  ),
  options = list(
    deficiency = TRUE
  )
)

:information_source: Installation

:shield: Stable version

## install from CRAN
install.packages(
  pkgs = 'cryptoQuotes',
  dependencies = TRUE
)

:hammer_and_wrench: Development version

## install from github
devtools::install_github(
  repo = 'https://github.com/serkor1/cryptoQuotes/',
  ref  = 'development'
)

:information_source: Code of Conduct

Please note that the cryptoQuotes project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.