REST API reference

Generated from the live OpenAPI schema by scripts/gen_api_reference.py — do not edit by hand. Interactive docs are served at /api/docs and the raw schema at /api/openapi.json. All endpoints require an authenticated session unless noted otherwise.

(untagged)

Method	Path	Summary
GET	/api/health	Health

account

Method	Path	Summary
GET	/api/account/{session}	Account Snapshot

auth

Method	Path	Summary
POST	/api/auth/login	Login
POST	/api/auth/logout	Logout
GET	/api/auth/me	Me
GET	/api/auth/needs-setup	Needs Setup
POST	/api/auth/register	Register

backtests

Method	Path	Summary
GET	/api/backtests	List Backtests
POST	/api/backtests	Create Backtest
POST	/api/backtests/book	Create Book
POST	/api/backtests/cross-sectional	Create Cross Sectional
POST	/api/backtests/intraday-relval	Create Intraday Relval
POST	/api/backtests/pairs	Create Pairs
POST	/api/backtests/portfolio	Create Portfolio
POST	/api/backtests/portfolio-search	Create Portfolio Search
POST	/api/backtests/preview	Preview Backtest
DELETE	/api/backtests/{run_id}	Delete Backtest
GET	/api/backtests/{run_id}	Get Backtest
POST	/api/backtests/{run_id}/cost-stress	Run Cost Stress
POST	/api/backtests/{run_id}/montecarlo	Run Monte Carlo Analysis
PATCH	/api/backtests/{run_id}/notes	Update Notes
GET	/api/backtests/{run_id}/results	Get Backtest Results
POST	/api/backtests/{run_id}/validate-book	Validate Book

charts

Method	Path	Summary
GET	/api/charts	List Charts
POST	/api/charts	Create Chart
DELETE	/api/charts/{chart_id}	Delete Chart
GET	/api/charts/{chart_id}	Get Chart
PUT	/api/charts/{chart_id}	Update Chart

config

Method	Path	Summary
GET	/api/config	App Config

data

Method	Path	Summary
GET	/api/data/bars	Get Bars
GET	/api/data/catalog	Catalog Inventory
POST	/api/data/estimate-intraday	Estimate Intraday
POST	/api/data/ingest	Start Ingest
POST	/api/data/ingest-basket	Ingest Basket
POST	/api/data/ingest-crypto	Start Crypto Ingest
POST	/api/data/ingest-crypto-basket	Ingest Crypto Basket
POST	/api/data/ingest-intraday	Start Intraday Ingest
GET	/api/data/ingest/{job_id}	Ingest Status

gateway

Method	Path	Summary
GET	/api/gateway/health	Gateway Health
POST	/api/gateway/{session}/control	Control Gateway

help

Method	Path	Summary
POST	/api/help/ask	Ask

learn

Method	Path	Summary
POST	/api/learn/quick-check	Quick Check
POST	/api/learn/run-gauntlet	Run Gauntlet

reports

Method	Path	Summary
GET	/api/reports/performance	Performance

research

Method	Path	Summary
GET	/api/research/confidence	Confidence
GET	/api/research/report/{strategy_key}	Strategy Report
GET	/api/research/sweep-status	Sweep Status

session-history

Method	Path	Summary
DELETE	/api/session-history	Clear History
GET	/api/session-history	List Sessions
DELETE	/api/session-history/{session_id}	Delete Session
GET	/api/session-history/{session_id}	Session Detail

sessions

Method	Path	Summary
GET	/api/sessions/paper/runner	Paper Runner
POST	/api/sessions/paper/runner/stop	Stop Paper
POST	/api/sessions/paper/start	Start Paper
POST	/api/sessions/{session}/control	Queue Control
GET	/api/sessions/{session}/events	Session Events

settings

Method	Path	Summary
GET	/api/settings/keys	List Keys
DELETE	/api/settings/keys/{key}	Clear Key Value
PUT	/api/settings/keys/{key}	Set Key Value
POST	/api/settings/keys/{key}/test	Test Key Value

setup

Method	Path	Summary
GET	/api/setup-status	Setup Status

strategies

Method	Path	Summary
GET	/api/strategies	List Strategies

studio

Method	Path	Summary
POST	/api/studio/generate	Generate Strategy
GET	/api/studio/strategies	List Generated
POST	/api/studio/strategies	Save Generated
DELETE	/api/studio/strategies/{key}	Delete Generated
GET	/api/studio/strategies/{key}	Get Generated
DELETE	/api/studio/strategies/{key}/chat	Clear Chat
GET	/api/studio/strategies/{key}/chat	Get Chat
POST	/api/studio/strategies/{key}/chat	Post Chat
POST	/api/studio/validate	Validate Strategy