getLedgers
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns a detailed list of ledgers starting from the user specified starting point that you can paginate as long as the pages fall within the set history retention.
This method will use 10 .
startLedger (number) - Ledger sequence number to start fetching responses from (inclusive).
This method will return an error if startLedger is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node.
If a cursor is included in the request, startLedger must be omitted.
pagination - Pagination in stellar-rpc is similar to pagination in Horizon. See .
cursor (string)
An opaque string which acts as a paging token. To obtain the next page of results occurring after a given response set this value to the cursor field of the response.
limit (number)
The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Stellar-RPC for performance reasons.
If this argument isn't designated, it defaults to 100.
xdrFormat (string) - Lets the user choose the format in which the response should be returned - either as unpacked JSON or as base64-encoded XDR strings. Note that you should not rely on any schema for the JSON, as it will change when the underlying XDR changes.
Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json').
ledgers array[object]
hash string - The hash of the ledger header which was included in the chain
sequence number - The sequence number of the ledger (sometimes called the 'block height').
ledgerCloseTime string - The timestamp at which the ledger was closed.
headerXdr string - The LedgerHeader structure for this ledger (base64-encoded string).
metadataXdr string - The LedgerCloseMeta union for this ledger (base64-encoded string).
latestLedger number - The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.
latestLedgerCloseTime number - The unix timestamp of the close time of the latest ledger known to Stellar RPC at the time it handled the request.
oldestLedger number - The sequence number of the oldest ledger ingested by Stellar RPC at the time it handled the request.
oldestLedgerCloseTime number - The unix timestamp of the close time of the oldest ledger ingested by Stellar RPC at the time it handled the request.
cursor string - A token which can be included in a subsequent request to obtain the next page of results.