0
# Overlay Indicators
1

2
Price overlays and support/resistance indicators that are plotted directly on price charts to identify trend direction, support/resistance levels, and potential entry/exit points.
3

4
## Capabilities
5

6
### Parabolic SAR
7

8
Trend-following indicator that provides stop-and-reverse points for position management.
9

10
```python { .api }
11
def get_parabolic_sar(quotes: Iterable[Quote], acceleration_factor: float = 0.02, max_acceleration_factor: float = 0.2):
12
    """
13
    Parabolic SAR - stop and reverse points for trend following.
14

15
    Args:
16
        quotes (Iterable[Quote]): Historical price quotes
17
        acceleration_factor (float): Initial acceleration factor (defaults to 0.02)
18
        max_acceleration_factor (float): Maximum acceleration factor (defaults to 0.2)
19

20
    Returns:
21
        ParabolicSarResults[ParabolicSarResult]: Collection of Parabolic SAR results
22
    """
23
```
24

25
### SuperTrend
26

27
Trend-following overlay using ATR-based dynamic support and resistance levels.
28

29
```python { .api }
30
def get_super_trend(quotes: Iterable[Quote], lookback_periods: int = 10, multiplier: float = 3.0):
31
    """
32
    SuperTrend - ATR-based trend following indicator.
33

34
    Args:
35
        quotes (Iterable[Quote]): Historical price quotes
36
        lookback_periods (int): ATR calculation periods (defaults to 10)
37
        multiplier (float): ATR multiplier for distance (defaults to 3.0)
38

39
    Returns:
40
        SuperTrendResults[SuperTrendResult]: Collection of SuperTrend results
41
    """
42
```
43

44
### Ichimoku Cloud
45

46
Comprehensive trend analysis system with multiple components for support/resistance and momentum.
47

48
```python { .api }
49
def get_ichimoku(quotes: Iterable[Quote], tenkan_periods: int = 9, kijun_periods: int = 26, 
50
                 senkou_b_periods: int = 52, senkou_offset: int = None, chikou_offset: int = None):
51
    """
52
    Ichimoku Cloud - comprehensive trend analysis system.
53

54
    Args:
55
        quotes (Iterable[Quote]): Historical price quotes
56
        tenkan_periods (int): Tenkan-Sen (conversion line) periods (defaults to 9)
57
        kijun_periods (int): Kijun-Sen (base line) periods (defaults to 26)
58
        senkou_b_periods (int): Senkou Span B periods (defaults to 52)
59
        senkou_offset (int): Leading span offset periods (optional)
60
        chikou_offset (int): Chikou span offset periods (optional)
61

62
    Returns:
63
        IchimokuResults[IchimokuResult]: Collection of Ichimoku results
64
    """
65
```
66

67
### Williams Alligator
68

69
Bill Williams' trend-following system using three smoothed moving averages.
70

71
```python { .api }
72
def get_alligator(quotes: Iterable[Quote], jaw_periods: int = 13, teeth_periods: int = 8, lips_periods: int = 5):
73
    """
74
    Williams Alligator - three smoothed moving averages for trend analysis.
75

76
    Args:
77
        quotes (Iterable[Quote]): Historical price quotes
78
        jaw_periods (int): Jaw line periods (defaults to 13)
79
        teeth_periods (int): Teeth line periods (defaults to 8)
80
        lips_periods (int): Lips line periods (defaults to 5)
81

82
    Returns:
83
        AlligatorResults[AlligatorResult]: Collection of Alligator results
84
    """
85
```
86

87
### Aroon
88

89
Trend strength indicator measuring time since highest high and lowest low.
90

91
```python { .api }
92
def get_aroon(quotes: Iterable[Quote], lookback_periods: int = 25):
93
    """
94
    Aroon - measures trend strength using time since high/low.
95

96
    Args:
97
        quotes (Iterable[Quote]): Historical price quotes
98
        lookback_periods (int): Number of periods for calculation (defaults to 25)
99

100
    Returns:
101
        AroonResults[AroonResult]: Collection of Aroon results
102
    """
103
```
104

