/ docs / src / API / api.md
api.md
  1  # API Reference
  2  
  3  This section provides comprehensive documentation for all Planar.jl modules and functions.
  4  
  5  ## Core Modules
  6  
  7  ### [Data Management](../data.md)
  8  Data structures, persistence, and [OHLCV data](../guides/data-management.md#ohlcv-data) handling.
  9  
 10  ### [Engine](engine.md)
 11  Core execution engine for backtesting, paper trading, and live trading.
 12  
 13  ### [Exchanges](exchanges.md)
 14  Exchange interfaces and connectivity.
 15  
 16  ### [Instruments](instruments.md)
 17  Financial instrument definitions and management.
 18  
 19  ### [Strategies](strategies.md)
 20  Strategy base classes and interfaces.
 21  
 22  ## Data Processing
 23  
 24  ### [Fetch](fetch.md)
 25  Data fetching and retrieval utilities.
 26  
 27  ### [Processing](processing.md)
 28  Data processing and transformation functions.
 29  
 30  ### [Prices](prices.md)
 31  Price data structures and utilities.
 32  
 33  ### [Collections](collections.md)
 34  Specialized collection types and utilities.
 35  
 36  ## Execution & Trading
 37  
 38  ### [Executors](executors.md)
 39  Order execution and trade management.
 40  
 41  ### [Instances](instances.md)
 42  Strategy instance management.
 43  
 44  ### [CCXT Integration](ccxt.md)
 45  CCXT library integration and utilities.
 46  
 47  ## Analysis & Optimization
 48  
 49  ### [Metrics](../metrics.md)
 50  Performance metrics and analysis.
 51  
 52  ### [Optimization](optimization.md)
 53  Parameter optimization and hyperparameter tuning.
 54  
 55  ### [Strategy Tools](../API/strategytools.md)
 56  Utilities for [strategy](../guides/strategy-development.md) development.
 57  
 58  ### [Strategy Statistics](../API/strategystats.md)
 59  Statistical analysis of [strategy](../guides/strategy-development.md) performance.
 60  
 61  ## Visualization & UI
 62  
 63  ### [Plotting](../plotting.md)
 64  Charting and visualization functions.
 65  
 66  ### [Progress Bars](pbar.md)
 67  Progress tracking and display utilities.
 68  
 69  ## Utilities
 70  
 71  ### [DataFrame Utils](dfutils.md)
 72  DataFrame manipulation utilities.
 73  
 74  ### [Python Integration](python.md)
 75  Python interoperability functions.
 76  
 77  ### [Miscellaneous](misc.md)
 78  Additional utility functions and helpers.
 79  
 80  ## Quick Navigation
 81  
 82  - **Getting Started**: See the [Getting Started Guide](../getting-started/index.md)
 83  - **Type System**: Learn about [Planar's Type System](../types.md)
 84  - **Strategy Development**: Read the [Strategy Guide](../guides/strategy-development.md)
 85  - **Troubleshooting**: Check the [Troubleshooting Guide](../troubleshooting/index.md)
 86  
 87  
 88  ## See Also
 89  
 90  - **[Exchanges](../exchanges.md)** - Exchange integration and configuration
 91  - **[Config](../config.md)** - Exchange integration and configuration
 92  - **[Optimization](../optimization.md)** - Performance optimization techniques
 93  - **[Performance Issues](../troubleshooting/performance-issues.md)** - Troubleshooting: Performance optimization techniques
 94  - **[Data Management](../guides/data-management.md)** - Guide: Data handling and management
 95  - **[Exchanges](../exchanges.md)** - Data handling and management
 96  
 97  ## Function Index
 98  
 99  Each module page contains:
100  - Module overview and purpose
101  - Function signatures and descriptions
102  - Usage examples
103  - Related functions and cross-references
104  
105  For specific function documentation, navigate to the appropriate module page above.