Skip to content

API Reference

RustyBT provides comprehensive API documentation in two formats:

Browse the full pdoc API documentation →

The pdoc documentation provides:

  • ✨ Interactive browsing with search functionality
  • 📖 Complete API coverage with all modules, classes, and functions
  • 🔍 Source code viewing inline with documentation
  • 🎯 Direct links to specific classes and methods
  • 📊 Type annotations and return types
  • 🏷️ 81.8% docstring coverage across the codebase

→ Open Interactive API Docs

📚 Structured API Guides

For topic-specific guides and workflows, explore our organized API documentation below:

Core Components

Component Description Link
Algorithm Main trading algorithm class pdoc
Data Portal Data access interface pdoc
Order Order creation and management pdoc
Position Portfolio position tracking pdoc
Pipeline Factor computation framework pdoc

💡 Usage Tips

Finding What You Need

  1. Browse by Module: Start from the main API page and navigate through modules
  2. Search: Use the search box in the pdoc docs to find specific functions or classes
  3. Guided Approach: Follow our structured guides above for workflow-based learning

Documentation Features

The pdoc documentation includes:

  • Google-style docstrings with clear parameter descriptions
  • Type hints showing expected input/output types
  • Usage examples embedded in docstrings
  • Cross-references linking related components
  • Inheritance trees showing class relationships

Getting Help

Bookmark the Interactive Docs

The interactive API documentation is updated with every commit and is the most comprehensive reference for RustyBT's API.