105
### Average Directional Index (ADX)
106

107
Measures trend strength without regard to trend direction.
108

109
```python { .api }
110
def get_adx(quotes: Iterable[Quote], lookback_periods: int = 14):
111
    """
112
    Average Directional Index (ADX) - measures trend strength.
113

114
    Args:
115
        quotes (Iterable[Quote]): Historical price quotes
116
        lookback_periods (int): Number of periods for calculation (defaults to 14)
117

118
    Returns:
119
        ADXResults[ADXResult]: Collection of ADX results
120
    """
121
```
122

123
### Chandelier Exit
124

125
Volatility-based trailing stop using ATR calculations.
126

127
```python { .api }
128
def get_chandelier(quotes: Iterable[Quote], lookback_periods: int = 22, multiplier: float = 3.0, 
129
                   type: ChandelierType = ChandelierType.LONG):
130
    """
131
    Chandelier Exit - ATR-based trailing stop indicator.
132

133
    Args:
134
        quotes (Iterable[Quote]): Historical price quotes
135
        lookback_periods (int): ATR calculation periods (defaults to 22)
136
        multiplier (float): ATR multiplier (defaults to 3.0)
137
        type (ChandelierType): Long or short exit type (defaults to LONG)
138

139
    Returns:
140
        ChandelierResults[ChandelierResult]: Collection of Chandelier Exit results
141
    """
142
```
143

144
### Pivot Points
145

146
Support and resistance levels calculated from previous period's OHLC data.
147

148
```python { .api }
149
def get_pivot_points(quotes: Iterable[Quote], window_periods: int = 1, 
150
                     point_type: PivotPointType = PivotPointType.STANDARD):
151
    """
152
    Pivot Points - support and resistance levels from previous period OHLC.
153

154
    Args:
155
        quotes (Iterable[Quote]): Historical price quotes
156
        window_periods (int): Number of periods for calculation (defaults to 1)
157
        point_type (PivotPointType): Calculation method (defaults to STANDARD)
158

159
    Returns:
160
        PivotPointsResults[PivotPointsResult]: Collection of Pivot Points results
161
    """
162
```
163

164
### ATR Stop Loss
165

166
Dynamic stop-loss levels based on Average True Range calculations.
167

168
```python { .api }
169
def get_atr_stop(quotes: Iterable[Quote], lookback_periods: int = 21, multiplier: float = 3.0, 
170
                 end_type: EndType = EndType.CLOSE):
171
    """
172
    ATR Stop Loss - dynamic stop levels using Average True Range.
173

174
    Args:
175
        quotes (Iterable[Quote]): Historical price quotes
176
        lookback_periods (int): ATR calculation periods (defaults to 21)
177
        multiplier (float): ATR multiplier for distance (defaults to 3.0)
178
        end_type (EndType): Use CLOSE or HIGH_LOW prices (defaults to CLOSE)
179

180
    Returns:
181
        AtrStopResults[AtrStopResult]: Collection of ATR Stop results
182
    """
183
```
184

185
### Volatility Stop
186

187
Trend-following stop based on price volatility and trend direction.
188

189
```python { .api }
190
def get_volatility_stop(quotes: Iterable[Quote], lookback_periods: int = 7, multiplier: float = 3.0):
191
    """
192
    Volatility Stop - trend-following stop based on price volatility.
193

194
    Args:
195
        quotes (Iterable[Quote]): Historical price quotes
196
        lookback_periods (int): Volatility calculation periods (defaults to 7)
197
        multiplier (float): Volatility multiplier (defaults to 3.0)
198

199
    Returns:
200
        VolatilityStopResults[VolatilityStopResult]: Collection of Volatility Stop results
201
    """
202
```