stellaRbase (version 0.1.0)

getLedgers: Returns all ledgers.

Description

Return all valid ledgers in pages or stream them to R.

Usage

getLedgers(cursor = NULL, limit = 10, order = "asc", data.table = TRUE,
  stream = FALSE)

Arguments

cursor

numeric - optional, a paging token - where to start from. Can also be "now".

limit

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

order

character - optional, "asc" or "desc"

data.table

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

stream

boolean - if TRUE, a data.table is overwritten and the server-side streaming capability is utilised. A list will be returned.

Value

list

Examples

# NOT RUN {
getLedgers(limit = 2)
# }