About

XRP Ledger
XRPL Overview Use Cases & Featured Projects History

XRP
XRP Overview

Sustainability
Impact

About
XRPL Foundation FAQ Privacy Policy
Docs

Documentation

Dive into XRP Ledger technology and start integrating.

Article Types
Introduction Use Cases Concepts Tutorials References Infrastructure

Get Started
Python JavaScript Java HTTP / WebSocket

Popular Pages
Send XRP Reserves XRP Faucets Join UNL Build and Run rippled in Reporting Mode API Methods
Resources

Development
Code Samples Dev Tools XRPL Learning Portal

Current Status
Ledger Explorer Known Amendments

Join In
Contribute Code Contribute Documentation
Community

Contribute to the XRPL Community

Join the conversation

Events Ambassadors Developer Funding XRPL Jobs Dev Blog XRPL Grants GitHub XRPL Brand Kit Report a Scam

Search

Light/Dark Theme

In this document

HTTP / WebSocket APIs

Home
Documentation
References
HTTP / WebSocket APIs

HTTP / WebSocket APIs

Communicate directly with rippled, the core peer-to-peer server that manages the XRP Ledger.

Introduction

What is the XRP Ledger?

Transactions and Requests

Software Ecosystem

Use Cases

Payments

Peer-to-Peer Payments

Restricting Deposits

Smart Contracts

Tokenization

Stablecoin Issuer

NFT Marketplace Overview

NFT Marketplace

Authorized Minter

Decentralized Finance

Algorithmic Trading

List XRP as an Exchange

Concepts

Networks and Servers

rippled Server Modes

Transaction Censorship Detection

Parallel Networks

The Clio Server

Consensus Protocol

Consensus Structure

Consensus Principles and Rules

Consensus Protections Against Attacks and Failure Modes

Invariant Checking

Consensus Research

Ledgers

Ledger Structure

Open, Closed, and Validated Ledgers

Ledger Close Times

Transactions

Fees (Disambiguation)

Reliable Transaction Submission

Source and Destination Tags

Transaction Cost

Transaction Queue

Finality of Results

Look Up Transaction Results

Transaction Malleability

Canceling a Transaction

Payment Types

Direct XRP Payments

Cross-Currency Payments

Checks

Escrow

Partial Payments

Payment Channels

Tokens

Non-Fungible Tokens

NFT Payload Storage

Trading NFTokens on the XRP Ledger

NFT Reserve Requirements

Authorizing Another Account to Mint Your NFTs

Running an NFT Auction

Minting NFTs into Collections

Guaranteeing a Fixed Supply of NFTs

NFT APIs

Trust Lines and Issuing

Authorized Trust Lines

Clawing Back Tokens

Freezing Tokens

Common Misunderstandings about Freezes

Rippling

Paths

Decentralized Exchange

Offers

Automated Market Makers

Accounts

Tickets

Deleting Accounts

Reserves

Cryptographic Keys

Deposit Authorization

Tutorials

Python

Get Started Using Python

Modular Tutorials in Python

Send Payments Using Python

Create Accounts and Send XRP Using Python

Create Trust Line and Send Currency Using Python

Create Time-based Escrows Using Python

NFTs Using Python

Mint and Burn NFTs Using Python

Transfer NFTs Using Python

Broker an NFT Sale Using Python

Assign an Authorized Minter Using Python

Batch Mint NFTs

Build a Desktop Wallet in Python

JavaScript

Get Started Using JavaScript

Modular Tutorials in JavaScript

Send Payments Using JavaScript

Create Accounts and Send XRP Using JavaScript

Create Trust Line and Send Currency Using JavaScript

Create Time-based Escrows Using JavaScript

Create Conditional Escrows Using JavaScript

NFTs Using JavaScript

Mint and Burn NFTs Using JavaScript

Transfer NFTs Using JavaScript

Broker an NFT Sale Using JavaScript

Assign an Authorized Minter Using JavaScript

Batch Mint NFTs Using JavaScript

Build a Browser Wallet in JavaScript

Build a Desktop Wallet in JavaScript

Java

Get Started Using Java

HTTP / Websocket APIs

Get Started Using HTTP / WebSocket APIs

Monitor Incoming Payments with WebSocket

Tasks

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

Send XRP

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

Cash a Check for an Exact Amount

Cash a Check for a Flexible Amount

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

Create an Automated Market Maker

References

XRP Ledger Protocol Reference

Basic Data Types

base58 Encodings

Currency Formats

NFToken

Ledger Data Formats

Ledger Entry Types

AMM

Check

Escrow

Offer

Ticket

Transaction Reference

Transaction Common Fields

Transaction Types

AMMBid

AMMVote

NFTokenAcceptOffer

NFTokenCancelOffer

NFTokenCreateOffer

Payment

PaymentChannelClaim

PaymentChannelCreate

PaymentChannelFund

TrustSet

Pseudo-Transactions

EnableAmendment

SetFee

Transaction Results

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

rippled Server States

Compact Transaction Identifier

Public API Methods

Account Methods

account_channels

account_currencies

account_objects

gateway_balances

Ledger Methods

ledger

Transaction Methods

submit

submit_multisigned

transaction_entry

tx

Path and Order Book Methods

deposit_authorized

nft_sell_offers

ripple_path_find

Payment Channel Methods

channel_authorize

Subscription Methods

Server Info Methods

fee

manifest

server_info (rippled)

Clio Server

ledger

nft_info

Utility Methods

json

ping

random

Admin API Methods

Key Generation Methods

validation_create

Logging and Data Management Methods

Server Control Methods

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

feature

print

validator_list_sites

Peer Port Methods

Validator List Method

xrp-ledger.toml File

Infrastructure

Commandline Usage

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 rippled on Linux, Mac, or Windows

Build and Run rippled in Reporting Mode

Capacity Planning

rippled v1.3.x Migration Instructions

Configure rippled

Server Modes

Run rippled as a Validator

Run rippled as a Stock Server

Data Retention

Configure Full History

Online Deletion

Configure Online Deletion

Configure Advisory Deletion

History Sharding

Configure History Sharding

Configure Amendment Voting

Test Amendments

Configure StatsD

Connect Your rippled to a Parallel Network

Enable Public Signing

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

Testing and Auditing

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

Install Clio on Ubuntu Linux

Run a Private Network with Docker

About

XRPL Overview
Use Cases & Featured Projects
History
XRP Overview
Impact
XRPL Foundation
FAQ
Privacy Policy

Docs

Documentation
Introduction
Use Cases
Concepts
Tutorials
References
Infrastructure

Resources

Resources
Code Samples
Dev Tools
XRPL Learning Portal
Ledger Explorer
Known Amendments
Contribute Code
Contribute Documentation

Community

Contribute to the XRPL Community
Events
Ambassadors
Developer Funding
XRPL Jobs
Dev Blog
XRPL Grants
GitHub
XRPL Brand Kit
Report a Scam

© 2023 XRP Ledger. Open Source.