API Reference

This section provides comprehensive documentation for all Planar.jl modules and functions.

Core Modules

Data Management

Data structures, persistence, and OHLCV data handling.

Engine

Core execution engine for backtesting, paper trading, and live trading.

Exchanges

Exchange interfaces and connectivity.

Instruments

Financial instrument definitions and management.

Strategies

Strategy base classes and interfaces.

Data Processing

Fetch

Data fetching and retrieval utilities.

Processing

Data processing and transformation functions.

Prices

Price data structures and utilities.

Collections

Specialized collection types and utilities.

Execution & Trading

Executors

Order execution and trade management.

Instances

Strategy instance management.

CCXT Integration

CCXT library integration and utilities.

Analysis & Optimization

Metrics

Performance metrics and analysis.

Optimization

Parameter optimization and hyperparameter tuning.

Strategy Tools

Utilities for strategy development.

Strategy Statistics

Statistical analysis of strategy performance.

Visualization & UI

Plotting

Charting and visualization functions.

Progress Bars

Progress tracking and display utilities.

Utilities

DataFrame Utils

DataFrame manipulation utilities.

Python Integration

Python interoperability functions.

Miscellaneous

Additional utility functions and helpers.

Quick Navigation

• Getting Started: See the Getting Started Guide
• Type System: Learn about Planar's Type System
• Strategy Development: Read the Strategy Guide
• Troubleshooting: Check the Troubleshooting Guide

See Also

• Exchanges - Exchange integration and configuration
• Config - Exchange integration and configuration
• Optimization - Performance optimization techniques
• Performance Issues - Troubleshooting: Performance optimization techniques
• Data Management - Guide: Data handling and management
• Exchanges - Data handling and management

Function Index

Each module page contains:

• Module overview and purpose
• Function signatures and descriptions
• Usage examples
• Related functions and cross-references

For specific function documentation, navigate to the appropriate module page above.