# Halyrd

## Docs

- [Evaluation: How Your Agent Earns the ELIGIBLE Status](https://docs.halyrd.xyz/agent/evaluation.md): Halyrd evaluates your agent on three criteria — positive expectancy after fees, a trade floor, and no max-drawdown breach — before marking it ELIGIBLE.
- [How the Halyrd Risk Engine and TWAK Guardrails Work](https://docs.halyrd.xyz/agent/risk-engine.md): Two independent layers protect your funds: the Risk Engine enforces your evaluation config, and TWAK guardrails enforce hard transaction limits.
- [Agent Status Lifecycle: PAPER, ELIGIBLE, LIVE, DEMOTED](https://docs.halyrd.xyz/agent/status-lifecycle.md): Follow your agent through every status transition — from paper trading to ELIGIBLE, to live on BSC, and back if risk limits are breached.
- [Strategy Versions: Auditable Configuration History](https://docs.halyrd.xyz/agent/strategy-versions.md): Each config change creates a new version with its own track record, so you can see which configurations were tried and which earned promotion to live.
- [Agent Endpoints: Status, Config, and Lifecycle Actions](https://docs.halyrd.xyz/api/agents.md): REST endpoints for reading agent status, updating config, managing the watchlist, and triggering promote, demote, and kill-switch lifecycle actions.
- [Backtest Endpoints: Run and Retrieve Strategy Results](https://docs.halyrd.xyz/api/backtests.md): Queue a StrategySpec backtest with POST /backtests and retrieve performance metrics and gate status with GET /backtests/{id} before promoting a strategy.
- [Evaluation Endpoint: Check Agent Eligibility Progress](https://docs.halyrd.xyz/api/evaluation.md): GET /agents/{id}/evaluation returns eligibility state, window progress, trade floor count, and all objective statuses for the running evaluation.
- [Halyrd API Overview: REST Endpoints and Authentication](https://docs.halyrd.xyz/api/overview.md): The Halyrd API provides REST endpoints and a WebSocket stream for monitoring and controlling your trading agent — running locally on your machine.
- [Risk Endpoints: Live Objectives and Blocked Order Log](https://docs.halyrd.xyz/api/risk.md): Monitor live risk rule headroom with /risk/objectives and retrieve the full audit log of policy vetoes and TWAK signing-layer blocks with /risk/blocks.
- [Trades, Equity, and Journal: Agent History Endpoints](https://docs.halyrd.xyz/api/trades-equity.md): Fetch equity snapshots, full trade history, and the agent journal with GET /agents/{id}/equity, /trades, and /journal — filter by phase or paginate.
- [WebSocket API: Real-Time Agent Events and Streaming](https://docs.halyrd.xyz/api/websocket.md): Connect to /ws/agents/{id} to receive live equity snapshots, trades, journal entries, risk vetoes, and lifecycle events as they happen.
- [Evaluation Presets: Configure Risk Thresholds for Your Agent](https://docs.halyrd.xyz/configuration/evaluation-presets.md): Choose an evaluation preset — Conservative, Balanced, Aggressive, or Custom — to set your agent's drawdown limits, trade floor, and evaluation window.
- [StrategySpec DSL: Define Your Trading Strategy in YAML](https://docs.halyrd.xyz/configuration/strategy-spec.md): The StrategySpec YAML format lets you declare entry and exit rules, regime filters, and position-sizing parameters for both backtesting and live trading.
- [Watchlist: Select the Tokens Your Agent Monitors and Trades](https://docs.halyrd.xyz/configuration/watchlist.md): Set the tokens your Halyrd agent monitors and trades. The watchlist is versioned, syncs with the TWAK allowlist automatically, and updates at runtime.
- [Core Concepts: Understanding How Halyrd Agents Work](https://docs.halyrd.xyz/core-concepts.md): Understand paper trading, the evaluation lifecycle, risk layers, strategy specs, and the promotion model before running your first live trade.
- [Agent Journal: Plain-English Reasoning for Every Decision](https://docs.halyrd.xyz/dashboard/journal.md): The Halyrd journal records every trade, skip, risk breach, and lifecycle event with a plain-English explanation — so you always know what your agent did.
- [Dashboard Overview: Monitor Your Trading Agent in Real Time](https://docs.halyrd.xyz/dashboard/overview.md): The Halyrd dashboard shows equity curve, evaluation progress, trade history, and agent status — all updating live via WebSocket as your agent runs.
- [Risk Desk: Visualize Your Two-Layer Defense in Action](https://docs.halyrd.xyz/dashboard/risk-desk.md): The risk desk shows Risk Engine policy vetoes and TWAK signing-layer blocks side by side, including what each defense layer has blocked in real time.
- [Strategy Builder: Design and Backtest a Trading Strategy](https://docs.halyrd.xyz/dashboard/strategy-builder.md): Describe a trading goal in plain language, generate a StrategySpec, run in-sample and out-of-sample backtests, then attach the strategy to a new agent.
- [How to Handle Your Agent's Demotion After a Risk Breach](https://docs.halyrd.xyz/guides/handle-demotion.md): Understand why your agent was demoted, what it does during the lockout, and how to re-approve it for live trading after a max-drawdown breach.
- [Kill Switch: Instantly Revoke Your Agent's Signing Rights](https://docs.halyrd.xyz/guides/kill-switch.md): Activate the kill switch to immediately revoke the TWAK session — your agent physically cannot sign any transactions until you restore it.
- [On-Chain Identity: Your Agent's ERC-8004 Profile on BSC](https://docs.halyrd.xyz/guides/on-chain-identity.md): Register your Halyrd agent's ERC-8004 identity on BNB Chain testnet for a verifiable on-chain track record linked to your agent's profile.
- [How to Promote Your Agent to Live Trading on BNB Chain](https://docs.halyrd.xyz/guides/promote-to-live.md): Review your agent's evaluation results and manually promote it to live BSC trading with a single confirmation — your keys never leave your machine.
- [Halyrd: Self-Custodial AI Trading Agent for BNB Chain](https://docs.halyrd.xyz/introduction.md): Learn what Halyrd is, how paper trading and live promotion work, and why two independent safety layers protect your funds at all times.
- [Quickstart: Get Halyrd Paper-Trading in Under 10 Minutes](https://docs.halyrd.xyz/quickstart.md): Install Halyrd, configure your wallet and API secrets, and have your first agent paper-trading on live BSC markets in five simple steps.