Honeycluster Docs – Get server protocol definitions

Server Methods

Get server protocol definitions

wss://honeycluster.io

rpc method: server_definitions

Returns the definitions (type codes, field names, etc.) used by this server for serializing and deserializing ledger data.

Try it now

Response · server_definitions WS Response

{
  "result": {
    "hash": "254F1003EFEFE7D2EDBC0D8B53B1675F9A070EB86E2FAB82CD22D4B0C879CA5C",
    "FIELDS": [],
    "LEDGER_ENTRY_TYPES": {},
    "TRANSACTION_RESULTS": {},
    "TRANSACTION_TYPES": {},
    "TYPES": {}
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

server_definitions WS Request

application/json

Get server protocol definitions

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`hash`	string	If provided, returns definitions only if different from this hash.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

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

Response Message

server_definitions WS Response

application/json

WebSocket response for server_definitions

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

Example

Json

{
  "result": {
    "hash": "254F1003EFEFE7D2EDBC0D8B53B1675F9A070EB86E2FAB82CD22D4B0C879CA5C",
    "FIELDS": [],
    "LEDGER_ENTRY_TYPES": {},
    "TRANSACTION_RESULTS": {},
    "TRANSACTION_TYPES": {},
    "TYPES": {}
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

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

ws.addEventListener('open', () => {
  const request = {
    "command": "server_definitions",
    "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_definitions WS Response

{
  "result": {
    "hash": "254F1003EFEFE7D2EDBC0D8B53B1675F9A070EB86E2FAB82CD22D4B0C879CA5C",
    "FIELDS": [],
    "LEDGER_ENTRY_TYPES": {},
    "TRANSACTION_RESULTS": {},
    "TRANSACTION_TYPES": {},
    "TYPES": {}
  },
  "status": "success",
  "type": "response",
  "id": 1
}