stellaRbase (version 0.1.0)

getTradeAggregations: Returns trade aggregations.

Description

Gather historical trading data directly from the API.

Usage

getTradeAggregations(start_time, end_time, resolution, limit = 10,
  order = "asc", base_asset_type, base_asset_code = NULL,
  base_asset_issuer = NULL, counter_asset_type, counter_asset_code = NULL,
  counter_asset_issuer = NULL, data.table = FALSE)

Arguments

start_time

numeric - milliseconds since epoch

end_time

numeric - milliseconds since epoch

resolution

numeric - segment duration as millis since epoch. Supported values are 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).

limit

numeric - optional, the number of records to return. Default is 10.

order

character - optional, "asc" or "desc"

base_asset_type

string - type of base asset

base_asset_code

string - code of base asset, not required if type is native

base_asset_issuer

string - issuer of base asset, not required if type is native

counter_asset_type

string - type of counter asset

counter_asset_code

string - code of counter asset, not required if type is native

counter_asset_issuer

string - issuer of counter asset, not required if type is native

data.table

boolean - if TRUE, a data.table is returned. If FALSE or NULL, a list is returned.

Value

data.table or list

Examples

# NOT RUN {
start_time="1512689100000"
end_time="1512775500000"
resolution="300000"
base_asset_type="native"
counter_asset_type="credit_alphanum4"
counter_asset_code="BTC"
counter_asset_issuer = "GATEMHCCKCY67ZUCKTROYN24ZYT5GK4EQZ65JJLDHKHRUZI3EUEKMTCH"

getTradeAggregations(start_time, end_time, resolution,
base_asset_type = base_asset_type, counter_asset_type = counter_asset_type,
counter_asset_code = counter_asset_code, counter_asset_issuer = counter_asset_issuer)
# }