Honeycluster Docs – Get server state (machine-readable)

Server Methods

Get server state (machine-readable)

wss://honeycluster.io

rpc method: server_state

Returns a variety of information about the server state in machine-readable (drops, not XRP) format.

Try it now

Response · server_state WS Response

{
  "result": {
    "state": {
      "build_version": "2.3.0",
      "complete_ledgers": "32570-89012345",
      "io_latency_ms": 1,
      "load": {
        "job_types": [],
        "threads": 6
      },
      "peer_disconnects": "0",
      "peers": 216,
      "pubkey_node": "n9MSTfmkKPcSmMFJFasaLAoc3SzMnHNqJQrDBkfrGMn9WUXQ8TTU",
      "server_state": "full",
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 750171900,
        "hash": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
        "reserve_base": 10000000,
        "reserve_inc": 2000000,
        "seq": 89012345
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

server_state WS Request

application/json

Get server state (machine-readable)

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "server_state",
  "id": 1
}

Response Message

server_state WS Response

application/json

WebSocket response for server_state

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "state": {
      "build_version": "2.3.0",
      "complete_ledgers": "32570-89012345",
      "io_latency_ms": 1,
      "load": {
        "job_types": [],
        "threads": 6
      },
      "peer_disconnects": "0",
      "peers": 216,
      "pubkey_node": "n9MSTfmkKPcSmMFJFasaLAoc3SzMnHNqJQrDBkfrGMn9WUXQ8TTU",
      "server_state": "full",
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 750171900,
        "hash": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
        "reserve_base": 10000000,
        "reserve_inc": 2000000,
        "seq": 89012345
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "server_state",
    "id": 1
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · server_state WS Response

{
  "result": {
    "state": {
      "build_version": "2.3.0",
      "complete_ledgers": "32570-89012345",
      "io_latency_ms": 1,
      "load": {
        "job_types": [],
        "threads": 6
      },
      "peer_disconnects": "0",
      "peers": 216,
      "pubkey_node": "n9MSTfmkKPcSmMFJFasaLAoc3SzMnHNqJQrDBkfrGMn9WUXQ8TTU",
      "server_state": "full",
      "validated_ledger": {
        "base_fee": 10,
        "close_time": 750171900,
        "hash": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
        "reserve_base": 10000000,
        "reserve_inc": 2000000,
        "seq": 89012345
      },
      "validation_quorum": 33
    }
  },
  "status": "success",
  "type": "response",
  "id": 1
}