server_state
The server_state command asks the server for various machine-readable information about the rippled server's current state. The response is almost the same as the [server_info method][], but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)
Request Format
An example of the request format:
The request does not takes any parameters.
Response Format
An example of a successful response:
The response follows the [standard format][], with a successful result containing a state object as its only field.
The state object may have some arrangement of the following fields:
Field
Type
Description
amendment_blocked
Boolean
(May be omitted) If true, this server is amendment blocked. If the server is not amendment blocked, the response omits this field.
build_version
String
The version number of the running rippled version.
complete_ledgers
String
Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. It is possible to be a disjoint sequence, e.g. "2500-5000,32570-7695432". If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string empty.
closed_ledger
Object
(May be omitted) Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes validated_ledger instead. The member fields are the same as the validated_ledger field.
io_latency_ms
Number
Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the rippled server is probably having serious load issues.
jq_trans_overflow
String - Number
The number of times this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see Capacity Planning.
last_close
Object
Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating.
last_close.converge_time
Number
The amount of time it took to reach a consensus on the most recently validated ledger version, in milliseconds.
last_close.proposers
Number
How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version.
load
Object
(Admin only) Detailed information about the current load state of the server.
load.job_types
Array
(Admin only) Information about the rate of different types of jobs the server is doing and how much time it spends on each.
load.threads
Number
(Admin only) The number of threads in the server's main job pool.
load_base
Number
The baseline amount of server load used in [transaction cost][] calculations. If the load_factor is equal to the load_base, then only the base transaction cost is enforced. If the load_factor is higher than the load_base, then transaction costs are multiplied by the ratio between them. For example, if the load_factor is double the load_base, then transaction costs are doubled.
load_factor
Number
The load factor the server is currently enforcing. The ratio between this value and the load_base determines the multiplier for transaction costs. The load factor is determined by the highest of the individual server's load factor, the cluster's load factor, the open ledger cost, and the overall network's load factor.
load_factor_fee_escalation
Number
(May be omitted) The current multiplier to the transaction cost to get into the open ledger, in [fee levels][].
load_factor_fee_queue
Number
(May be omitted) The current multiplier to the transaction cost to get into the queue, if the queue is full, in fee levels.
load_factor_fee_reference
Number
(May be omitted) The transaction cost with no load scaling, in fee levels.
load_factor_server
Number
(May be omitted) The load factor the server is enforcing, based on load to the server, cluster, and network, but not factoring in the open ledger cost.
peers
Number
(Omitted by reporting mode servers) How many other rippled servers this one is currently connected to.
ports
Array
A list of ports where the server is listening for API commands. Each entry in the array is a Port Descriptor object.
Possible Errors
Any of the [universal error types][].
Last updated