backtest

API documentation for tradeexecutor.cli.commands.backtest.backtest Python function.

backtest(id=<typer.models.OptionInfo object>, name=<typer.models.OptionInfo object>, strategy_file=<typer.models.OptionInfo object>, state_file=<typer.models.OptionInfo object>, trading_strategy_api_key=<typer.models.OptionInfo object>, log_level=<typer.models.OptionInfo object>, unit_testing=<typer.models.OptionInfo object>, cache_path=<typer.models.OptionInfo object>, notebook_report=<typer.models.OptionInfo object>, html_report=<typer.models.OptionInfo object>, python_profile_report=<typer.models.OptionInfo object>, generate_report=<typer.models.OptionInfo object>, max_workers=<typer.models.OptionInfo object>)

Backtest a given strategy module.

• Run a backtest on a strategy module.

• Writes the resulting state file report, as it is being used by the webhook server to read backtest results

• Writes the resulting Jupyter Notebook report, as it is being used by the webhook server to display backtest results

Parameters:

• id (str) –

• name (Optional[str]) –

• strategy_file (Path) –

• state_file (Path) –

• trading_strategy_api_key (str) –

• log_level (str) –

• unit_testing (bool) –

• cache_path (Optional[Path]) –

• notebook_report (Optional[Path]) –

• html_report (Optional[Path]) –

• python_profile_report (Optional[Path]) –

• generate_report (Optional[bool]) –

• max_workers (Optional[int]) –