Skip to main content
The order book API is public and read-only. Offers come from on-chain rail terms (rate, currency) and each LP’s free escrow balance.

List offers

Filters: rail, currency, direction, minAmount, maxAmount. Only offer a rail the LP has terms for. An order on a rail with no registered payee cannot settle, and the user would find out only after paying.

Depth

Returns totalAvailableUsdc, totalLockedUsdc, offerCount, and the same per rail in byRail.

One provider

Returns available and locked USDC, completed orders, average fulfilment time, accepted rails and active orders.

One order

Returns the order’s parties, rail, currency, USDC and fiat amounts, status, creation and expiry times, and, once settled, the nullifier and transaction hash. See the order book API reference for every field.