Overview

Start building on XRPL for free

Create an endpoint in under a minute. The Free plan includes 50 million compute units a month, and no credit card is required.

Try free

​

Network Support

Request format.

XRPL’s HTTP API is JSON-RPC shaped but not JSON-RPC 2.0: the body is {"method": "...", "params": [{...}]} with no jsonrpc or id field.

Over WebSocket, send {"id": 1, "command": "...", ...} with the parameters at the top level, as the xrpl.js and xrpl-py libraries do.

The JSON-RPC shaped request {"jsonrpc": "2.0", "id": 1, "method": "...", "params": [{...}]} is accepted over WebSocket as well.

Validated by default. Responses come from Clio, which serves validated ledger data. Requests that need the open ledger (ledger_current, submit, fee, or any request with "ledger_index": "current") are forwarded to rippled automatically.

Errors are answers. XRPL reports failures inside a 200 OK response as "status": "error" with an error token (for example lgrNotFound, actNotFound), an error_code and an error_message. Check result.status rather than the HTTP status.

Not served. sign, sign_for and channel_authorize take a secret key and are refused with unknownCmd; sign transactions client-side and send them with submit. path_find and the peer_status, consensus and server streams are not available.

WebSocket clients MUST respond to server ping frames, otherwise the connection will be closed and re-established every minute.

​

Getting Started

curl https://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE> \
    -X POST \
    -H "Content-Type: application/json" \
    -d '{"method":"account_info","params":[{"account":"rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De","ledger_index":"validated"}]}'

wscat -c wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>
> {"id":1,"command":"account_info","account":"rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De","ledger_index":"validated"}

import { Client } from "xrpl";

const client = new Client("wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>");
await client.connect();
const info = await client.request({ command: "server_info" });
console.log(info.result.info.complete_ledgers);
await client.disconnect();

​

Compute Units