Apply for XRPL Grants, open until March 26.

 Apply for Funding

Apply for XRPL Grants, open

until March 26.Apply For Funding
XRPL.org
  • About
    XRP Ledger
    XRPL Overview Use Cases & Featured Projects History Ledger Explorer
    XRP
    XRP Overview
    Sustainability
    Impact
    About
    XRPL Foundation FAQ Privacy Policy
  • Docs
    Documentation icon

    Documentation

    Dive into XRP Ledger technology and start integrating.
    Article Types
    Concepts Tutorials References
    Online Tools
    Code Samples Dev Tools XRPL Learning Portal
    Get Started
    Python JavaScript Java HTTP / WebSocket
    Popular Pages
    Send XRP Reserves XRP Faucets Join UNL Build and Run rippled in Reporting Mode Introduction to Consensus API Methods
  • Community
    Contribute to the XRPL Community icon

    Contribute to the XRPL Community

    Join the conversation
    Events Ambassadors Developer Funding XRPL Jobs Dev Blog XRPL Grants GitHub Report a Scam
English
日本語
  • Home
  • Documentation
  • References
  • XRP-API

This page has been moved! You should be redirected automatically. If not, click here to go to the new XRP-API page.

Documentation
Concepts
Introduction
Introduction to Consensus
XRP
Software Ecosystem
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
Tokens
Trust Lines and Issuing
Authorized Trust Lines
Non-Fungible Tokens Overview
Trading NFTokens on the XRP Ledger
NFT Reserve Requirements
Batch minting
Authorizing Another Account to Mint Your NFTs
Running an NFT Auction
Minting NFTs into Collections
Guaranteeing a Fixed Supply of NFTs
Freezing Tokens
Common Misunderstandings about Freezes
Rippling
Transfer Fees
Issuing and Operational Addresses
Paths
Demurrage
Decentralized Exchange
Automated Market Makers
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
Federated Sidechains
XRP Ledger Servers
rippled Server Modes
Clustering
Ledger History
Online Deletion
History Sharding
Peer Protocol
Transaction Censorship Detection
The Clio Server
Interoperability
Introduction to EVM Compatible XRP Ledger Sidechain
Hooks
Tutorials
XRPL Quickstart
1. Create Accounts and Send XRP
2. Create Trust Line and Send Currency
3. Mint and Burn NFTokens
4. Transfer NFTokens
Broker a NFToken Sale
Assign an Authorized Minter
Batch Mint NFTokens
Get Started
Public Servers
Get Started Using Python
Get Started Using Java
Get Started Using JavaScript
Get Started Using HTTP / WebSocket APIs
Send XRP
Monitor Incoming Payments with WebSocket
Build Apps
Build a Desktop Wallet in Python
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
Use Tokens
Issue a Fungible Token
Trade in the Decentralized Exchange
Enable No Freeze
Enact Global Freeze
Freeze a Trust Line
XRP Ledger Businesses
List XRP as an Exchange
List Your Exchange on XRP Charts
Become a Stablecoin Issuer
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 in Reporting Mode
Capacity Planning
rippled v1.3.x Migration Instructions
Configure rippled
Run rippled as a Validator
Run rippled as a Stock Server
Configure Amendment Voting
Test Amendments
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
Diagnosing Problems with rippled
Health Check Interventions
Understanding Log Messages
rippled Server Doesn't Sync
rippled Server is Amendment Blocked
rippled Server Won't Start
Fix SQLite Transaction Database Page Size Issue
Manage the Clio Server
Install Clio on Ubuntu Linux
Interoperability - EVM Sidechain
Get Started with the EVM Sidechain
Connect MetaMask to XRP Ledger Sidechain
Join the XRP Ledger EVM Sidechain Devnet
EVM Sidechain Validator Security
Run a Validator Node on an EVM Sidechain
References
XRP Ledger Protocol Reference
Basic Data Types
base58 Encodings
Currency Formats
NFToken
Ledger Data Formats
Ledger Header
Ledger Object IDs
Ledger Object Types
AccountRoot
Amendments
AMM
Check
DepositPreauth
DirectoryNode
Escrow
FeeSettings
LedgerHashes
NegativeUNL
NFTokenOffer
NFTokenPage
Offer
PayChannel
RippleState
SignerList
Ticket
Transaction Reference
Transaction Common Fields
Transaction Types
AccountSet
AccountDelete
AMMBid
AMMCreate
AMMDeposit
AMMVote
AMMWithdraw
CheckCancel
CheckCash
CheckCreate
DepositPreauth
EscrowCancel
EscrowCreate
EscrowFinish
NFTokenAcceptOffer
NFTokenBurn
NFTokenCancelOffer
NFTokenCreateOffer
NFTokenMint
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
Serialization Format
Client Libraries
JavaScript / TypeScript Client Library
Migration Guide for ripple-lib 1.x to xrpl.js 2.x
Python Client Library
Java Client Library
Ruby Client Library
HTTP / WebSocket APIs
API Conventions
Request Formatting
Response Formatting
Error Formatting
Markers and Pagination
Rate Limiting
rippled Server States
Public API Methods
Account Methods
account_channels
account_currencies
account_info
account_lines
account_nfts
account_objects
account_offers
account_tx
gateway_balances
noripple_check
Ledger Methods
ledger
ledger_closed
ledger_current
ledger_data
ledger_entry
Transaction Methods
submit
submit_multisigned
transaction_entry
tx
tx_history
Path and Order Book Methods
amm_info
book_offers
deposit_authorized
nft_buy_offers
nft_sell_offers
path_find
ripple_path_find
Payment Channel Methods
channel_authorize
channel_verify
Subscription Methods
subscribe
unsubscribe
Server Info Methods
fee
manifest
server_info (rippled)
server_state
Clio Server
server_info
ledger
nft_info
Utility Methods
json
ping
random
Admin API 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
node_to_shard
Server Control Methods
ledger_accept
stop
validation_seed
Signing Methods
sign
sign_for
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
print
validator_info
validator_list_sites
validators
rippled Commandline Usage Reference
Peer Port Methods
Health Check
Peer Crawler
Validator List Method
XRP-API
xrp-ledger.toml File
Browse By Label
Accounts
AMM
Blockchain
Checks
Core Server
Cross-Currency
Data Retention
Decentralized Exchange
Development
Escrow
Fees
Payment Channels
Payments
Smart Contracts
Security
Tokens
Transaction Sending
XRP
Code Samples
Dev Tools
RPC Tool
WebSocket API Tool
xrp-ledger.toml Checker
Domain Verification Checker
XRP Faucets
Transaction Sender
XRPL Learning Portal
About
  • XRPL Overview
  • Use Cases & Featured Projects
  • History
  • Ledger Explorer
  • XRP Overview
  • Impact
  • XRPL Foundation
  • FAQ
  • Privacy Policy
Docs
  • Documentation
  • Concepts
  • Tutorials
  • References
  • Browse By Label
  • Code Samples
  • Dev Tools
  • XRPL Learning Portal
Community
  • Contribute to the XRPL Community
  • Contribute Code to the XRP Ledger
  • Events
  • Ambassadors
  • Developer Funding
  • XRPL Jobs
  • Dev Blog
  • XRPL Grants
  • GitHub
  • Report a Scam
XRPL.org  
© 2023 XRP Ledger. Open Source.