Documentation Index
Fetch the complete documentation index at: https://docs.ratiofx.com/llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/execute
Submits a firm quote for atomic on-chain settlement. The swap settles on the Kaia blockchain and the output stablecoin is delivered to the destination address you specify.Request body
Quote ID from
POST /v1/firm-quote. The quote must not have expired.Execution amount in the source currency. Must be less than or equal to
max_size from the firm quote response.Kaia wallet address to receive the output stablecoin.
Optional partner-side reference for reconciliation.
Response 200 OK
Unique execution identifier. Use this for settlement reconciliation and webhook correlation.
The firm quote that was executed.
SETTLED confirms the swap is confirmed on-chain.Actual execution rate applied to the swap.
Amount debited in the source currency.
Amount credited in the destination currency, delivered to
destination_address.Total platform fee in the source currency.
Kaia blockchain transaction hash. Use this to verify settlement on-chain.
ISO 8601 timestamp of on-chain settlement.
Routing path used:
DIRECT or EXTERNAL_RFQ.System state at time of execution.
GET /v1/system/state
Returns the current operating state for each corridor. Call this endpoint before requesting quotes to verify corridor availability, or use it to power status indicators in your UI.Response 200 OK
Overall system state, reflecting the highest severity state across all corridors.
Per-corridor state detail, keyed by currency pair.
State definitions
| State | Meaning |
|---|---|
NORMAL | Full functionality. Standard spreads. Both directions available. |
PROTECT | Spreads widened. Maximum size reduced. Both directions still available. |
RESTRICT | Maximum spread applied. One direction only. Reduced maximum size. |
HALT | No new quotes accepted. Existing positions settle normally. |
When a corridor is in
HALT state, POST /v1/firm-quote returns a QUOTE_HALTED error for that corridor. Use this endpoint to monitor recovery before retrying.