Ripple - JSON-RPC

JSON-RPC methods supported on Ripple Mainnet and Ripple Testnet through Tatum RPC Gateway, with base URLs and an example request.

Call Ripple JSON-RPC methods through Tatum RPC Gateway. Send an HTTP POST request with a JSON-RPC 2.0 body to the network's base URL, with your API key in the x-api-key header. See Authentication.

Base URLs

NetworkBase URL
Ripple Mainnethttps://ripple-mainnet.gateway.tatum.io
Ripple Testnethttps://ripple-testnet.gateway.tatum.io

Example request

curl 'https://ripple-mainnet.gateway.tatum.io' \
  --header 'content-type: application/json' \
  --header 'x-api-key: {YOUR_API_KEY}' \
  --data '{"jsonrpc":"2.0","method":"ledger_current","params":[{}],"id":1}'

Methods

36 methods. Parameters and responses are described in the XRP Ledger HTTP / WebSocket API reference; each method name links to its page there.

MethodDescription
account_channelsLists the payment channels where an account is the source.
account_currenciesLists the currencies an account can send or receive, based on its trust lines.
account_infoReturns information about an account, including its XRP balance and settings.
account_linesLists an account's trust lines, including balances in non-XRP currencies.
account_nftsLists the NFTs owned by an account.
account_objectsReturns the raw ledger objects owned by an account.
account_offersLists the outstanding currency exchange offers placed by an account.
account_txLists the transactions that affected an account.
amm_infoReturns information about an Automated Market Maker (AMM) instance.
book_offersLists the offers in the order book between two currencies.
channel_authorizeCreates a signature that redeems a specific amount of XRP from a payment channel.
channel_verifyChecks whether a signature can redeem a specific amount of XRP from a payment channel.
deposit_authorizedChecks whether an account is authorized to send payments directly to another account.
feeReturns the current transaction cost requirements of the open ledger.
gateway_balancesReturns the total balances issued by an account, excluding given operational addresses.
ledgerReturns information about a ledger version.
ledger_closedReturns the identifiers of the most recently closed ledger.
ledger_currentReturns the index of the current in-progress ledger.
ledger_dataReturns the contents of a ledger version, paginated.
ledger_entryReturns a single ledger object in its raw format.
manifestReturns the latest manifest of a validator public key.
nft_buy_offersLists the buy offers for an NFT.
nft_sell_offersLists the sell offers for an NFT.
noripple_checkCompares an account's Default Ripple and No Ripple settings with the recommended ones.
pingChecks connectivity to the server and returns an acknowledgement.
randomReturns a random 256-bit number.
ripple_path_findFinds payment paths between two accounts in a single response.
server_definitionsReturns the definitions needed to serialize and deserialize binary data.
server_infoReturns human-readable information about the server.
server_stateReturns machine-readable information about the current state of the server.
submitSubmits a transaction to the network for inclusion in future ledgers.
submit_multisignedSubmits a multi-signed transaction to the network.
transaction_entryReturns a transaction from a specific ledger version.
txReturns a transaction by its hash.
tx_historyReturns some of the most recent transactions. Removed in API v2.
versionReturns the API version information of the server.

The gateway lists its supported methods at runtime:

Method unavailable?

If you need a method we don't support yet, contact support.