getLedgers: Returns all ledgers.

Description Usage Arguments Value Note Examples

View source: R/getLedgers.R

Description

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

Usage

1
2
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

Note

https://www.stellar.org/developers/horizon/reference/endpoints/ledgers-all.html

Examples

1
getLedgers(limit = 2)

stellaRbase documentation built on April 11, 2018, 5:03 p.m.