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
| Network | Base URL |
|---|---|
| Ripple Mainnet | https://ripple-mainnet.gateway.tatum.io |
| Ripple Testnet | https://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.
| Method | Description |
|---|---|
account_channels | Lists the payment channels where an account is the source. |
account_currencies | Lists the currencies an account can send or receive, based on its trust lines. |
account_info | Returns information about an account, including its XRP balance and settings. |
account_lines | Lists an account's trust lines, including balances in non-XRP currencies. |
account_nfts | Lists the NFTs owned by an account. |
account_objects | Returns the raw ledger objects owned by an account. |
account_offers | Lists the outstanding currency exchange offers placed by an account. |
account_tx | Lists the transactions that affected an account. |
amm_info | Returns information about an Automated Market Maker (AMM) instance. |
book_offers | Lists the offers in the order book between two currencies. |
channel_authorize | Creates a signature that redeems a specific amount of XRP from a payment channel. |
channel_verify | Checks whether a signature can redeem a specific amount of XRP from a payment channel. |
deposit_authorized | Checks whether an account is authorized to send payments directly to another account. |
fee | Returns the current transaction cost requirements of the open ledger. |
gateway_balances | Returns the total balances issued by an account, excluding given operational addresses. |
ledger | Returns information about a ledger version. |
ledger_closed | Returns the identifiers of the most recently closed ledger. |
ledger_current | Returns the index of the current in-progress ledger. |
ledger_data | Returns the contents of a ledger version, paginated. |
ledger_entry | Returns a single ledger object in its raw format. |
manifest | Returns the latest manifest of a validator public key. |
nft_buy_offers | Lists the buy offers for an NFT. |
nft_sell_offers | Lists the sell offers for an NFT. |
noripple_check | Compares an account's Default Ripple and No Ripple settings with the recommended ones. |
ping | Checks connectivity to the server and returns an acknowledgement. |
random | Returns a random 256-bit number. |
ripple_path_find | Finds payment paths between two accounts in a single response. |
server_definitions | Returns the definitions needed to serialize and deserialize binary data. |
server_info | Returns human-readable information about the server. |
server_state | Returns machine-readable information about the current state of the server. |
submit | Submits a transaction to the network for inclusion in future ledgers. |
submit_multisigned | Submits a multi-signed transaction to the network. |
transaction_entry | Returns a transaction from a specific ledger version. |
tx | Returns a transaction by its hash. |
tx_history | Returns some of the most recent transactions. Removed in API v2. |
version | Returns 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.