Sandbox version
For experimental use only. Proceed with caution.
Documentation
Overview of Honeycluster documentation — conceptual guides, API reference, and tutorials.

Welcome to the Honeycluster documentation. Use the tabs above to switch between Docs (conceptual material), API Reference (live OpenAPI spec), and Tutorials (step-by-step walkthroughs).

Getting started
##
Core concepts
##
  • Architecture — how rippled, Clio, and the edge proxy fit together.
  • Networks — differences between mainnet, testnet, and devnet.
  • Authentication — API keys, scoping, and rotation.
  • Proxying Requests — why browser apps must proxy through a backend, with the explorer pattern as reference.
  • Rate Limits and Credits — how we meter usage and what the response headers mean.
  • WebSocket Protocol — connect, subscribe, and reconnect cleanly.
  • Error Codes — every error Honeycluster can return.
The Honeycluster suite
##

Beyond the API, Honeycluster ships a family of product apps on top of the same data plane:

  • Portal — account, projects, keys, and billing.
  • Explorer — XRP Ledger block explorer.
  • Stats — network-wide XRPL analytics.
  • Status — uptime and incidents.
  • Press — release notes and editorial.

See the Products index for more.

Learn by doing
##

Head to Tutorials for end-to-end walkthroughs covering historical queries, account subscriptions, server-side proxying, and React Query integration.