Oryn’s current public API surface is the orderbook and relayer. The quote API is part of the swap flow, but a stable public quote reference is not published yet.
API surfaces
| API | Purpose |
|---|
| Orderbook | Create orders, list orders, fetch order state, and read aggregate stats. |
| Relayer | Submit destination claim requests through the current claims endpoint. |
| Quote | Planned public reference; currently consumed by the app and orderbook flow. |
Response envelope
Most JSON responses use:
{
"status": "Success",
"result": {}
}
{
"status": "Error",
"result": "error message"
}
- Orderbook
GET /health returns plain text.
- Relayer
GET /health returns JSON.
Amounts
Use decimal strings for token amounts. Treat them as base-unit values unless an endpoint explicitly documents a display amount.
Do not use JavaScript floating point numbers for token amounts. Use strings, bigint, or a decimal library.
IDs
| ID | Meaning |
|---|
quote_id | Quote identifier consumed exactly once by order creation. |
order_id | Orderbook identifier used for reads and relayer claims. |
swap_id | Escrow vault address for an intent side. |
Status fields
The API still exposes contract-aligned field names such as create_tx_hash, claim_tx_hash, and cancel_tx_hash. In product copy, map them to:
Next references
- Generated Orderbook API pages are in the Orderbook API group.
- Generated Relayer API pages are in the Relayer API group.
- Error handling guidance is in Errors.
