Documentation

Documentation

Documentation

API Documentation

API Documentation
API Documentation

Search

API Reference

API Reference

API Reference

Risk Intelligence API

Risk Intelligence API

Risk Intelligence API

The Risk Intelligence API exposes real-time safety signals used by Helios to evaluate execution viability.
Risk signals inform routing decisions and can block execution when thresholds are exceeded.

Risk intelligence is advisory by default and enforcement-based when explicitly enabled.


Risk Model Overview

Helios evaluates risk across multiple dimensions before and during execution.

Risk signals may include:

  • Liquidity volatility

  • Protocol health indicators

  • Oracle dependencies

  • Governance or upgrade activity

  • Historical exploit patterns

Risk evaluation occurs at simulation time and again before execution.


Query Risk Signals

You can inspect current risk signals for a given asset, protocol, or chain.

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

This endpoint does not initiate execution.


Risk Response Structure

Risk responses are structured and machine-readable.

{
  "riskScore": 0.18,
  "riskLevel": "low",
  "factors": [
    {
      "type": "liquidity_volatility",
      "severity": "normal"
    },
    {
      "type": "oracle_dependency",
      "severity": "verified"
    }
  ],
  "executionAllowed": true
}

Lower risk scores indicate safer execution conditions.


Risk Levels

Risk levels control how strictly Helios enforces safety constraints.

options: {
  riskLevel: "conservative" | "balanced" | "aggressive"
}
  • conservative blocks execution under elevated uncertainty

  • balanced allows execution under normal market conditions

  • aggressive prioritizes execution availability over risk avoidance

Risk levels affect routing, not custody or signing behavior.


Risk-Aware Simulation

Risk signals are included in simulation responses.

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

Routes that violate risk constraints are excluded from simulation results.


Blocking Execution on Risk

You can require Helios to block execution if risk thresholds are exceeded.

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

When enforcement is enabled, Helios will refuse to execute unsafe routes.


Common Risk Errors

Risk-related failures return explicit error codes.

{
  "error": {
    "code": "RISK_THRESHOLD_EXCEEDED",
    "message": "Execution blocked due to elevated protocol risk"
  }
}

Risk errors are deterministic and safe to handle programmatically.

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