XRBitcoinCashXRP Ledger trading & tools
API v1 · Developer preview

XRBC Developer
API Workbench.

Run the public XRBC API, inspect the live result, then copy the request into your own dashboard or application. Market, liquidity and ledger reads are public and read-only.

Run live data Download OpenAPI

READ / MODEL / VERIFY
Live JSON first · Copyable code second · No custody

GET /api/v1/projectJSON
{
  "data": {
    "name": "XRBitcoinCash",
    "symbol": "XRBC",
    "circulatingSupply": null
  },
  "meta": {
    "network": "XRPL Mainnet",
    "apiVersion": "1.0.0"
  }
}
Abbreviated example only. Unknown data stays null.
DECORATIVE CODE STREAMNot live Render logs or ledger activity.
Public JSONMarket, pool, ledger and project reads
No API keyPublic endpoints work without wallet approval
XRPL MainnetValidated ledger checkpoints and evidence labels
Read-onlyNo signing, submission or custody by this API

What this page is for

Pull XRBC data into another application.

Use the live workbench below to see what each public endpoint actually returns. The useful values are summarized first; raw JSON and copyable request code remain available when you need implementation details.

Market snapshot

Read the current XRBC/XRP AMM reserves, funded direct order books, fee and estimated pool ratio from one validated ledger checkpoint.

GET /market/xrbcRun market data →

Pool health

Read direct XRP-pool reserves, AMM fee and the Liquidity Sentinel heuristic with modeled 10 XRP and 100 XRP impact.

GET /liquidityRun pool health →

Trade modeling

Compare a public, non-executable XRBC/XRP AMM and order-book estimate before handing execution to the wallet trading flow.

GET /market/xrbc/quoteModel 25 XRP →

Ledger evidence

Read a validated ledger checkpoint, supply obligations, project identity or tool catalog without requesting a wallet signature.

GET /ledger · GET /supply/xrbcCheck the ledger →
Public reads do not need Xaman. Wallet proof is only relevant to the advanced, XRBC-holding-gated report endpoints described under Gated reports.

Live API workbench

Run a real request. See the useful data first.

Checking API availability…

Choose what you want to inspect. The request goes to the deployed XRBC API. If the backend has been idle, the first response can take longer while the service starts.

Live resultNo request sent
Press Run live data to read the selected dataset.

Raw JSON response
No response yet.
Copy request code


Complete API reference
Find the route that returns the data you need.
Most users can start with the live workbench above. Open the full route catalog when you need request methods, gated-report routes, settlement checks or tokenization planning.
Browse all API routes 22 documented routes
Base URL: https://xrbitcoincash-github-io.onrender.com/api/v1 · Download OpenAPI


Coverage & access
Built around the tools you already use.
Holding thresholds apply to the signed wallet at the time of each protected request. A token symbol alone never identifies the qualifying asset.
ToolMinimum XRBCWhat v1 provides
Know the scope. Extended Auditor, Risk Lens and Sentinel Forensics return evidence with their full composite scores withheld. Advanced Tokenization reports missing external data. Watchtower returns a current snapshot; continuous monitoring and stored history are not hosted by this release.


Advanced · gated reports only
Wallet proof is not required for the public API.
What is this for?
Some advanced analysis tools require a minimum XRBC balance. For those routes only, the server needs temporary proof that the caller controls a specific XRPL address so it can recheck that address’s XRBC holdings. The sign-in does not send XRP or XRBC, does not expose a seed phrase, and is not needed for market, liquidity, ledger, supply or project data.
Developer implementation for gated reports
Gated-report authentication has not been checked.
This check only reads backend status. It does not request a wallet signature.
  1. Create a challenge. Send the wallet’s classic address and requested protected tool IDs to POST /auth/challenges.
  2. Approve a SignIn in Xaman. This proves control of the address; it does not submit a payment.
  3. Exchange the approved challenge for a five-minute session. Send the challenge ID and private challenge secret to POST /auth/sessions.
  4. Call the gated report. Send the bearer token. The server checks the signed address’s current XRBC holdings before the protected report.
Authorization: Bearer YOUR_SESSION_TOKEN
Content-Type: application/json
Keep session tokens in memory and discard them when finished. Never place wallet seeds, private keys or Xaman application secrets in frontend code.


Integration notes
Keep the evidence with the result.
  • Amounts: ledger amounts are decimal strings. Modeled outputs, ratios and concentration are approximate; do not convert exact invoice amounts to JavaScript numbers for comparison.
  • Freshness: use the returned ledger hash, index, close time and age. The API rejects stale ledger checkpoints. A quote estimate lasts 15 seconds and can change before signing.
  • Execution: this API does not sign or submit transactions. Build your integration around explicit wallet review and an executable quote from the trading flow.
  • Rate limits: 60 requests per IP per minute; 12 protected requests per session per minute; one protected request at a time. Honor Retry-After on 429/503 responses.
  • Receipt reuse: record accepted transaction hashes and invoice IDs in your own durable database before crediting an invoice.
  • Market coverage: AMM reserve ratios are not last-trade prices. This release does not publish a 24-hour trade volume, verified circulating supply or market cap.
  • Attribution: retain XRBitcoinCash attribution, source, timestamp and limitations when displaying results. Third-party reference feeds have their own terms.
For a larger integration or additional endpoint, contact XRBitcoinCash.


Data lifecycle
One service check. Requests only when you ask.
When this page opens it performs one lightweight status request so an idle backend can begin waking up. It does not poll continuously. Live datasets are requested only when you press Run live data.
  1. 01 / CHOOSESelect the dataset that answers your application’s question.
  2. 02 / RUNRead the live response, ledger checkpoint, freshness and limitations.
  3. 03 / INTEGRATECopy the request code and preserve the response’s source and timestamp in your own interface.
The Matrix background is visual only. It is not a Render log, transaction feed or API-health signal. The live workbench is the source of actual service output.


Cross-check independently
Follow the source.
Project identity is the currency and issuer together. Market references and tool outputs do not establish a listing, endorsement or independently audited project status.
Currency  5852626974636F696E6361736800000000000000
Issuer    rEjwniYhYR5QDZzK1a1x2359j8j8N43Ypw
Network   XRP Ledger Mainnet
Issuer on Bithomp ↗ · XRPL API documentation ↗ · Xaman documentation ↗



  
For developers & automated readers
Start with the published contracts.

  
Use the OpenAPI document for request schemas and response conventions. Cross-check project identity and provenance through the published resources below. Machine-readable metadata describes the project; it is not an endorsement, audit certificate or authorization to bypass access controls.

  
OpenAPI / JSON ↗Asset identity / TOML ↗AI provenance ↗Project metadata / JSON ↗





  
Build a safer XRP Ledger experience
Found a bug? Have a useful idea?

  
Tell us what failed, who it affects and what would make the tool more useful. Suggestions for safer wallet review, clearer evidence, accessibility and practical XRPL integrations are welcome.

  
  
  
Never send secrets. Do not include seed phrases, private keys, recovery codes, passwords, API credentials, bearer tokens, challenge secrets or confidential support content. Reports are reviewed according to severity and available resources; no response time, reward or implementation is promised. Code contributions may need separate written terms.