Skip to content
Serkan Korkmaz edited this page Apr 18, 2024 · 27 revisions

CRAN status CRAN RStudio mirror downloads R-CMD-check Codecov test coverage Lifecycle: experimental

Introduction

cryptoQuotes is a high-level API-client to public market data endpoints from various API-providers. Collecting multiple API-providers into a single point of entry comes with a range of benefits, and limits. In this wiki these benefits and limits will be discussed, and a future roadmap will be published.

Table of Contents

  • Available Exchanges lists all available exchanges by endpoint.

  • Limits and Restrictions lists, and discusses, various limitations and restrictions on each exchange, and endpoint,

  • Roadmap includes a full list of currently planned future updates.

  • Tickers summarizes all available tickers across exchanges, and the naming conventions on each exchange.

  • Usecase displays a simple usecase for the library.

Vocabulary

The vocabulary in this wiki is as follows,

Terminology Meaning

Endpoint

Refers to the various get-functions like the get_quote()- and get_lsratio()-functions

Exchanges

Refers to the source-parameter found in the various functions

Granularity

Refers to the interval-parameter found in the various functions

Tickers

Refers to the ticker-parameter found inthe various functions. These are the available cryptocurrency pairs like BTCUSDT.

This wiki covers the details about the source-code, that is deemed unfit for pkgdown and vignettes. For general use of the cryptoQuotes-package please refer to the general documentation on pkgdown or the vignettes by running vignette(package = "cryptoQuotes").

Clone this wiki locally