Public API Methods

Communicate directly with an XRP Ledger server using the public API methods. Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server.

Account Methods

An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.

  • account_channels - Get a list of payment channels where the account is the source of the channel.
  • account_currencies - Get a list of currencies an account can send or receive.
  • account_info - Get basic data about an account.
  • account_lines - Get info about an account's trust lines.
  • account_nfts - Get a list of non-fungible tokens owned by an account.
  • account_objects - Get all ledger objects owned by an account.
  • account_offers - Get info about an account's currency exchange offers.
  • account_tx - Get info about an account's transactions.
  • gateway_balances - Calculate total amounts issued by an account.
  • noripple_check - Get recommended changes to an account's Default Ripple and No Ripple settings.

Ledger Methods

A ledger version contains a header, a transaction tree, and a state tree, which contain account settings, trust lines, balances, transactions, and other data. Use these methods to retrieve ledger info.

Transaction Methods

Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.

  • submit - Send a transaction to the network.
  • submit_multisigned - Send a multi-signed transaction to the network.
  • transaction_entry - Retrieve info about a transaction from a particular ledger version.
  • tx - Retrieve info about a transaction from all the ledgers on hand.
  • tx_history - Retrieve info about all recent transactions.

By default, the following methods are admin-only. They can be used as public methods if the server admin has enabled public signing.

  • sign - Cryptographically sign a transaction.
  • sign_for - Contribute to a multi-signature.

Path and Order Book Methods

Paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books. Use these methods to work with paths and other books.

  • amm_info - Get info about an Automated Market Maker (AMM).
  • book_offers - Get info about offers to exchange two currencies.
  • deposit_authorized - Look up whether one account is authorized to send payments directly to another.
  • nft_buy_offers - Retrieve a list of buy offers for a specified NFToken object.
  • nft_sell_offers - Retrieve a list of sell offers for a specified NFToken object.
  • path_find - Find a path for a payment between two accounts and receive updates.
  • ripple_path_find - Find a path for payment between two accounts, once.

Payment Channel Methods

Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.

Subscription Methods

Use these methods to enable the server to push updates to your client when various events happen, so that you can know and react right away. WebSocket API only.

  • subscribe - Listen for updates about a particular subject.
  • unsubscribe - Stop listening for updates about a particular subject.

Server Info Methods

Use these methods to retrieve information about the current state of the rippled server.

  • fee - Get information about transaction cost.
  • server_info - Retrieve status of the server in human-readable format.
  • server_state - Retrieve status of the server in machine-readable format.
  • manifest - Retrieve the latest ephemeral public key information about a known validator.

Clio Methods

Use these methods to retrieve information using Clio server APIs.

  • server_info - Retrieve status of the Clio server.
  • ledger - Get info about a ledger version using Clio server's ledger API.
  • nft_info - Retrieve information about the specified NFT using Clio server's nft_info API.

Utility Methods

Use these methods to perform convenient tasks, such as ping and random number generation.

  • json - Use as a proxy to running other commands. Accepts the parameters for the command as a JSON value. Commandline only.
  • ping - Confirm connectivity with the server.
  • random - Generate a random number.

Deprecated Methods

The owner_info command is deprecated. Use account_objects instead.