Skip to main content

server_state RPC Method

Asks the server for various machine-readable information about the server's current state

Updated on
Oct 4, 2023

server_state RPC Method

Parameters

This method does not accept any parameters

Returns

result
object
An object which contains the following fields:
state
object
The details of the server state, including:
build_version
string
The version of the server
complete_ledgers
string
It is a range expression which indicate the sequence numbers of the ledger versions
initial_sync_duration_us
string
The duration of initial sync
io_latency_ms
integer
The amount of time spent waiting for I/O operations
jq_trans_overflow
string
The number of times (since starting up) that this server has had over 250 transactions waiting to be processed at once
last_close
object
The information about the last time the server closed a ledger
converge_time_s
integer
The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds
proposers
integer
The number of trusted validators the server considered (including itself)
load
object
The detailed information about the current load state of the server (Admin only)
job_types
array
It gives information about the rate of different types of jobs the server is doing and how much time it spends on each
in_progress
integer
The number of jobs in progress
job_type
string
The job type
threads
integer
The number of threads in the server's main job pool
load_base
integer
The baseline amount of server load used in transaction cost calculations
load_factor
integer
The load factor the server is currently enforcing
load_factor_fee_escalation
integer
The current multiplier to the transaction cost to get into the open ledger, in fee levels
load_factor_fee_queue
integer
he current multiplier to the transaction cost to get into the queue
load_factor_fee_reference
integer
The transaction cost with no load scaling
load_factor_server
integer
The load factor server value
network_id
integer
The network ID
peer_disconnects
string
The number of peer disconnections that have occurred
peer_disconnects_resources
string
The number of peer disconnections due to resource constraints
peers
integer
The number of other rippled servers this server is currently connected to
pubkey_node
string
The public key used to verify this server for peer-to-peer communications
server_state
string
A string indicating to what extent the server is participating in the network
server_state_duration_us
string
The number of consecutive microseconds the server has been in the current state
state_accounting
object
A map of various server states with information about the time the server spends in each
connected
object
An object which give information about when the server was connected
duration_us
string
The number of microseconds the server has spent in connected state
transitions
string
The number of times the server has changed into connected state
disconnected
object
An object which give information about when the server was disconnected
duration_us
string
The number of microseconds the server has spent in disconnected state
transitions
string
The number of times the server has changed into disconnected state
full
object
An object which give information about when the server was full
duration_us
string
The number of microseconds the server has spent in full state
transitions
string
The number of times the server has changed into full state
syncing
object
An object which give information about when the server was syncing
duration_us
string
The number of microseconds the server has spent in syncing state
transitions
string
The number of times the server has changed into syncing state
tracking
object
An object which give information about when the server was tracking
duration_us
string
The number of microseconds the server has spent in tracking state
transitions
string
The number of times the server has changed into tracking state
time
string
The current time in UTC
uptime
integer
The number of consecutive seconds that the server has been operational
validated_ledger
object
It gives information about the most recent fully-validated ledger
age
integer
The time since the ledger was closed, in seconds
hash
string
The unique hash for the ledger, as hexadecimal
seq
integer
The ledger index of the latest validated ledger
base_fee_xrp
integer
The base fee for transactions in drops of XRP
reserve_base_xrp
integer
The minimum amount of XRP (not drops) necessary for every account to keep in reserve
reserve_inc_xrp
integer
The amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger
validation_quorum
integer
The minimum number of trusted validations required to validate a ledger version
validator_list_expires
integer
The expiration timestamp of the validator list
status
string
The status of the server state request
type
string
The type of response being received
forwarded
boolean
When set to true, indicates that the transaction has been relayed or forwarded through intermediary nodes
warnings
array
An array of warning objects, each containing the following fields:
id
integer
The ID of the warning
message
string
The warning message
Request
1
curl https://docs-demo.xrp-mainnet.quiknode.pro/ \
2
-X POST \
3
-H "Content-Type: application/json" \
4
--data '{
5
"method": "server_state",
6
"params": [{}],"id":1,"jsonrpc":"2.0"}'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free