ref_crypto_pairs {td}R Documentation

Reference Data Accessor for Forex Pairs from ‘twelvedata’

Description

Retrieve Reference Data for Cryptocurrency Pairs from ‘twelvedata’

Usage

ref_crypto_pairs(
  sym = "",
  as = c("data.frame", "raw"),
  exchange = "",
  currency_base = "",
  currency_quote = "",
  flatten_exchanges = TRUE,
  apikey
)

Arguments

sym

(optional, character) A (single or vector) Crypto currency pairs with slash(/) delimiter.

as

(optional, character) A selector for the desired output format: one of “data.frame” (the default) or or “raw”.

exchange

(optional, character) Exchange where crypto is traded. Default value is unset.

currency_base

(optional, character) Base currency name. Default value is unset.

currency_quote

(optional, character) Quote currency name. Default value is unset.

flatten_exchanges

(bool) Flatten the “data.frame”.

apikey

(optional character) An API key override, if missing a value cached from package startup is used. The startup looks for either a file in the per-package config directory provided by tools::R_user_dir (for R 4.0.0 or later), or the TWELVEDATA_API_KEY variable.

Details

ref_crypto_pairs.

Value

The requested data is returned as a data.frame object.

See Also

https://twelvedata.com/docs


[Package td version 0.0.6 Index]