getLedgers RPC Method

Parameters

startLedger

string

The ledger sequence number to start fetching from

pagination

object

The pagination object which contains the following fields:

cursor

string

When provided it excludes the element with an ID matching the cursor and only includes elements appearing after it in the response

limit

integer

The maximum number of records returned. By default, it is set to 100

xdrFormat

string

Specifies whether XDR should be encoded as Base64 (default or 'base64') or JSON ('json')

Returns

result

object

The result object containing ledger details and pagination metadata. Returns null if no ledgers are found

ledgers

array

An array of ledger objects

hash

string

The hash of the ledger header which was included in the chain

sequence

integer

The sequence number of the ledger (also referred to as 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

integer

The sequence number of the latest ledger known to Stellar RPC at the time it handled the request

latestLedgerCloseTime

integer

The Unix timestamp of the close time of the latest ledger known to Stellar RPC at the time it handled the request

oldestLedger

integer

The sequence number of the oldest ledger ingested by Stellar RPC at the time it handled the request

oldestLedgerCloseTime

integer

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 that can be included in a subsequent request to obtain the next page of results

Request

curl --location 'https://docs-demo.stellar-mainnet.quiknode.pro/' \
--header 'Content-Type: application/json' \
--data '{
    "jsonrpc": "2.0",
    "id": 8675309,
    "method": "getLedgers",
    "params": {
        "startLedger": 58450248,
        "pagination": {
            "limit": 10
        }
    }
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getLedgers",
  "params": {
    "startLedger": "58450248",
    "pagination": {
      "limit": 10
    }
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://docs-demo.stellar-mainnet.quiknode.pro/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests
import json

url = "https://docs-demo.stellar-mainnet.quiknode.pro/"

payload = json.dumps({
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getLedgers",
  "params": {
    "startLedger": "58450248",
    "pagination": {
      "limit": 10
    }
  }
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

require "uri"
require "json"
require "net/http"

url = URI("https://docs-demo.stellar-mainnet.quiknode.pro/")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "getLedgers",
  "params": {
    "startLedger": 58450248,
    "pagination": {
      "limit": 10
    }
  }
})

response = https.request(request)
puts response.read_body

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free