API Reference

This section provides detailed API documentation for the StockCharts package, automatically generated from source code docstrings.

Core Modules

• Divergence Detection - RSI/Price divergence detection algorithms
• Pivot Detection - Swing point and EMA-derivative pivot identification
• RSI Indicator - Relative Strength Index calculation
• Beta & Relative Strength - Rolling beta and market regime detection
• Screener - Heiken Ashi stock screening and filtering logic
• Beta Regime Screener - Risk-on/risk-off regime screening
• Data Fetching - Market data retrieval and caching
• Heiken Ashi Runs - Run length and percentile statistics for trend maturity

Usage

Import functions directly from their modules:

from stockcharts.indicators.divergence import detect_divergence
from stockcharts.indicators.rsi import compute_rsi
from stockcharts.indicators.pivots import ema_derivative_pivots
from stockcharts.indicators.beta import compute_rolling_beta, analyze_beta_regime
from stockcharts.screener.rsi_divergence import screen_rsi_divergence
from stockcharts.screener.beta_regime import screen_beta_regime

For complete usage examples, see the Quick Reference, RSI Divergence Guide, and Beta Regime Guide.