.. _api_reference:

API Reference
=============

This section contains the technical reference for the core modules that make up the Backtest Engine.

Each module documents the available classes, functions, and behaviors that define how strategies are evaluated, portfolios are valued, and market data is processed.

What you'll find here:

- :ref:`Metrics_Module` – performance and evaluation metrics
- :ref:`Base_Backtest` – PyArrow-based backtesting and rebalancing engine
- :ref:`backtest_components_ref` – cost models, execution, interfaces, enums and orchestrators
- :ref:`data_pipeline_executor_ref` – central data validation and pipeline orchestration
- :ref:`portfolio_data_pipeline` – portfolio configuration and capital allocation rules
- :ref:`market_data_pipeline_ref` – new market data ingestion and preprocessing pipeline
- :ref:`CLI_Documentation` – command-line entry points and utilities

.. toctree::
   :maxdepth: 2
   :hidden:

   metrics
   base_backtest_rebalance_pyarrow
   backtest_components
   data_pipeline_executor
   portfolio_data_pipeline
   market_data_pipeline_orchestrator
   cli