Route object schema

The normalized route shape returned by XROH.

Routes returned by XROH are normalized across engines.

{
  "route_id": "string",
  "engine_id": "X1|X2|X3",
  "source_chain": "string",
  "destination_chain": "string",
  "source_token": "string",
  "destination_token": "string",
  "input_amount": "string",
  "estimated_output": "string",
  "total_fee": "object|string",
  "estimated_time": "string|number",
  "liquidity_score": 0,
  "reliability_score": 0,
  "slippage_risk": 0,
  "scoring": {
    "output": 0,
    "fee": 0,
    "time": 0,
    "reliability": 0,
    "liquidity": 0,
    "slippage_penalty": 0,
    "final": 0
  }
}
circle-info

Field types can be tightened once your public API contract is finalized. Keep the shape stable for clients.

Last updated