start_paper_tradingDeploy a compiled strategy on live market data with simulated fills and no real capital.
Area
Paper Trading
Group
Paper Trading
Access
Write
Risk
May change server state
Details
Full description
Details
Deploy a strategy on live market data without real capital. The session processes live bars, simulates fills with the configured fee/slippage, and tracks PnL as if trading.
Prerequisites — the strategy must be compiled (builder_compile) and ideally validated via run_backtest + get_current_signal_state to confirm it isn't already firing on stale signals.
Params — initial_cash (default 100000), fee_pct (e.g. 0.05 = 0.05%), slippage_pct. Omit both for the asset-aware defaults (0.00%/0.01% equities, 0.50%/0.05% crypto); equity sessions ALSO pay a per-symbol typical half-spread of 0.5-2bp on top, waived only when fee_pct and slippage_pct are BOTH sent as 0. The caller's email must be verified.
start_paper_trading(strategy_id) # → session_id, status
Monitor with get_paper_trading_session.
Capabilities
Bounded options and operating modes surfaced above the full JSON schema.
Notification Channel options
notification_channel
allemailpushRequired Inputs
strategy_idstringStrategy identifierOptional Inputs
alert_modebooleanStart this session in alert-only mode: notifies on entry fires instead of placing orders. The strategy's own exits/sizing/rebalance are compiled but inactive for this session — it is not mutated. Requires ALERT_MODE_ENABLED to be set.fee_pctanyOf (2 variants)Trading fee as percentage (0.1 = 0.1%). Omit to use the asset-aware default for this strategy's symbols; send 0 for a deliberately zero-fee session.initial_cashnumberInitial cash amountnotification_channelenum: all, email, pushAlert delivery preference for alert-mode sessions. 'all' sends to every enabled channel; 'email' sends only email; 'push' sends only registered push devices.slippage_pctanyOf (2 variants)Slippage as percentage (0.05 = 0.05%). Omit to use the asset-aware default; send 0 for zero slippage.