XRPL.org
  • About
    XRP Ledger
    XRPL Overview Use Cases & Featured Projects History
    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
    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 XRPL Brand Kit
    Current Status
    Ledger Explorer Known Amendments
    Join In
    Contribute Code Contribute Documentation
  • 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
  • Tutorials
  • HTTP / Websocket APIs

HTTP / Websocket APIs

XRPL tutorials for HTTP / Websocket APIs.

  • Get Started Using HTTP / WebSocket APIs

    Unleash the full power of the XRP Ledger's native APIs.

  • Monitor Incoming Payments with WebSocket

    Use the WebSocket API to actively monitor for new XRP payments (and more).

Documentation
Introduction
What is the XRP Ledger?
What is XRP?
Crypto Wallets
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
Digital Artist
Decentralized Finance
Algorithmic Trading
List XRP as an Exchange
Concepts
Networks and Servers
rippled Server Modes
Clustering
Ledger History
Peer Protocol
Transaction Censorship Detection
Parallel Networks
Amendments
The Clio Server
Consensus Protocol
Consensus Structure
Consensus Principles and Rules
Consensus Protections Against Attacks and Failure Modes
Invariant Checking
Fee Voting
Negative UNL
Consensus Research
Ledgers
Ledger Structure
Open, Closed, and Validated Ledgers
Ledger Close Times
Transactions
Fees (Disambiguation)
Reliable Transaction Submission
Secure Signing
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
Batch minting
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
Transfer Fees
Paths
Demurrage
Decentralized Exchange
Offers
Auto-Bridging
Tick Size
Automated Market Makers
Accounts
Account Types
Deleting Accounts
Reserves
Addresses
Cryptographic Keys
Multi-Signing
Deposit Authorization
Tickets
Tutorials
Public Servers
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
Use Tickets
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
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
Create an Automated Market Maker
References
XRP Ledger Protocol Reference
Basic Data Types
base58 Encodings
Currency Formats
NFToken
Ledger Data Formats
Ledger Header
Ledger Entry 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
AMMDelete
AMMDeposit
AMMVote
AMMWithdraw
CheckCancel
CheckCash
CheckCreate
Clawback
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
Binary 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
Compact Transaction Identifier
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_history
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
Peer Port Methods
Health Check
Peer Crawler
Validator List Method
xrp-ledger.toml File
Infrastructure
Commandline Usage
Installation
System Requirements
Install on CentOS/Red Hat with yum
Install on Ubuntu or Debian Linux
Install Clio on Ubuntu 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
Configuration
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
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
Configure Amendment Voting
Configure StatsD
Connect Your rippled to a Parallel Network
Configure gRPC
Enable Public Signing
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
Test Amendments
Run a Private Network with Docker
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
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
  • XRPL Brand Kit
  • 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
  • Report a Scam
XRPL.org  
© 2023 XRP Ledger. Open Source.