Rippled Postman Collection

This project provides a Postman Collection to be used with the rippled XRP Ledger server's JSON-RPC API.

• Example request bodies are included from https://xrpl.org/ to get started easily.
• JSON-RPC server URL is implemented in a Postman evironment variable so you can use it with any rippled server you want.

Usage

1. Load the rippled_postman_collection.json file into your Postman client.
2. Set the environment variable RIPPLED_JSONRPC_URL to your ripppled server's address, e.g. https://xrpl.ws/ for the XRP Ledger Foundation server.
3. Navigate to your collection and try some APIs!

Status

1. Many of the Public APIs have been implemented already
2. Polymorphic APIs still need to be completed, e.g. account_objects, ledger_entry
3. Admin APIs still need to be completed

API Support

• Public rippled Methods
  • 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_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, trustlines, balances, transactions, and other data. Use these methods to retrieve ledger info.
    • ledger - Get info about a ledger version.
    • ledger_closed - Get the latest closed ledger version.
    • ledger_current - Get the current working ledger version.
    • ledger_data - Get the raw contents of a ledger version.
    • ledger_entry - Get one element from a ledger version.
  • 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.
    • sign - Cryptographically sign a transaction.
    • sign_for - Contribute to a multi-signature.
    • 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.
  • 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.
    • book_offers - Get info about offers to exchange two currencies.
    • deposit_authorized - Check whether an account is authorized to send money directly to another.
    • path_find - Find a path for a payment between two accounts and receive updates. (websocket only)
    • 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.
    • channel_authorize - Sign a claim for money from a payment channel.
    • channel_verify - Check a payment channel claim's signature.
  • Server Info Methods - Use these methods to retrieve information about the current state of the rippled server.
    • fee - Get information about transaction cost.
    • manifest - Look up the public information about a known validator.
    • server_info - Retrieve status of the server in human-readable format.
    • server_state - Retrieve status of the server in machine-readable format.
  • Utility Methods - Use these methods to perform convenient tasks, such as ping and random number generation.
    • json - Pass JSON through the commandline. (commandline only)
    • ping - Confirm connectivity with the server.
    • random - Generate a random number.
• Admin rippled Methods
  • Key Generation Methods - Use these methods to generate and manage keys.
    • validation_create - Generate keys for a new rippled validator.
    • wallet_propose - Generate keys for a new account.
  • Logging and Data Management Methods: Use these methods to manage log levels and other data, such as ledgers.
    • can_delete - Allow online deletion of ledgers up to a specific ledger.
    • crawl_shards - Request information about which history shards peers have.
    • download_shard - Download a specific shard of ledger history.
    • ledger_cleaner - Configure the ledger cleaner service to check for corrupted data.
    • ledger_request - Query peer servers for a specific ledger version.
    • log_level - Get or modify log verbosity.
    • logrotate - Reopen the log file.
  • Server Control Methods - Use these methods to manage the rippled server.
    • ledger_accept - Close and advance the ledger in stand-alone mode.
    • stop - Shut down the rippled server.
    • validation_seed - (Obsolete) Temporarily set key to be used for validating.
  • Peer Management Methods - Use these methods to manage your server's peer-to-peer connections.
    • connect - Force the rippled server to connect to a specific peer.
    • peer_reservations_add - Add a reserved slot for a specific peer server.
    • peer_reservations_del - Remove a reserved slot for a specific peer server.
    • peer_reservations_list - List reserved slots for specific peer servers.
    • peers - Get information about the peer servers connected.
  • Status and Debugging Methods - Use these methods to check the status of the network and server.
    • consensus_info - Get information about the state of consensus as it happens.
    • feature - Get information about protocol amendments.
    • fetch_info - Get information about the server's sync with the network.
    • get_counts - Get statistics about the server's internals and memory usage.
    • print - Get information about internal subsystems. (websocket and command line only)
    • validator_info - Get the server's validation settings, if configured as a validator.
    • validator_list_sites - Get information about sites that publish validator lists.
    • validators - Get information about the current validators.