References and APIs

Client Libraries

Use these libraries to access the XRP Ledger from your programming language of choice.

• JavaScript / TypeScript Client Library
• Python Client Library
• Java Client Library
• Ruby Client Library

HTTP / WebSocket APIs

• API Conventions
• Public API Methods
• Admin API Methods
• Peer Port Methods

xrp-ledger.toml File

Provide machine-readable information about yourself to other XRP Ledger users.

Basic Data Types

Format and meaning of fundamental data types like addresses, ledger index, and currency codes.

• base58 Encodings
• Currency Formats
• NFToken

Ledger Data Formats

Learn about individual entries that comprise the XRP Ledger's shared state data.

• Ledger Header
• Ledger Entry Types

Transaction Reference

Definitions for all the protocol's transaction types and their results.

• Transaction Common Fields
• Transaction Types
• Pseudo-Transactions
• Transaction Results
• Transaction Metadata

Binary Format

Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects.