Expand description
Typed response shapes mirrored from the engine’s FastAPI surface.
Each type is narrow on purpose. We deserialize only the fields
the CLI actually renders; extra fields are tolerated via
#[serde(flatten)] extra, so the engine can evolve without
breaking us, and missing fields surface as Option::None.
Structs§
- Approaching
- A coin approaching an entry gate.
- Approaching
Feed GET /approachingenvelope.- Auto
Toggle Request - Request body for
POST /auto/toggle.enabled = trueasks the engine to enter Auto-mode (Plan-mode auto-accept);falseasks it to fall back to operator-confirm. The engine may refuse; read the reply’sstateto see what actually landed. - Auto
Toggle Response - Response body for
POST /auto/toggle. - Brief
GET /brief— the engine’s situational readout. Shape matches the real wire payload (seetests/fixtures/brief.json): a timestamp, a fear-greed reading, open positions + their snapshots, recent signals, coins approaching a gate, and the last macro cycle summary. The CLI renders a concise header line and optionally expands into the lists.- Component
Counts - Component
Health - Evaluation
GET /evaluate/{coin}— the gate-level verdict for a single coin. The real engine returns a flat object with per-layer decisions (seetests/fixtures/evaluate_sol.json); this struct mirrors that exactly.- Evaluation
Layer - One layer in an
/evaluate/{coin}response. The engine emits a numbered list; each entry includes whether the layer passed, an arbitraryvaluepayload (scalar or nested object), and a human-readabledetailstring that already summarizes the layer’s decision. - Execute
Request - Request body for
POST /execute. - Execute
Response - Response body for
POST /execute. - Health
- Response shape of
GET /health— unauthenticated. - HlRate
- Hyperliquid API rate snapshot, optionally reported by the
engine on
/v2/status. - Hyperliquid
Account - Hyperliquid
Account Position - Hyperliquid
Reconciliation - Hyperliquid
Reconciliation Drift - Hyperliquid
Status - Immune
Breaker - Immune
Report - Live
Canary Policy - Live
Canary Policy Phase - Live
Canary Policy Summary - Live
Canary Recommendation - Live
Certification - Live
Certification Drill - Live
Cockpit - Live
Cockpit Certification - Live
Cockpit Heartbeat - Live
Cockpit Immune - Live
Cockpit Preflight - Live
Cockpit Reconciliation - Live
Cockpit Records - Live
Control Response - Response body for live risk-reduction controls.
- Live
Evidence - Live
Evidence Artifact - Live
Execution Receipt - Live
Execution Receipts - Live
Preflight - Live
Preflight Check - Market
Quote - Operator
Context - Operator
Events Accepted - Response shape for
POST /operator/events(ADR-016). - Position
- A single open position.
- Positions
GET /positionsenvelope. Engine returns a list, optionally wrapped in{positions: [...]}depending on handler version; we accept both.- Pulse
GET /pulseenvelope.- Pulse
Event - One entry in the engine’s pulse stream. Events are semi-free-form;
the client only consumes
kind,coin,message,ts. - Recovery
Status - Runtime recovery state emitted by the paper engine after journal replay.
- Regime
GET /regime— either per-coin or whole-market depending on query. The engine returns a loose shape withregime,confidence, and auxiliary fields; we capture the core and flatten the rest.- Rejection
- A single rejection record.
- Rejections
Feed GET /rejectionsenvelope.- Risk
GET /risksummary. Field names mirror the engine’s real wire shape (seeengine/zero/api.py::get_riskand therisk.jsonfixture captured undertests/fixtures/).- Risk
Summary - Root
- Response shape of
GET /— unauthenticated version probe. - Runtime
Parity - Runtime
Parity Feedback - Runtime
Parity Live Shadow - Runtime
Parity Paper - V2Confidence
- Engine confidence sub-object on
/v2/status. - V2Market
- Market sub-object on
/v2/status. - V2Positions
- Positions sub-object on
/v2/status. - V2Status
GET /v2/status— the condensed engine summary used by the status bar. Shape mirrors the live wire format (seetests/fixtures/v2_status.json): a nested object with confidence/market/positions/today sub-objects, plus two list fields the engine uses for signals and blind spots.- V2Today
- Today-summary sub-object on
/v2/status.
Enums§
- Auto
State - Wire representation of the engine’s Auto-mode state, mirrored
from
zero_commands::AutoStatebut narrow on purpose: the engine client speaks in its own vocabulary so a dispatcher refactor on the CLI side does not reshape the HTTP surface. - Execute
Side - Direction of an
/executerequest. Wire format is the lowercase variant name viaserde(rename_all = "lowercase"); seeSelf::as_wirefor a stable string helper used by the doctor row + the(paper)suffix renderer.