# server_info (rippled)

[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ServerInfo.cpp)

The `server_info` command asks the server for a human-readable version of various information about [the `rippled` server](/docs/concepts/networks-and-servers) being queried. For [Clio servers](/docs/concepts/networks-and-servers/the-clio-server), see [`server_info` (Clio)](/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio) instead.

## Request Format

An example of the request format:

WebSocket

```json
{
  "id": 1,
  "command": "server_info",
  "counters": false
}
```

JSON-RPC

```json
{
    "method": "server_info",
    "params": [
        {"counters" : false}
    ]
}
```

Commandline

```sh
#Syntax: server_info [counters]
# counters is an optional boolean value, it is used to display performance metrics
rippled server_info
```

The request includes the following parameters:

| Field | Type | Required? | Description |
|  --- | --- | --- | --- |
| `counters` | Boolean | No | If `true`, return metrics about the job queue, ledger store, and API method activity. The default is `false`. |


## Response Format

An example of a successful response:

WebSocket
{
    "id": 1,
    "result": {
      "info": {
        "build_version": "1.12.0",
        "complete_ledgers": "32570-82521701",
        "hostid": "LEST",
        "initial_sync_duration_us": "190181187",
        "io_latency_ms": 1,
        "jq_trans_overflow": "0",
        "last_close": {
          "converge_time_s": 3.001,
          "proposers": 35
        },
        "load_factor": 1,
        "network_id": 0,
        "peer_disconnects": "5",
        "peer_disconnects_resources": "0",
        "peers": 22,
        "ports": [
          {
            "port": "7777",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "8080",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "80",
            "protocol": [
              "http"
            ]
          },
          {
            "port": "51235",
            "protocol": [
              "peer"
            ]
          }
        ],
        "pubkey_node": "n9KQK8yvTDcZdGyhu2EGdDnFPEBSsY5wEgpU5GgpygTgLFsjQyPt",
        "server_state": "full",
        "server_state_duration_us": "91535211664",
        "state_accounting": {
          "connected": {
            "duration_us": "83091928",
            "transitions": "2"
          },
          "disconnected": {
            "duration_us": "104836801",
            "transitions": "2"
          },
          "full": {
            "duration_us": "91535211664",
            "transitions": "1"
          },
          "syncing": {
            "duration_us": "2252409",
            "transitions": "1"
          },
          "tracking": {
            "duration_us": "48",
            "transitions": "1"
          }
        },
        "time": "2023-Sep-13 22:08:48.097189 UTC",
        "uptime": 91725,
        "validated_ledger": {
          "age": 4,
          "base_fee_xrp": 0.00001,
          "hash": "5825332DC66029ECCD896CACB3BBB79E4F5372A8DCA91AA2874A1A1A87B79F84",
          "reserve_base_xrp": 10,
          "reserve_inc_xrp": 2,
          "seq": 82521701
        },
        "validation_quorum": 28
      }
    },
    "status": "success",
    "type": "response"
}

JSON-RPC
200 OK

{
    "result": {
      "info": {
        "build_version": "1.12.0",
        "complete_ledgers": "32570-82521761",
        "hostid": "LEST",
        "initial_sync_duration_us": "190181187",
        "io_latency_ms": 1,
        "jq_trans_overflow": "0",
        "last_close": {
          "converge_time_s": 3,
          "proposers": 35
        },
        "load_factor": 1,
        "network_id": 0,
        "peer_disconnects": "5",
        "peer_disconnects_resources": "0",
        "peers": 22,
        "ports": [
          {
            "port": "7777",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "8080",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "80",
            "protocol": [
              "http"
            ]
          },
          {
            "port": "51235",
            "protocol": [
              "peer"
            ]
          }
        ],
        "pubkey_node": "n9KQK8yvTDcZdGyhu2EGdDnFPEBSsY5wEgpU5GgpygTgLFsjQyPt",
        "server_state": "full",
        "server_state_duration_us": "91758491912",
        "state_accounting": {
          "connected": {
            "duration_us": "83091928",
            "transitions": "2"
          },
          "disconnected": {
            "duration_us": "104836801",
            "transitions": "2"
          },
          "full": {
            "duration_us": "91758491912",
            "transitions": "1"
          },
          "syncing": {
            "duration_us": "2252409",
            "transitions": "1"
          },
          "tracking": {
            "duration_us": "48",
            "transitions": "1"
          }
        },
        "time": "2023-Sep-13 22:12:31.377492 UTC",
        "uptime": 91948,
        "validated_ledger": {
          "age": 1,
          "base_fee_xrp": 0.00001,
          "hash": "6872A6612DCEBCFC717FEBC66EB8CC2A4D5EEB2B0F15FC3DCD060049FCA47F31",
          "reserve_base_xrp": 10,
          "reserve_inc_xrp": 2,
          "seq": 82521761
        },
        "validation_quorum": 28
      },
      "status": "success"
    }
}

