overlap
Calculate and overlay technical indicators—moving averages, VWAP, Parabolic SAR, Fibonacci levels, support/resistance, and candlestick patterns—directly on price data without fetching prices first.
Instructions
Overlap technical indicators drawn over the price (moving averages: get_moving_average with method='simple' (default), 'exponential', 'double_exponential', 'triangular', 'weighted' or 'hull', and the Kaufman adaptive moving average; TRIX, VWAP, Parabolic SAR, pivot points, Fibonacci retracement levels, support and resistance levels). Applied to price data automatically — no need to fetch prices first. Each indicator needs its window of history before it produces values, so the first periods after start_date can be empty and quarterly or yearly periods with long windows can be empty on short histories; start earlier to warm up. Bollinger Bands and Keltner Channels are in the volatility tool. get_candlestick_patterns recognises 15 candlestick patterns with TA-Lib's definitions (doji, hammer, hanging man, inverted hammer, shooting star, engulfing, harami, piercing line, dark cloud cover, morning and evening star, three white soldiers, three black crows, marubozu, spinning top), 1 for a bullish and -1 for a bearish pattern per period (0.8 for the weaker engulfing and harami); patterns='Hammer,Engulfing' returns only those, and signals_only=true only the periods with a pattern (with limit=-5 the last five). Requires tickers='AAPL' — use comma-separated values for multiple tickers. For the predictive power of these indicators across tickers (factor analysis), use the momentum tool with indicator='get_factor_analysis' and metrics='overlap'.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"indicator": "<indicator>"
},
"name": "overlap"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lag | No | Number of periods to lag when computing growth rates. | |
| rank | No | true ranks the tickers (or countries) within every period, from the highest value (rank 1) to the lowest, and compares each with its neighbour toward the middle of the ranking: the Difference (in points for returns) and the Multiple (only when both have the same sign), so the first and last rank show how far the best and the worst stand apart, e.g. a fall more than twice as large as the next one. Needs a value per period and ticker; pick one field with show_columns where there are more. | |
| limit | No | The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead, and rows per ticker (an earnings calendar) are selected per ticker. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row. | |
| trend | No | Whether to compute retracement levels for an "uptrend" (levels measured down from the high — the conventional direction, used when a prior move was up and price is now pulling back) or a "downtrend" (levels measured up from the low, used when a prior move was down and price is now bouncing). | uptrend |
| af_max | No | Maximum value the acceleration factor can reach. | |
| growth | No | Return period-over-period growth rates instead of absolute values. | |
| levels | No | The Fibonacci ratios to calculate levels for. | |
| method | No | The moving average: "simple", "exponential", "double_exponential", "triangular", "weighted" or "hull". | simple |
| period | No | Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). | daily |
| window | No | The number of periods the indicator looks back over, e.g. 14 or 20. Leave unset to use the default of the indicator you selected. Defaults are 14 for get_fibonacci_retracement_levels, get_moving_average, get_support_resistance_levels, get_volume_weighted_average_price; 10 for get_kaufman_adaptive_moving_average; 15 for get_trix. | |
| tickers | No | Comma-separated ticker symbols, e.g. 'AAPL,MSFT,GOOGL'. | |
| af_start | No | Initial acceleration factor. | |
| end_date | No | End of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window). | |
| patterns | No | The patterns to return, e.g. ["Hammer", "Engulfing"]. | |
| indicator | Yes | Name of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name. | |
| quarterly | No | Return quarterly data instead of annual when True. | |
| start_date | No | Start of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window). | |
| fast_window | No | The number of periods that corresponds to the fastest EMA constant used when the Efficiency Ratio is at its maximum (1.0). | |
| sensitivity | No | The sensitivity parameter to determine the significance of the peaks and valleys. A higher sensitivity value will result in fewer support and resistance levels being identified. | |
| slow_window | No | The number of periods that corresponds to the slowest EMA constant used when the Efficiency Ratio is at its minimum (0.0). | |
| standardize | No | Return the Z-Score (standard score) instead of the raw values, i.e. how many standard deviations each value is from the mean of its own series. When combined with growth=True, the growth values are standardized instead of the raw values. | |
| af_increment | No | Amount by which the acceleration factor increases every time a new extreme point is reached. | |
| close_column | No | The column name for closing prices in the historical data. | Adj Close |
| show_columns | No | Comma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage. | |
| signals_only | No | get_signals and get_candlestick_patterns only: set to true to return only the periods with a signal or pattern, e.g. with limit=-5 for the last five. | |
| benchmark_ticker | No | Ticker used as the market benchmark, e.g. 'SPY' or '^GSPC'; 'None' for no benchmark. | SPY |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |