Skip to main content

server_info

POST
Returns server state information in a human-readable form.It lets you check the server version, the range of ledgers held, the sync state and the load multipliers.
param[0]
parametersobjectrequired
countersboolean
Whether to also return metrics about the job queue, the ledger store and API method calls.
Responses
Detailed server state information.
amendment_blockedboolean
Whether the server is amendment blocked. Returned only in that state.
build_versionstring
The version of the running server.
A summary of a ledger version as the server sees it.
base_feenumber
The reference transaction cost, in XRP.
close_timenumber
The time the ledger closed, in seconds since the Ripple Epoch.
hashstring
The unique hash that identifies the ledger version.
reserve_basenumber
The minimum reserve required to keep an account, in XRP.
reserve_incnumber
The additional reserve required per ledger object, in XRP.
seqinteger
The ledger index.
complete_ledgersstring
The range of ledger indexes the server holds. Returns empty when it holds none.
hostidstring
The server's hostname, or an RFC-1751 word derived from the node public key.
io_latency_msinteger
The I/O wait time, in milliseconds.
jq_trans_overflowstring
The number of times the transaction queue has overflowed since the server started.
Consensus information from the previous ledger close.
converge_time_snumber
The time taken to reach consensus, in seconds.
proposersinteger
The number of validators that participated in consensus.
load_factornumber
The transaction cost multiplier currently in effect.
load_factor_fee_escalationnumber
The cost multiplier for inclusion in the open ledger.
load_factor_fee_queuenumber
The cost multiplier for entering the queue.
load_factor_fee_referencenumber
The reference transaction cost without any multiplier applied.
load_factor_localnumber
The cost multiplier caused by this server's load.
load_factor_netnumber
The cost multiplier caused by network-wide load.
load_factor_clusternumber
The cost multiplier caused by cluster load.
load_factor_servernumber
The cost multiplier the server enforces.
network_ledgerstring
Returns waiting while the server is syncing with the network.
peersinteger
The number of connected peer servers.
The list of ports the server is listening on.
portstring
The port number the server is listening on.
protocolarray
The list of protocols served on that port.
pubkey_nodestring
The public key used to verify peer-to-peer communication.
server_statestring
The server's level of participation in the network.
server_state_duration_usstring
The time spent in the current state, in microseconds.
The accumulated duration and transition count for each server state.
duration_usstring
The total time spent in that state, in microseconds.
transitionsstring
The number of transitions into that state.
timestring
The server's current time in UTC.
uptimeinteger
The time the server has been operating continuously, in seconds.
A summary of a ledger version as the server sees it.
base_feenumber
The reference transaction cost, in XRP.
close_timenumber
The time the ledger closed, in seconds since the Ripple Epoch.
hashstring
The unique hash that identifies the ledger version.
reserve_basenumber
The minimum reserve required to keep an account, in XRP.
reserve_incnumber
The additional reserve required per ledger object, in XRP.
seqinteger
The ledger index.
validation_quoruminteger
The number of trusted validations required to validate a ledger version.
countersobject
RPC and job queue performance metrics. Returned when counters is set to true in the request.
current_activityobject
Information about the job queue items and API methods currently running. Returned when counters is set to true in the request.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}
cURL
curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "server_info",
    "params": [
      {
        "counters": false
      }
    ]
  }'