Commandline
Loading: "/etc/opt/ripple/rippled.cfg"
2023-Sep-13 22:19:39.404596100 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005

{
    "result": {
      "info": {
        "build_version": "1.12.0",
        "complete_ledgers": "32570-82521761",
        "hostid": "LEST",
        "initial_sync_duration_us": "190181187",
        "io_latency_ms": 1,
        "jq_trans_overflow": "0",
        "last_close": {
          "converge_time_s": 3,
          "proposers": 35
        },
        "load_factor": 1,
        "network_id": 0,
        "peer_disconnects": "5",
        "peer_disconnects_resources": "0",
        "peers": 22,
        "ports": [
          {
            "port": "7777",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "8080",
            "protocol": [
              "ws"
            ]
          },
          {
            "port": "80",
            "protocol": [
              "http"
            ]
          },
          {
            "port": "51235",
            "protocol": [
              "peer"
            ]
          }
        ],
        "pubkey_node": "n9KQK8yvTDcZdGyhu2EGdDnFPEBSsY5wEgpU5GgpygTgLFsjQyPt",
        "server_state": "full",
        "server_state_duration_us": "91758491912",
        "state_accounting": {
          "connected": {
            "duration_us": "83091928",
            "transitions": "2"
          },
          "disconnected": {
            "duration_us": "104836801",
            "transitions": "2"
          },
          "full": {
            "duration_us": "91758491912",
            "transitions": "1"
          },
          "syncing": {
            "duration_us": "2252409",
            "transitions": "1"
          },
          "tracking": {
            "duration_us": "48",
            "transitions": "1"
          }
        },
        "time": "2023-Sep-13 22:12:31.377492 UTC",
        "uptime": 91948,
        "validated_ledger": {
          "age": 1,
          "base_fee_xrp": 0.00001,
          "hash": "6872A6612DCEBCFC717FEBC66EB8CC2A4D5EEB2B0F15FC3DCD060049FCA47F31",
          "reserve_base_xrp": 10,
          "reserve_inc_xrp": 2,
          "seq": 82521761
        },
        "validation_quorum": 28
      },
      "status": "success"
    }
}

The response follows the [standard format](/docs/references/http-websocket-apis/api-conventions/response-formatting), with a successful result containing an `info` object as its only field.

