OpenAPI Spec & Postman Collection

The full XRPL Request API is described as an OpenAPI 3.0 document and a Postman collection for easy testing and code generation.

OpenAPI spec

The spec is served directly from the app:

https://xrplre.quest/openapi.yaml

It covers all 12 API endpoints with full request/response schemas, error responses, enum values, and authentication requirements.

Use with code generators

# Generate a typed client with openapi-typescript
npx openapi-typescript https://xrplre.quest/openapi.yaml -o xrpl-request.d.ts
 
# Generate a Python client with openapi-generator
openapi-generator-cli generate \
  -i https://xrplre.quest/openapi.yaml \
  -g python \
  -o ./xrpl-request-client
 
# Generate a Go client
openapi-generator-cli generate \
  -i https://xrplre.quest/openapi.yaml \
  -g go \
  -o ./xrpl-request-client

Endpoints covered

Postman collection

Download and import the collection into Postman:

https://raw.githubusercontent.com/LedgerCraft/XRPL-Request/main/postman_collection.json

Or clone the repo and import postman_collection.json directly.

Quick start with Postman

1. Import the collection
2. Set the apiKey collection variable to your xrplr_live_... key
3. Run Create payload (signAndSubmit) — the payloadUuid variable is set automatically
4. Open signingUrl in a browser and sign with any wallet
5. Run Get payload to see the resolved status and txHash