API Conventions

This section describes data types and formats of the rippled APIs, including JSON-RPC and WebSocket interfaces.

Some of these data types also appear in higher-level APIs, including the Data API.

Children of this page:

  • Basic Data Types

    Format and meaning of fundamental data types like addresses, ledger index, and currency codes.

  • Currency Formats

    Precision and range for currency numbers, plus formats of custom currency codes.

  • Error Formatting

    Error formats and common error codes for WebSocket, JSON-RPC, and Commandline interfaces.

  • Markers and Pagination

    Convention for paginating large queries into multiple responses.

  • Modifying the Ledger

    Why and how only transactions can modify the ledger.

  • Request Formatting

    Standard request format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.

  • Response Formatting

    Standard response format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.

  • rippled Server States

    Definitions of state information reported in some API methods.