API Documentation¶

AXON's complete Rust API documentation is automatically generated by cargo doc and published to docs.rs:

• axon-core
• axon-backtest
• axon-rl
• axon-hpo
• axon-walk-forward
• axon-distributed
• axon-tracker
• axon-registry
• axon-llm
• axon-cli
• axon-data
• axon-compliance
• axon-explain
• axon-ensemble
• axon-integration-tests

Local Generation¶

cargo doc --workspace --no-deps --open

Output is in the target/doc/ directory.

Key Types Quick Reference¶

axon-core¶

• Order / OrderId / OrderSide / OrderType / TimeInForce
• MarketData / Tick / Bar / OrderBook
• Event / EventQueue / SimulatedClock
• Portfolio / Position / Cash
• Scheduler / ImpactModel / LatencyModel / FeeModel

axon-backtest¶

• L1MatchingEngine / L2MatchingEngine / L3MatchingEngine
• BacktestConfig / BacktestResult

axon-rl¶

• AxonEnv (Gymnasium compatible)
• VecEnv (vectorized environment)
• Step / Reset / Action / Observation

axon-llm¶

• ReActAgent / Tool trait
• LLMBackend / OpenAICompatBackend / MockLLMBackend
• trading::PlaceOrderTool / QueryPortfolioTool / CancelOrderTool / ReplaceOrderTool
• trading::TradingBackend trait
• trading::RiskLimits / SafetyMode / RiskGate
• trading::TradingMetrics

axon-hpo¶

• OptunaHPO / SearchSpaceDef / SamplerConfig / PrunerConfig
• TrialResult / ParetoFront / Hypervolume

axon-exchange¶

• BinanceAdapter / OkxAdapter
• ExchangeConfig / RateLimitConfig / ReconnectConfig
• Order / Symbol / Side / OrderType

axon-explain¶

• KernelSHAP / CounterfactualGenerator
• ReportGenerator / ExplanationReport

axon-ensemble¶

• DynamicWeightedEnsemble / StackingEnsemble
• HardVoteStrategy / SoftVoteStrategy

Next Steps¶

• API Reference — Python API quick reference
• CLI Commands — Command-line interface
• Python Bindings — Using AXON from Python