XRP Ledger Documentation
Dive into our documentation and start integrating with the XRP Ledger.
Browse by category, or skip straight to the full documentation index.
Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
Get step-by-step guidance to perform common tasks with the XRP Ledger.
Complete references for different interfaces to the XRP Ledger.
- rippled API Reference
- API Conventions
- Public rippled Methods
- Admin rippled Methods
- Ledger Data Formats
- Transaction Formats
- rippled Commandline Usage Reference
- Peer Port Methods
- XRP-API
- All XRP-API Methods
- Query Methods
- Transact Methods
- Meta Methods
- XRP-API Data Types
- RippleAPI Reference
- Ripple Data API v2
- xrp-ledger.toml File
XRPL.org is a community-driven resource for all things XRP and the XRP Ledger—your source for technical information, reference materials and tools.
Full Documentation Index
- Concepts
- Introduction
- XRP Ledger Overview
- Introduction to Consensus
- XRP
- Software Ecosystem
- Technical FAQ
- Payment System Basics
- Accounts
- Cryptographic Keys
- Multi-Signing
- Reserves
- Tickets
- Deposit Authorization
- Fees (Disambiguation)
- Ledgers
- Transaction Basics
- Transaction Cost
- Finality of Results
- Source and Destination Tags
- Payment Types
- Direct XRP Payments
- Cross-Currency Payments
- Checks
- Escrow
- Partial Payments
- Payment Channels
- Issued Currencies
- Issued Currencies Overview
- Trust Lines and Issuing
- Authorized Trust Lines
- Freezing Issued Currencies
- Rippling
- Transfer Fees
- Issuing and Operational Addresses
- Paths
- Demurrage
- Decentralized Exchange
- Offers
- Auto-Bridging
- Tick Size
- Consensus Network
- Consensus
- Consensus Principles and Rules
- Consensus Protections Against Attacks and Failure Modes
- Invariant Checking
- Negative UNL
- Transaction Queue
- About Canceling a Transaction
- Transaction Malleability
- Amendments
- Known Amendments
- Fee Voting
- Consensus Research
- Parallel Networks
- The rippled Server
- rippled Server Modes
- Clustering
- Ledger History
- Online Deletion
- History Sharding
- Peer Protocol
- Transaction Censorship Detection
- Tutorials
- Get Started
- Get Started Using Python
- Get Started with XRP Ledger APIs
- Get Started with RippleAPI for Node.js
- Send XRP
- Monitor Incoming Payments with WebSocket
- Production Readiness
- Set Up Secure Signing
- Look Up Transaction Results
- Reliable Transaction Submission
- Manage Account Settings
- Assign a Regular Key Pair
- Change or Remove a Regular Key Pair
- Disable Master Key Pair
- Set Up Multi-Signing
- Send a Multi-Signed Transaction
- Require Destination Tags
- Offline Account Setup Tutorial
- Use Tickets
- Use Specialized Payment Types
- Use Escrows
- Send a Time-Held Escrow
- Send a Conditionally-Held Escrow
- Cancel an Expired Escrow
- Look up escrows
- Use an Escrow as a Smart Contract
- Use Payment Channels
- Open a Payment Channel to Enable an Inter-Exchange Network
- Use Checks
- Send a Check
- Cash a Check for an Exact Amount
- Cash a Check for a Flexible Amount
- Cancel a Check
- Look Up Checks by Sender
- Look Up Checks by Recipient
- XRP Ledger Businesses
- List XRP as an Exchange
- List Your Exchange on XRP Charts
- Become an XRP Ledger Gateway
- Manage the rippled Server
- Install rippled
- System Requirements
- Install on CentOS/Red Hat with yum
- Install on Ubuntu or Debian Linux
- Update Automatically on Linux
- Update Manually on CentOS/Red Hat
- Update Manually on Ubuntu or Debian
- Build and Run rippled on Ubuntu
- Build and Run rippled on macOS
- Capacity Planning
- rippled v1.3.x Migration Instructions
- Configure rippled
- Run rippled as a Validator
- Run rippled as a Wallet Server
- Configure Amendment Voting
- Configure StatsD
- Connect Your rippled to a Parallel Network
- Configure Online Deletion
- Configure Advisory Deletion
- Configure History Sharding
- Configure Full History
- Configure gRPC
- Enable Public Signing
- Configure Peering
- Cluster rippled Servers
- Configure a Private Server
- Configure the Peer Crawler
- Enable Link Compression
- Forward Ports for Peering
- Manually Connect to a Specific Peer
- Set Maximum Number of Peers
- Use a Peer Reservation
- Test rippled Functionality in Stand-Alone Mode
- Start a New Genesis Ledger in Stand-Alone Mode
- Load a Saved Ledger in Stand-Alone Mode
- Advance the Ledger in Stand-Alone Mode
- Troubleshooting rippled
- Diagnosing Problems with rippled
- Health Check Interventions
- Understanding Log Messages
- rippled Server Doesn't Sync
- rippled Server Won't Start
- Fix SQLite Transaction Database Page Size Issue
- References
- rippled API Reference
- API Conventions
- Basic Data Types
- base58 Encodings
- Currency Formats
- Error Formatting
- Markers and Pagination
- Modifying the Ledger
- Rate Limiting
- Request Formatting
- Response Formatting
- rippled Server States
- Serialization Format
- Public rippled Methods
- Account Methods
- account_channels
- account_currencies
- account_info
- account_lines
- account_objects
- account_offers
- account_tx
- gateway_balances
- noripple_check
- Ledger Methods
- ledger
- ledger_closed
- ledger_current
- ledger_data
- ledger_entry
- Transaction Methods
- sign
- sign_for
- submit
- submit_multisigned
- transaction_entry
- tx
- tx_history
- Path and Order Book Methods
- book_offers
- deposit_authorized
- path_find
- ripple_path_find
- Payment Channel Methods
- channel_authorize
- channel_verify
- Subscription Methods
- subscribe
- unsubscribe
- Server Info Methods
- fee
- manifest
- server_info
- server_state
- Utility Methods
- json
- ping
- random
- Admin rippled Methods
- Key Generation Methods
- validation_create
- wallet_propose
- Logging and Data Management Methods
- can_delete
- crawl_shards
- download_shard
- ledger_cleaner
- ledger_request
- log_level
- logrotate
- Server Control Methods
- ledger_accept
- stop
- validation_seed
- Peer Management Methods
- connect
- peer_reservations_add
- peer_reservations_del
- peer_reservations_list
- peers
- Status and Debugging Methods
- consensus_info
- feature
- fetch_info
- get_counts
- validator_info
- validator_list_sites
- validators
- Ledger Data Formats
- Ledger Header
- Ledger Object IDs
- Ledger Object Types
- AccountRoot
- Amendments
- Check
- DepositPreauth
- DirectoryNode
- Escrow
- FeeSettings
- LedgerHashes
- NegativeUNL
- Offer
- PayChannel
- RippleState
- SignerList
- Ticket
- Transaction Formats
- Transaction Common Fields
- Transaction Types
- AccountSet
- AccountDelete
- CheckCancel
- CheckCash
- CheckCreate
- DepositPreauth
- EscrowCancel
- EscrowCreate
- EscrowFinish
- OfferCancel
- OfferCreate
- Payment
- PaymentChannelClaim
- PaymentChannelCreate
- PaymentChannelFund
- SetRegularKey
- SignerListSet
- TicketCreate
- TrustSet
- Pseudo-Transactions
- EnableAmendment
- SetFee
- UNLModify
- Transaction Results
- tec Codes
- tef Codes
- tel Codes
- tem Codes
- ter Codes
- tes Success
- Transaction Metadata
- rippled Commandline Usage Reference
- Peer Port Methods
- Health Check
- Peer Crawler
- Validator List Method
- XRP-API
- All XRP-API Methods
- Query Methods
- Get Account Info
- Get Account Settings
- Get Account Transactions
- Get Transaction
- Transact Methods
- Prepare a Payment
- Sign and/or submit a payment
- Create, sign, and submit a payment
- Meta Methods
- Get Server Info
- Get API Docs
- Ping
- XRP-API Data Types
- RippleAPIError
- ErrorItem
- ServerInfo
- RippledServerInfo
- Load
- LastClose
- ServerState
- ValidatedLedger
- Address
- TransactionID
- PreparedPaymentTransaction
- AppliedTransaction
- AccountInfo
- AccountSettings
- AccountTransactions
- AccountData
- LedgerIndex
- Payment object and instructions
- Payment Object
- Amount
- Currency
- Transaction Instructions
- TransactionStatus
- Transaction Common Fields
- PaymentTransaction
- Signed Transaction
- ApiDoc
- RippleAPI Reference
- Ripple Data API v2
- xrp-ledger.toml File
- Dev Tools
- xrp-ledger-rpc-tool.html
- websocket-api-tool.html
- data-api-v2-tool.html
- xrp-ledger-toml-checker.html
- validator-domain-verifier.html
- xrp-testnet-faucet.html
- tx-sender.html
- XRP Ledger Explorer