XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
HTTP / WebSocket APIs
/
Public API Methods
/
Server Info Methods
/
server_definitions
Last updated
Edit

server_definitions

[Source]

The server_definitions command returns an SDK-compatible definitions.json, generated from the rippled instance currently running. You can use this to query a node in a network, quickly receiving the definitions necessary to serialize/deserialize its binary data.

Request Format

An example of the request format:

  1. WebSocket
  2. JSON-RPC
{
  "id": 2,
  "command": "server_definitions"
}

Try it! >

The request does not take any parameters.

Response Format

An example of a successful response:

  1. WebSocket
{
  "id": 1,
  "result": {
    "FIELDS": [
      [
        "Generic",
        {
          "isSerialized": false,
          "isSigningField": false,
          "isVLEncoded": false,
          "nth": 0,
          "type": "Unknown"
        }
      ],
      [
        "Invalid",
        {
          "isSerialized": false,
          "isSigningField": false,
          "isVLEncoded": false,
          "nth": -1,
          "type": "Unknown"
        }
      ],
      [
        "ObjectEndMarker",
        {
          "isSerialized": true,
          "isSigningField": true,
          "isVLEncoded": false,
          "nth": 1,
          "type": "STObject"
        }
      ],
      [
        "ArrayEndMarker",
        {
          "isSerialized": true,
          "isSigningField": true,
          "isVLEncoded": false,
          "nth": 1,
          "type": "STArray"
        }
      ]
      ...
    ]
  }
}

To see a full definitions.json file and descriptions of the top-level fields, see: Definitions File.

Possible Errors

Any of the universal error types.