Docs

API reference

Status & live

Health, engine config, totals and the open generation.

Note

Response blocks below are shapes: field names with their types, not real data.

GET /v1/health#

Response shape·json
{ "ok": "boolean", "engine": "string (e.g. forgeus-engine/1)" }

GET /v1/config#

The rules the engine runs with. Use it instead of hard-coding values.

Response shape·json
{
  "engine": "string",
  "params": { "gen_ticks": "number", "warmup": "number", "pop": "number", "cost_bps": "number", "dd_weight": "number", "idle_penalty": "number" },
  "markets": { "<market>": { "label": "string", "venue": "string", "chain_id": "number", "pool": "address", "dec0": "number", "dec1": "number", "invert": "boolean" } },
  "kinds": ["string"],
  "bounds": { "lookback": ["min", "max"], "threshold_bps": ["min", "max"], "size": ["min", "max"], "stop_bps": ["min", "max"] },
  "thresholds": { "min_generations": "number", "positive_share": "number", "max_drawdown": "number", "min_trades": "number", "beats_hold": "boolean" },
  "execution_live": "boolean (false today)"
}

GET /v1/stats#

Response shape·json
{
  "generations": "number (closed count)",
  "open_generation": "number",
  "population": "number",
  "active": "number",
  "challengers": "number",
  "eliminated": "number",
  "nulls": "number",
  "quotes": "number",
  "trades": "number",
  "last_close_ts": "number | null",
  "chain_tip": "string (last hash) | null",
  "execution_live": "boolean",
  "eligible": "number"
}

GET /v1/live#

The open generation scored on the quotes collected so far. It is not final: ranks change as quotes arrive.

Response shape·json
{
  "n": "number",
  "progress": { "<market>": { "have": "number", "need": "number" } },
  "quotes": { "<market>": { "price": "number", "block": "number", "ts": "number" } },
  "leaderboard": [
    { "id": "string", "kind": "string", "market": "string", "ret": "number", "maxdd": "number", "fitness": "number", "trades": "number", "pos": "number" }
  ]
}

Paper only. No funds are traded. $FOUS is not launched. Nothing here is financial advice.