Documentation

Documentation

Documentation

API Documentation

API Documentation
API Documentation

Search

API Reference

API Reference

API Reference

Liquidity & Routing API

Liquidity & Routing API

Liquidity & Routing API

The Liquidity & Routing API exposes Helios’s aggregation and optimization layer.
It allows applications to inspect available liquidity, simulate routes, estimate costs, and control how executions are constructed before submission.


Query Aggregated Liquidity

You can query aggregated liquidity across supported protocols and chains.

const liquidity = await helios.liquidity({
  asset: "USDC",
  chain: "ethereum",
});

The response includes available depth, supported venues, and liquidity distribution.
This endpoint does not simulate execution.


Route Simulation

Route simulation evaluates how an execution would be routed under current market conditions.

const simulation = await helios.simulate({
  asset: "USDC",
  amount: "4500",
  fromChain: "ethereum",
  toChain: "arbitrum",
});

Simulation returns:

  • Candidate routes

  • Estimated slippage

  • Gas and fee estimates

  • Risk-adjusted execution paths

No transactions are created or submitted.


Slippage & Fee Estimation

Helios calculates expected slippage and fees as part of simulation.

simulation.routes[0].estimates

Estimates account for:

  • Liquidity depth

  • Route splitting

  • Protocol fees

  • Network conditions

Estimates are probabilistic and may change between simulation and execution.


Multi-Route Execution

For large or complex transactions, Helios may split execution across multiple routes to reduce slippage.

const execution = await helios.execute({
  asset: "USDC",
  amount: "4500",
  fromChain: "ethereum",
  toChain: "arbitrum",
  options: {
    allowMultiRoute: true
  }
});

When enabled, Helios automatically determines:

  • Number of splits

  • Allocation per route

  • Execution order

Multi-route execution is transparent to the caller.


Optimization Parameters

You can control how Helios optimizes routing decisions.

const simulation = await helios.simulate({
  asset: "USDC",
  amount: "4500",
  fromChain: "ethereum",
  toChain: "arbitrum",
  options: {
    optimizeFor: "cost", // cost | speed | reliability
    maxSlippage: 0.5,
    riskLevel: "balanced"
  }
});

Optimization parameters influence route selection but never override safety constraints.


Routing Response Structure

Each route includes structured metadata.

{
  "routeId": "rt_10291",
  "protocols": ["UniswapV3", "BridgeX"],
  "estimatedSlippage": 0.42,
  "estimatedGas": 183210,
  "confidenceScore": 0.91
}

Routes are ordered by optimization priority.

Create a free website with Framer, the website builder loved by startups, designers and agencies.