Public API Methods - 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

Dive into XRP Ledger technology and start integrating.

Documentation Index

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

Join the conversation

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

Search

Light/Dark Theme

Home
Public API Methods

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

Home

XRPL Overview

Use Cases & Featured Projects

History

Ledger Explorer

XRP

Impact

XRPL Foundation

FAQ

Documentation

Documentation Index

Concepts

Introduction

Introduction to Consensus

XRP

Software Ecosystem

Payment System Basics

Accounts

Cryptographic Keys

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

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

Freezing Tokens

Common Misunderstandings about Freezes

Rippling

Issuing and Operational Addresses

Paths

Decentralized Exchange

Offers

Consensus Network

Consensus Principles and Rules

Consensus Protections Against Attacks and Failure Modes

Invariant Checking

Transaction Queue

About Canceling a Transaction

Transaction Malleability

Amendments

Contribute Code to the XRP Ledger

Known Amendments

Consensus Research

Parallel Networks

XRP Ledger Servers

rippled Server Modes

Ledger History

Online Deletion

History Sharding

Transaction Censorship Detection

The Clio Server

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

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

Build A Browser Wallet Using JS

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 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

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

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

References

XRP Ledger Protocol Reference

Basic Data Types

base58 Encodings

Currency Formats

NFToken

Ledger Data Formats

Ledger Object IDs

Ledger Object Types

Check

Escrow

Offer

Ticket

Transaction Reference

Transaction Common Fields

Transaction Types

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

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

rippled Commandline Usage Reference

Peer Port Methods

Validator List Method

xrp-ledger.toml File

Browse By Label

Accounts

Checks

Decentralized Exchange

Escrow

Fees

Payment Channels

Payments

Smart Contracts

Security

Tokens

Transaction Sending

XRP

Dev Tools

RPC Tool

WebSocket API Tool

xrp-ledger.toml Checker

Domain Verification Checker

Transaction Sender

XRPL Learning Portal

Contribute to the XRPL Community

Contribute Code to the XRP Ledger

Tutorial Guidelines

Tutorial Structure

Events

Developer Funding

GitHub

About

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

Docs

Documentation
Documentation Index
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

© 2023 XRP Ledger. Open Source.