amberdata_spot_reference {cryptotrackr}R Documentation

amberdata_spot_reference

Description

amberdata_spot_reference

Usage

amberdata_spot_reference(
  api_key,
  exchange = NULL,
  pair = NULL,
  include_inactive = "False",
  include_original_reference = "False",
  timeout_seconds = 60
)

Arguments

api_key

your Amberdata API key

exchange

choose a specific exchange or multiple exchanges (comma-separated) rather than all exchanges

pair

choose a specific pair or multiple pairs (comma-separated) rather than all pairs

include_inactive

If 'True', endpoint returns all pairs, including delisted ones. Default is 'False'.

include_original_reference

If 'True', endpoint returns originalReference. Default is 'False'.

timeout_seconds

seconds until the query times out. Default is 60.

Value

returns a list of reference information for each of the pairs on Amberdata.

Examples

## Not run: 
api_key <- "..."
reference <- amberdata_spot_reference(api_key)
btc_usd <- amberdata_spot_reference(api_key, pair = "btc_usd")
## End(Not run)

[Package cryptotrackr version 1.3.3 Index]