stellaRbase (version 0.1.0)

collect: Runs multiple calls against an endpoint to create a larger data set.

Description

Get the first n records, most recent n records or records from a range.

Usage

collect(endpoint, n = 11, order = "asc", data.table = TRUE,
  verbose = FALSE)

Arguments

endpoint

character - one of: payments, operations, effects, trades, transactions, ledgers.

n

numeric - the number of *pages* of records to return. Default is 1, maximum is currently 3600 due to the rate limit for the Horizon API. Each "page" will return 200 records.

order

character - optional, "asc" or "desc"

data.table

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

verbose

boolean - if TRUE, the results and number of rows returned will be printed to the console.

Value

data.table

Examples

# NOT RUN {
collect(endpoint = "ledgers", n = 3)
# }