amberdata_historical_exchange_volume {cryptotrackr}

amberdata_historical_exchange_volume

Description

amberdata_historical_exchange_volume

Usage

amberdata_historical_exchange_volume(
  api_key,
  exchange = NULL,
  direction = NULL,
  start_date = NULL,
  end_date = NULL,
  time_format = NULL,
  timeout_seconds = 60
)

Arguments

api_key

your Amberdata API key

exchange

the exchange you wish to retrieve volume for. By default this function will return all exchange volume.

direction

the direction in which to sort your results (by volume). The default is descending order. This function will accept "desc" or "asc".

start_date

only include data after this date (inclusive). This parameter will accept dates formatted as seconds, milliseconds, or iso8601.

end_date

only include data before this date (exclusive). The maximum time range is 31 days. This parameter will accept dates formatted as seconds, milliseconds, or iso8601.

time_format

the format to return your times in. Choose from: "milliseconds", "ms", "iso", "iso8601", "hr", and "human_readable". Default is "ms".

timeout_seconds

seconds until the query times out. Default is 60.

Value

returns a dataframe with your volume data.

Examples

## Not run: 
api_key <- "..."
volume <- amberdata_historical_exchange_volume(api_key
                                               , "gdax"
                                               , "desc"
                                               , "2020-09-01T01:00:00"
                                               , "2020-09-02T01:00:00"
                                               , "hr")
## End(Not run)