The `info` 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](/docs/concepts/networks-and-servers/amendments#amendment-blocked-servers). If the server is not amendment blocked, the response omits this field. |
| `build_version` | String | The version number of the running `rippled` server. |
| `closed_ledger` | Object | *(May be omitted)* Information on the most recently closed ledger that has not been validated by consensus, as a [Server Ledger Object](#server-ledger-object). If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. |
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `git` | Object | *(Admin only)* The Git details of your `rippled` build. |
| `git.branch` | String | *(Admin only)* The Git branch used to build your version of `rippled`. |
| `git.hash` | String | *(Admin only)* The Git hash of the commit used to build your version of `rippled`. |
| `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751](https://tools.ietf.org/html/rfc1751) word based on the [node public key](/docs/concepts/networks-and-servers/peer-protocol#node-key-pair). |
| `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 (since starting up) that 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](/docs/infrastructure/installation/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_s` | Number | The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds. |
| `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_factor` | Number | The multiplier to the [transaction cost](/docs/concepts/transactions/transaction-cost) the server is currently enforcing. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). 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_local` | Number | *(May be omitted)* The current multiplier to the transaction cost based on load to this server. |
| `load_factor_net` | Number | *(May be omitted)* The current multiplier to the transaction cost being used by the rest of the network (estimated from other servers' reported load values). |
| `load_factor_cluster` | Number | *(May be omitted)* The current multiplier to the transaction cost based on load to servers in this [cluster](/docs/concepts/networks-and-servers/clustering). |
| `load_factor_fee_escalation` | Number | *(May be omitted)* The current multiplier to the transaction cost that a transaction must pay to get into the open ledger. |
| `load_factor_fee_queue` | Number | *(May be omitted)* The current multiplier to the transaction cost that a transaction must pay to get into the queue, if the queue is full. |
| `load_factor_server` | Number | *(May be omitted)* The current multiplier to the transaction cost based on load to the server, cluster, and network, but not factoring in the open ledger cost. |
| `network_ledger` | String | *(May be omitted)* When [starting the server with the `--net` parameter](/docs/infrastructure/commandline-usage), this field contains the string `waiting` while the server is syncing to the network. The field is omitted otherwise. |
| `peers` | Number | 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](#port-descriptor-object). New in: rippled 1.12.0 |
| `pubkey_node` | String | Public key used to verify this server for peer-to-peer communications. This [*node key pair*](/docs/concepts/networks-and-servers/peer-protocol#node-key-pair) is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the `[node_seed]` config option, which is useful for [clustering](/docs/concepts/networks-and-servers/clustering). |
| `pubkey_validator` | String | *(Admin only)* Public key used by this node to sign ledger validations. This *validation key pair* is derived from the `[validator_token]` or `[validation_seed]` config field. |
| `server_state` | String | A string indicating to what extent the server is participating in the network. See [Possible Server States](/docs/references/http-websocket-apis/api-conventions/rippled-server-states) for more details. |
| `server_state_duration_us` | Number | The number of consecutive microseconds the server has been in the current state. |
| `state_accounting` | Object | A map of various [server states](/docs/references/http-websocket-apis/api-conventions/rippled-server-states) with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. The contents of this field are formatted as [State Accounting Objects](#state-accounting-object). |
| `uptime` | Number | Number of consecutive seconds that the server has been operational. |
| `validated_ledger` | Object | *(May be omitted)* Information about the most recent fully-validated ledger, as a [Server Ledger Object](#server-ledger-object). If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. |
| `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. |
| `validator_list_expires` | String | *(Admin only)* Either the human readable time, in UTC, when the current validator list expires, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. |
| `counters` | Object | This object contains performance metrics pertaining to the RPC calls (currently executing calls and completed calls) and the JobQueue. It also contains details of the nodestore like `node_writes`, `node_reads_total`, `node_reads_hit`, etc |
| `current_activity` | Object | This field lists the items currently being run in the job queue and contains two arrays for `jobs` and `methods`. |


### Port Descriptor Object

Each member of the `ports` array is an object with the following fields:

| Field | Value | Description |
|  --- | --- | --- |
| `port` | String - Number | A port number where the server is listening. |
| `protocol` | Array of String | A list of protocols being served on this port. Valid protocols include `http` or `https` for JSON-RPC, `ws`, `ws2`, `wss`, `wss2` for WebSocket, `grpc` for [gRPC](/docs/infrastructure/configuration/configure-grpc), and `peer` for the [XRP Ledger Peer Protocol](/docs/concepts/networks-and-servers/peer-protocol). |


Depending on network infrastructure, the ports and protocols reported here may not match how the server can be reached from the outside network. For example, if TLS terminates at a load balancer or proxy, the server may report `http` on one port, but might only be reachable through `https` on port 443 from outside.

### State Accounting Object

Each field in the `state_accounting` object has a key that refers to a specific [server state](/docs/references/http-websocket-apis/api-conventions/rippled-server-states), and a value that is an object with the following fields:

| Field | Value | Description |
|  --- | --- | --- |
| `duration_us` | String - Number | The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) |
| `transitions` | String - Number | The number of times the server has changed into this state. |


### Server Ledger Object

The response provides either a `validated_ledger` field or a `closed_ledger` field. Either field contains an object with the following fields:

| Field | Value | Description |
|  --- | --- | --- |
| `age` | Number | The time since the ledger was closed, in seconds. |
| `base_fee_xrp` | Number | Base fee, in XRP (not drops). This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `hash` | String - [Hash](/docs/references/protocol/data-types/basic-data-types#hashes) | Unique hash for the ledger, as hexadecimal. |
| `reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve |
| `reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. |
| `seq` | Number | The [ledger index](/docs/references/protocol/data-types/basic-data-types#ledger-index) of the latest validated ledger. |


Note that the [server_state method](/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state) provides a similar object with slightly different formatting (using drops of XRP instead of decimal XRP, for example).

If the `closed_ledger` field is present and has a small `seq` value (less than 8 digits), that indicates `rippled` does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes up to 15 minutes to sync with the network, depending on your connection speed and hardware specs. See [Server Doesn't Sync](/docs/infrastructure/troubleshooting/server-doesnt-sync) for troubleshooting information.

## Possible Errors

* Any of the [universal error types](/docs/references/http-websocket-apis/api-conventions/error-formatting#universal-errors).