HYSTERESIS
Institutional surface

Documentation for evaluation, integration, and review

Begin with family overviews, schema surfaces, request boundaries, and sample responses.

Documentation group

Getting started

  • Overview
  • Request boundaries
  • Entitlements
Documentation group

API families

  • Oracle API
  • Structure API
  • Validation API
  • Stack API
Documentation group

Schemas

  • Field dictionaries
  • Schema versioning
  • Visibility classes
Documentation group

Replay and evidence

  • Replay model
  • Validation packs
  • Evidence chain
Documentation group

Security and boundaries

  • Read-only posture
  • Operator-only fields
  • Request access process
Documentation group

Changelog

  • Release notes
  • Schema changes
Sample response

oracle-latest-event.json

{
  "schema_version": "1.0",
  "family": "oracle",
  "sample": true,
  "as_of_utc": "2026-04-18T12:30:00Z",
  "visibility": "public-safe",
  "status": "OK",
  "event": {
    "event_id": "eo_fed_2026-03-18_statement_v1",
    "event_family": "fed",
    "release_time_utc": "2026-03-18T18:00:00Z",
    "state": "FINALIZED",
    "revision_status": "INITIAL_ONLY",
    "validation_status": "WINDOW_OPEN",
    "observed": {
      "target_range_upper_pct": 4.5,
      "target_range_lower_pct": 4.25,
      "statement_delta_class": "DOVISH_TILT"
    },
    "expected_linkage": {
      "consensus_source_count": 5,
      "consensus_anchor": "UNCHANGED_RANGE",
      "surprise_class": "LOW_NUMERIC_HIGH_TEXTUAL"
    },
    "meaning": {
      "macro_bias": "EASING_LEAN",
      "confidence": 0.77,
      "summary": "Statement language softened relative to prior release while target range remained unchanged."
    },
    "consequence": {
      "rates_path_tilt": "LOWER_FOR_LONGER_YIELD_PRESSURE",
      "risk_asset_tilt": "NEAR_TERM_SUPPORTIVE"
    },
    "signal": {
      "direction_bias": "RISK_ON_CONDITIONAL",
      "abstain": false,
      "abstain_reason": null
    }
  }
}
Sample response

structure-state.json

{
  "schema_version": "1.0",
  "family": "structure",
  "sample": true,
  "as_of_utc": "2026-04-18T12:30:01Z",
  "visibility": "public-safe",
  "status": "OK",
  "asset": "BTCUSDT",
  "structure_state": {
    "structure_state_id": "lv_btcusdt_2026-04-18T12:30:01Z",
    "regime": "VOID_PRESSURE_UP",
    "confidence": 0.71,
    "freshness_ms": 182,
    "signal_score": 0.68,
    "risk_flags": [
      "FEE_BLEED_ELEVATED"
    ],
    "gap_bps": 14.2,
    "effective_execution_block": "NONE",
    "entry_quality": "CONDITIONAL",
    "fee_bleed_risk": "MEDIUM",
    "storage_status": "HEALTHY"
  }
}
Sample response

validation-summary.json

{
  "schema_version": "1.0",
  "family": "validation",
  "sample": true,
  "as_of_utc": "2026-04-18T12:30:02Z",
  "visibility": "public-safe",
  "status": "OK",
  "asset": "BTCUSDT",
  "validation": {
    "decision_id": "soi_decision_2026-04-18T12:29:58Z_btcusdt",
    "validation_pack_id": "soi_valpack_2026-04-18T12:30:02Z",
    "policy_snapshot_id": "policy_2026-04-18_r15",
    "direction_bias": "SHORT_LEAN",
    "entry_state": "WATCH",
    "abstain_reason": "NO_REBOUND_TO_FADE",
    "confidence": 0.62,
    "risk_state": "YELLOW",
    "summary_metrics": {
      "mfe_bps_median": 31,
      "mae_bps_median": -18,
      "live_paper_divergence_bps": 4,
      "top_exit_reason": "TIME_EXIT",
      "top_route": "paper_observe"
    }
  }
}
Sample response

stack-context.json

{
  "schema_version": "1.0",
  "family": "stack",
  "sample": true,
  "as_of_utc": "2026-04-18T12:30:03Z",
  "visibility": "public-safe",
  "status": "OK",
  "stack_trace_id": "stack_btcusdt_2026-04-18T12:30:03Z_001",
  "asset": "BTCUSDT",
  "joined_context": {
    "oracle_ref": {
      "event_id": "eo_cpi_2026-04-10_release_v1",
      "macro_bias": "DISINFLATION_CONTINUES",
      "signal_bias": "RISK_SUPPORTIVE"
    },
    "structure_ref": {
      "structure_state_id": "lv_btcusdt_2026-04-18T12:30:01Z",
      "regime": "VOID_PRESSURE_UP",
      "confidence": 0.71,
      "freshness_ms": 182
    },
    "validation_ref": {
      "decision_id": "soi_decision_2026-04-18T12:29:58Z_btcusdt",
      "entry_state": "WATCH",
      "risk_state": "YELLOW",
      "confidence": 0.62
    }
  },
  "evidence_chain": {
    "replay_refs": [
      "eo_replay_2026-04-10_cpi_v1",
      "soi_replay_2026-04-18_btcusdt_r15"
    ],
    "validation_refs": [
      "eo_val_2026-04-10_cpi_24h",
      "soi_valpack_2026-04-18T12:30:02Z"
    ]
  }
}