evaluate_paper_sessionCompute and persist validation metrics comparing a paper session to its backtest benchmark.
Area
Paper Trading
Group
Paper Trading
Access
Write
Risk
May change server state
Details
Full description
Details
Evaluate a paper trading session against its benchmark and record the result. This is a mutation, not a cheap read — it computes and persists validation metrics.
Returns — a readiness status plus readiness, which reports observed and required values for trades, bars, and calendar days. Product defaults require 5 trades, 500 bars, and 7 days unless the session stores custom criteria. The metrics dict includes:
paper_win_rate,paper_total_return,paper_trades,paper_barsbenchmark_win_rate,benchmark_total_return,benchmark_max_drawdown,benchmark_sharpe,benchmark_trade_countoverfitting_context.iteration_count(number of backtests at promotion time)
No verdict is returned. Compare the paper and benchmark numbers yourself and decide whether the strategy is ready for live promotion.
Capabilities
Bounded options and operating modes surfaced above the full JSON schema.
Required Inputs
session_idstringPaper trading session ID to evaluate. Get this from start_paper_trading() or list_paper_trading_sessions().