Skip to main content

List All Ledgers REST API Endpoint

Retrieves a list of all ledgers in the network

Updated on
Oct 4, 2023

List All Ledgers REST API Endpoint

Please note that this method can be used in streaming mode. Streaming mode allows to listen for new ledgers as they close.

Query Parameters

cursor
integer
A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record
order
string
The designation of the order of the records. It can be ascending or descending. By default it is set to ascending
limit
integer
The maximum number of records returned

Returns

_embedded
object
The embedded account records
records
array
An array of account records
_links
object
The links related to the account record
self
object
The self-reference link
href
string
The URL for self-reference
templated
boolean
A boolean value that indicates whether the link is templated or not
transactions
object
Link to transactions related to the account
href
string
The URL for transactions related to the account
templated
boolean
A boolean value that indicates whether the link is templated or not
operations
object
Link to operations related to the account
href
string
The URL for operations related to the account
templated
boolean
A boolean value that indicates whether the link is templated or not
payments
object
Link to payments related to the account
href
string
The URL for payments related to the account
templated
boolean
A boolean value that indicates whether the link is templated or not
effects
object
Link to effects related to the account
href
string
The URL for effects related to the account
templated
boolean
A boolean value that indicates whether the link is templated or not
id
string
The Account ID
paging_token
string
The paging token for navigation purposes
hash
string
The hash value of the ledger
pre_hash
string
The hash of the previous ledger
sequence
integer
The sequence number of the ledger
successful_transaction_count
integer
The count of successful transactions in the ledger
failed_transaction_count
integer
The count of failed transactions in the ledger
operation_count
integer
The count of operations in the ledger
tx_set_operation_count
integer
The count of operations in the transaction set of the ledger
closed_at
string
The timestamp when the ledger was closed
total_coins
string
The total number of coins in circulation
fee_pool
string
The accumulated fees in the fee pool
base_fee_in_stroops
integer
The base fee for transactions in stroops
base_reserve_in_stroops
integer
The base reserve for accounts in stroops
max_tx_set_size
integer
The maximum transaction set size
protocol_version
integer
The protocol version of the ledger
header_xdr
string
The header XDR of the ledger
Request
1
curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/ledgers' \
2
-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free