Parameters

object

object

REQUIRED

The ledger request object.

ledger_index

string

The index of the ledger to retrieve information

transactions

boolean

A boolean flag indicating whether to include the information about transactions in the specified ledger version

expand

boolean

A boolean flag indicating whether to provide full JSON-formatted information for transaction/account information instead of only hashes

owner_funds

boolean

A boolean flag indicating whether to include owner_funds field in the metadata of OfferCreate transactions in the response

Returns

result

object

The details of the result

ledger

object

The complete header data of this ledger with the following fields:

accepted

boolean

A boolean flag indicating whether the ledger has been accepted

account_hash

string

A hash value representing the state of all accounts in the ledger

close_flags

integer

A flags indicating the additional information about the ledger close

close_time

integer

The timestamp when the ledger was closed, represented in UNIX time format

close_time_human

string

The time this ledger was closed, in human-readable format

close_time_resolution

integer

The ledger close times are rounded to within this many seconds

closed

boolean

A boolean flag indicating whether or not this ledger has been closed

hash

string

The unique identifying hash of the entire ledger. This field is deprecated, use ledger_hash instead

ledger_hash

string

The unique identifying hash of the entire ledger

ledger_index

string

The index of the ledger

parent_close_time

integer

The time at which the previous ledger was closed

parent_hash

string

The unique identifying hash of the ledger that came immediately before this one

seqNum

string

The sequence number of the ledger

totalCoins

string

The total number of coins in the ledger. This field is deprecated, use total_coin instead

total_coins

string

The total number of coins in the ledger

transaction_hash

string

The transactions applied in this ledger version

ledger_hash

string

(Optional) The unique identifying hash of the entire ledger

ledger_index

integer

(Optional) The Ledger Index of this ledger

ledger_current_index

integer

(Optional) The ledger index of the current in-progress ledger

status

string

It indicates the status of the response

validated

boolean

It indicates whether the ledger has been validated

type

string

(Optional) It Filters by a ledger entry type. The valid types are: account, amendments, amm, check, deposit_preauth, directory, escrow, fee, hashes, nft_offer, offer, payment_channel, signer_list, state (trust line), and ticket. If using request accounts (state data), ignore it

diff

boolean

(Optional) If true, returns all objects that were added, modified, or deleted as part of applying transactions in the specified ledger

warnings

array

(Optional) An array of warning objects, each containing the following fields. Returned at the JSON-RPC response root on some servers and omitted from the result object

id

integer

The ID of the warning

message

string

The warning message

Request

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "ledger",
6
  "params": [
7
    {
8
      "ledger_index": "current",
9
      "transactions": false,
10
      "expand": false,
11
      "owner_funds": false
12
    }
13
  ],
14
  "id": 1
15
}'

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "ledger",
6
  "params": [
7
    {
8
      "ledger_index": "current",
9
      "transactions": false,
10
      "expand": false,
11
      "owner_funds": false
12
    }
13
  ],
14
  "id": 1
15
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'ledger',
4
    params: [{"ledger_index":"current","transactions":false,"expand":false,"owner_funds":false}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'ledger',
4
    params: [{"ledger_index":"current","transactions":false,"expand":false,"owner_funds":false}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "ledger",
9
  "params": [
10
    {
11
      "ledger_index": "current",
12
      "transactions": False,
13
      "expand": False,
14
      "owner_funds": False
15
    }
16
  ],
17
  "id": 1
18
})
19
headers = {
20
  'Content-Type': 'application/json'
21
}
22

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

25
print(response.text)

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "ledger",
9
  "params": [
10
    {
11
      "ledger_index": "current",
12
      "transactions": False,
13
      "expand": False,
14
      "owner_funds": False
15
    }
16
  ],
17
  "id": 1
18
})
19
headers = {
20
  'Content-Type': 'application/json'
21
}
22

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

25
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "ledger",
11
  params: [{"ledger_index":"current","transactions":false,"expand":false,"owner_funds":false}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "ledger",
11
  params: [{"ledger_index":"current","transactions":false,"expand":false,"owner_funds":false}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "result": {
3
    "ledger": {
4
      "closed": false,
5
      "ledger_index": "102609805",
6
      "parent_hash": "7735091DF9F32511F41AD963A8BDE4AF24B27D3AA3946903A31E3CFF2B948217"
7
    },
8
    "ledger_current_index": 102609805,
9
    "validated": false,
10
    "status": "success"
11
  },
12
  "status": "success",
13
  "type": "response",
14
  "forwarded": true,
15
  "warnings": [
16
    {
17
      "id": 2001,
18
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
19
    }
20
  ]
21
}

1
{
2
  "result": {
3
    "ledger": {
4
      "closed": false,
5
      "ledger_index": "102609805",
6
      "parent_hash": "7735091DF9F32511F41AD963A8BDE4AF24B27D3AA3946903A31E3CFF2B948217"
7
    },
8
    "ledger_current_index": 102609805,
9
    "validated": false,
10
    "status": "success"
11
  },
12
  "status": "success",
13
  "type": "response",
14
  "forwarded": true,
15
  "warnings": [
16
    {
17
      "id": 2001,
18
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
19
    }
20
  ]
21
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free