List All Ledgers
This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.
Query Parameters
- cursor integer
A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
- order string
Possible values: [
asc
,desc
]A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.
- limit integer
The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.
- 200
Success
- application/json
- Schema
- Example (from schema)
- ListAllLedgers
Schema
_embedded object
records object[]
Array [_links object
self object required
href link requiredtemplated booleantransactions object required
href link requiredtemplated booleanoperations object required
href link requiredtemplated booleanpayments object
href link requiredtemplated booleaneffects object required
href link requiredtemplated booleanid idpaging_token paging_tokenhash hashpre_hash hashsequence int32successful_transaction_count int32failed_transaction_count int32operation_count int32tx_set_operation_count int32closed_at stringtotal_coins stringfee_pool stringbase_fee_in_stroops int32base_reserve_in_stroops int32max_tx_set_size int32protocol_version int32header_xdr string]
{
"_embedded": {
"records": [
{
"_links": {
"self": {
"href": "string",
"templated": true
},
"transactions": {
"href": "string",
"templated": true
},
"operations": {
"href": "string",
"templated": true
},
"payments": {
"href": "string",
"templated": true
},
"effects": {
"href": "string",
"templated": true
}
},
"id": "string",
"paging_token": "string",
"hash": "string",
"pre_hash": "string",
"sequence": 0,
"successful_transaction_count": 0,
"failed_transaction_count": 0,
"operation_count": 0,
"tx_set_operation_count": 0,
"closed_at": "string",
"total_coins": "string",
"fee_pool": "string",
"base_fee_in_stroops": 0,
"base_reserve_in_stroops": 0,
"max_tx_set_size": 0,
"protocol_version": 0,
"header_xdr": "string"
}
]
}
}
{
"_embedded": {
"records": [
{
"_links": {
"effects": {
"href": "/ledgers/1/effects/{?cursor,limit,order}",
"templated": true
},
"operations": {
"href": "/ledgers/1/operations/{?cursor,limit,order}",
"templated": true
},
"self": {
"href": "/ledgers/1"
},
"transactions": {
"href": "/ledgers/1/transactions/{?cursor,limit,order}",
"templated": true
}
},
"id": "e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1",
"paging_token": "4294967296",
"hash": "e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1",
"sequence": 1,
"transaction_count": 0,
"successful_transaction_count": 0,
"failed_transaction_count": 0,
"operation_count": 0,
"tx_set_operation_count": 0,
"closed_at": "1970-01-01T00:00:00Z",
"total_coins": "100000000000.0000000",
"fee_pool": "0.0000000",
"base_fee_in_stroops": 100,
"base_reserve_in_stroops": 100000000,
"max_tx_set_size": 50
},
{
"_links": {
"effects": {
"href": "/ledgers/2/effects/{?cursor,limit,order}",
"templated": true
},
"operations": {
"href": "/ledgers/2/operations/{?cursor,limit,order}",
"templated": true
},
"self": {
"href": "/ledgers/2"
},
"transactions": {
"href": "/ledgers/2/transactions/{?cursor,limit,order}",
"templated": true
}
},
"id": "e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71",
"paging_token": "8589934592",
"hash": "e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71",
"prev_hash": "e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1",
"sequence": 2,
"transaction_count": 0,
"successful_transaction_count": 0,
"failed_transaction_count": 0,
"operation_count": 0,
"closed_at": "2015-07-16T23:49:00Z",
"total_coins": "100000000000.0000000",
"fee_pool": "0.0000000",
"base_fee_in_stroops": 100,
"base_reserve_in_stroops": 100000000,
"max_tx_set_size": 100
}
]
},
"_links": {
"next": {
"href": "/ledgers?order=asc&limit=2&cursor=8589934592"
},
"prev": {
"href": "/ledgers?order=desc&limit=2&cursor=4294967296"
},
"self": {
"href": "/ledgers?order=asc&limit=2&cursor="
}
}
}