API Endpoints & Schemas

API - Endpoints & Schemas

설계 원칙

• Additive-only Contract
• run_id 기반 상태 추적
• 오류 타입 분리 (user_error vs system_error)

---

Endpoints

Public

Method	Path	Description
GET	/	Dashboard UI
POST	/run_backtest	Submit backtest
GET	/status/<run_id>	Poll run status
GET	/health	Health check

(Optional) Strategy Management

Method	Path	Description
GET	/api/strategies	List presets
POST	/api/strategies	Create preset
DELETE	/api/strategies/	Delete preset

---

Run Backtest

Request

POST /run_backtest

{
  "ticker": "AAPL",
  "rule_type": "SMA_CROSS",
  "params": { "short": 20, "long": 60 },
  "start_date": "2020-01-01",
  "end_date": "2022-01-01"
}

Response

{
  "run_id": "uuid4",
  "status": "PENDING"
}

---

Status Response

{
  "run_id": "uuid4",
  "status": "SUCCEEDED",
  "metrics": { ... },
  "charts": {
    "equity_curve": "base64png..."
  }
}

---

Error Schema

{
  "error_type": "user_error",
  "message": "Invalid date range"
}

---

Status Lifecycle

PENDING → RUNNING → SUCCEEDED / FAILED

• forward-only transition
• 모든 변경은 UTC timestamp 기록