Complete API reference for TzuTrader v0.7.0 - auto-generated from source code.
Overview
This API documentation provides exhaustive function signatures, types, and implementation details. For conceptual understanding and usage patterns, see the User Guide and Reference Guide.
Core Modules
tzutrader
Main module that exports all public APIs. Import this module to access all TzuTrader functionality.
tzutrader/core
Core data types: OHLCV bars, intervals, signals, and trade logs. Fundamental types used throughout the library.
tzutrader/data
Data loading and management: CSV I/O, mock data generation, and data streaming for large datasets.
tzutrader/indicators
Technical indicators: SMA, EMA, RSI, MACD, Bollinger Bands, ATR, and more. All indicators operate on OHLCV sequences.
tzutrader/strategy
Strategy framework: Base strategy types and built-in strategies including RSI, MA Crossover, MACD, and Bollinger Bands.
tzutrader/portfolio
Portfolio management: Position tracking, order execution, commission calculation, and accounting.
tzutrader/trader
Backtesting engine: Execute strategies on historical data, generate performance reports, and analyze results.
tzutrader/scanner
Multi-symbol scanning: Test strategies across multiple symbols, rank results, and identify opportunities.
tzutrader/exports
Export functionality: Convert backtest reports and scan results to JSON or CSV formats for analysis.
Documentation Organization
TzuTrader provides three levels of documentation:
- API Documentation (this site): Exhaustive function reference auto-generated from source code
- Reference Guide: Complete technical specifications with context and working examples
- User Guide: Conceptual introductions focused on learning and understanding
Start with the User Guide to learn concepts, use the Reference Guide for detailed specifications, and consult this API Documentation for exact function signatures and implementation details.
Quick Links
Generated from TzuTrader v0.7.0 source code using Nim's built-in documentation generator.