R/getLedgerDetail.R

Defines functions getLedgerDetail

Documented in getLedgerDetail

#' Returns a single ledger.
#' @description Return a single ledger by providing a sequence id.
#' @param sequence character - (required) a ledger id. Must be 1 or greater.
#' @param domain character - signalling to query the testnet or public network. Can be either "testnet" or "public".
#' @return list
#' @export
#' @note https://www.stellar.org/developers/horizon/reference/endpoints/ledgers-single.html
#' @examples
#' \dontrun{getLedgerDetail("1", "testnet")}

getLedgerDetail <- function(sequence, domain = "public") {
  url = .requestBuilder(endpoint = "ledgers",
                        id = .checkSequence(sequence),
                        domain = domain)
  return(.getRequest(url))
}

Try the xlm package in your browser

Any scripts or data that you put into this service are public.

xlm documentation built on Oct. 23, 2018, 1:04 a.m.