📚 API Reference¶

Complete API documentation for all SQA classes and modules.

Auto-Generated Documentation

This documentation is automatically generated from YARD comments in the source code. Last updated: 2025-11-24 17:07:39

🎯 SQA¶

📦 Backtest¶

📦 BadParameterError¶

Raised when a method parameter is invalid.

📦 Config¶

Configuration class for SQA settings.

📦 ConfigurationError¶

Raised when SQA configuration is invalid or missing.

📦 DataFetchError¶

Raised when unable to fetch data from a data source (API, file, etc.).

📦 DataFrame¶

High-performance DataFrame wrapper around Polars for time series data manipulation.

📦 Ensemble¶

Ensemble - Combine multiple trading strategies

🔧 FPOP¶

📦 GeneticProgram¶

🔧 MarketRegime¶

📦 MultiTimeframe¶

MultiTimeframe - Analyze patterns across multiple timeframes

📦 PatternMatcher¶

PatternMatcher - Find similar historical patterns

📦 PluginManager¶

📦 Portfolio¶

📦 PortfolioOptimizer¶

PortfolioOptimizer - Multi-objective portfolio optimization

📦 RiskManager¶

RiskManager - Comprehensive risk management and position sizing

🔧 SeasonalAnalyzer¶

📦 SectorAnalyzer¶

📦 Stock¶

Represents a stock with price history, metadata, and technical analysis capabilities.

📦 Strategy¶

This module needs to be extend'ed within

📦 StrategyGenerator¶

📦 Stream¶

📦 Ticker¶

sqa/lib/sqa/ticker.rb

📦 SQA::GeneticProgram¶

📦 Individual¶

Represents an individual trading strategy with specific parameters

📦 Top Level¶

📦 AlphaVantageAPI¶

📦 ApiError¶

Raised when an external API returns an error response.

📦 NotImplemented¶

Raised when a feature is not yet implemented.

🔧 SQA¶

Knowledge-Based Strategy using RETE Forward Chaining

📦 String¶

File: string.rb

📦 SQA::Backtest¶

📦 Results¶

Represents the results of a backtest

📦 SQA::Portfolio¶

📦 Position¶

Represents a single position in the portfolio

📦 Trade¶

Represents a single trade

📊 SQA::Strategy¶

📦 BollingerBands¶

Bollinger Bands trading strategy

🔧 Common¶

📦 Consensus¶

📦 EMA¶

📦 KBS¶

📦 MACD¶

MACD (Moving Average Convergence Divergence) crossover strategy

📦 MP ¶

📦 MR ¶

📦 RSI¶

📦 Random¶

📦 SMA¶

📦 Stochastic¶

Stochastic Oscillator crossover strategy

📦 VolumeBreakout¶

Volume Breakout strategy

📦 SQA::DataFrame¶

📦 AlphaVantage¶

📦 Data¶

Data class to store stock metadata

📦 YahooFinance¶

📊 SQA::StrategyGenerator¶

📦 Pattern¶

Represents a discovered indicator pattern

📦 PatternContext¶

Pattern Context - metadata about when/where pattern is valid

📦 ProfitablePoint¶

Represents a profitable trade opportunity discovered in historical data