Parameters

This method does not accept any parameters

Returns

status

string

The string value representing the health of the node

latestLedger

integer

The sequence number of the most recent ledger known to the node

latestLedgerCloseTime

string

The unix timestamp (in seconds) at which the latest ledger closed, returned as a string. Lets clients assess ledger freshness from the health endpoint without fetching full ledger metadata

oldestLedger

integer

The sequence number of the oldest ledger still kept in the node's history

oldestLedgerCloseTime

string

The unix timestamp (in seconds) at which the oldest ledger closed, returned as a string

ledgerRetentionWindow

integer

The maximum history retention window configured on the node, measured in ledgers. The actual number of ledgers currently retained (latestLedger - oldestLedger + 1) grows up to this value as the node fills its window

Request

1
curl --location 'https://docs-demo.stellar-mainnet.quiknode.pro/' \
2
--header 'Content-Type: application/json' \
3
--data '{
4
    "jsonrpc": "2.0",
5
    "id": 8675309,
6
    "method": "getHealth"
7
}'

1
curl --location 'https://docs-demo.stellar-mainnet.quiknode.pro/' \
2
--header 'Content-Type: application/json' \
3
--data '{
4
    "jsonrpc": "2.0",
5
    "id": 8675309,
6
    "method": "getHealth"
7
}'

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

4
var raw = JSON.stringify({
5
  "jsonrpc": "2.0",
6
  "id": 8675309,
7
  "method": "getHealth"
8
});
9

10
var requestOptions = {
11
  method: 'POST',
12
  headers: myHeaders,
13
  body: raw,
14
  redirect: 'follow'
15
};
16

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

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

4
var raw = JSON.stringify({
5
  "jsonrpc": "2.0",
6
  "id": 8675309,
7
  "method": "getHealth"
8
});
9

10
var requestOptions = {
11
  method: 'POST',
12
  headers: myHeaders,
13
  body: raw,
14
  redirect: 'follow'
15
};
16

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

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "id": 8675309,
9
  "method": "getHealth"
10
})
11
headers = {
12
  'Content-Type': 'application/json'
13
}
14

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

17
print(response.text)
18

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "id": 8675309,
9
  "method": "getHealth"
10
})
11
headers = {
12
  'Content-Type': 'application/json'
13
}
14

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

17
print(response.text)
18

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

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

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

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "jsonrpc": "2.0",
14
  "id": 8675309,
15
  "method": "getHealth"
16
})
17

18
response = https.request(request)
19
puts response.read_body
20

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

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

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

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  "jsonrpc": "2.0",
14
  "id": 8675309,
15
  "method": "getHealth"
16
})
17

18
response = https.request(request)
19
puts response.read_body
20

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free