Alert Scripting
Placeholders
Placeholders are strings that refer to a specific series of values or events, and have the form
The timezone for the time related placeholders is defined by the
Users can refer to a series of values outside the toolkit by using external placeholder. A maximum of 5 external placeholders can be used:
The
{placeholder_title}, where placeholder_title is the name of the placeholder to access and {} makes sure the string is recognized as a placeholder.
Placeholders allow accessing market data such as ohlc prices, volume, but also specific features from their respective toolkit such as signals, indicators…etc.
Common Placeholders
The placeholders below can be used in all the toolkits.Market Data Placeholders
Market data placeholder allows referencing typical market data such as ohlc prices and volume. These placeholders are available for all toolkits.| Placeholder | Description |
|---|---|
{open} | Open price of the bar |
{high} | High price of the bar |
{low} | Low price of the bar |
{close} | Close price of the bar |
{hl2} | Median price (high + low) / 2 |
{ohlc4} | Average price (open + high + low + close) / 4 |
{hlc3} | Typical price (high + low + close) / 3 |
{hlcc4} | Weighted average of hlc prices (high + low + 2 * close) / 4 |
{volume} | Volume for the bar |
{range} | Difference between High and Low prices |
{tr} | True Range |
Time Related Placeholders
Time placeholder allows referencing time related information such as the bar hour and minute, day, bar index…etc. These placeholders are available for all toolkits.| Placeholder | Description |
|---|---|
{barindex} | Index of the current bar |
{last_barindex} | Index of the most recent bar |
{second} | Current bar second |
{minute} | Current bar minute |
{hour} | Current bar hour |
{dayofweek} | Current bar day of the week ranging from 1 to 7, with 1 for sunday |
{dayofmonth} | Current bar day of the month |
{weekofyear} | Current bar week of the year |
{month} | Current bar month of the year |
{year} | Current bar year (with timezone) |
{unix_ts} | Unix timestamp of the bar |
{timeframe} | Chart timeframe in minutes |
{hhmm-hhmm} | Session placeholder, True when the bar is located within the specific session interval, see here for more information |
Note that
{dayofweek} returns the day based on the time of the bar’s open. For overnight sessions (e.g. EURUSD, where Monday session starts on Sunday, 17:00) this value can be lower by 1 than the day of the trading day.Timezone dropdown setting, defining the timezone using UTC. Default value is exchange, which uses the exchange timezones to get the value of the time related placeholders.
Session Placeholder
You can easily detect if the current bar is within a specific session (time interval) by using the session placeholder with pattern{hhmm-hhmm}, where hh is the hour and mm the minute.
The value of this placeholder will be True when the bar time is located between the start time {hhmm- and end time -hhmm.
For example, if we want to detect when the bar is located in the session starting at 14:30 and ending at 16:45 we would simply use:
Example
External Placeholders
Users can refer to a series of values outside the toolkit by using external placeholder. A maximum of 5 external placeholders can be used:
{external1}{external2}{external3}{external4}{external5}
Custom Alert Creator Placeholders
Placeholders referencing events from the custom alert creator in order to potentially create more complex alerts. These can either beTrue or False.
| Placeholder | Description |
|---|---|
{custom_alert_step} | Set conditions from the custom alert creator (except OR) |
{custom_alert_or} | OR condition from the custom alert creator |
Sequencing Placeholders
Alert scripting includes multiple placeholders helping user create and refine a sequence of conditions.| Placeholder | Description |
|---|---|
{step} | Current step in the ongoing sequence of conditions, with 0 being the first step |
{barssince_step} | Numbers of bars elapsed since last step or invalidation |
{invalidated} | True is previous bar had an invalidation event |
{step} placeholder is a special placeholder used to refer to the current step in a sequence of conditions defined in the scripted alert.
For more information, see here.
User Defined Placeholders (UDP)
User defined placeholders (UDPs) are custom placeholders defined by users and assigned to a specific condition set by the user. These placeholders can later be referenced as part of other conditions or UDPs. To define a UDP a line must start with a placeholder with a unique name, followed by an equal sign=, then followed by the condition we want to assign to this placeholder, for example my_placeholder} = {close} > {open}
Let’s take a more complex example and say we want to be alerted on a new bullish fair value gaps while we also had one on the previous bar.
Doing this could involve a long and messy script, to make things easier we can create an UDP that refers to the condition of a bullish fair value gaps, and reuse it for our alert condition:
Creating an UDP will not trigger an alert from its assigned condition.
Toolkit Placeholders
The placeholders below are unique to their respective toolkit, and refer to the toolkit features.Signals & Overlays Placeholders
Data Series Placeholders
| Placeholder | Description |
|---|---|
{barcolor} | Bar color value for confirmation signals, with 1 for green, -1 for red, and 0 for purple |
{ml_classifier} | ML Classifier value for signals, ranging from 1 to 4 |
{smart_trail} | Smart Trail value |
{smart_trail_extremity} | Smart Trail extremity value |
{rz_r3} | Reversal Zones Resistance 3 value |
{rz_r2} | Reversal Zones Resistance 2 value |
{rz_r1} | Reversal Zones Resistance 1 value |
{rz_s1} | Reversal Zones Support 1 value |
{rz_s2} | Reversal Zones Support 2 value |
{rz_s3} | Reversal Zones Support 3 value |
{catcher} | Trend Catcher value |
{os_catcher} | Value associated to the trend detected by the Trend Catcher, with 1 for uptrends, and 0 for downtrends |
{tracer} | Trend Tracer value |
{os_tracer} | Value associated to the trend detected by the Trend Tracer, with 1 for uptrends, and 0 for downtrends |
{neo_lead} | Neo Cloud lead line value |
{neo_lag} | Neo Cloud lagging line value |
{tp2} | Take profit 2 level value |
{tp1} | Take profit 1 level value |
{sl1} | Stop loss 1 level value |
{sl2} | Stop loss 2 level value |
{optimal_sensitivity} | Optimal sensitivity value |
{trend_strength} | Trend Strength percentage value |
{volatility} | Lux Volatility percentage value |
{squeeze} | Squeeze Index percentage value |
{volume_sentiment} | Volume Sentiment percentage value |
Trigger Placeholders
| Placeholder | Description |
|---|---|
{bullish_confirmation} | True on a new normal bullish confirmation signal |
{bullish_confirmation+} | True on a new strong bullish confirmation signal |
{bullish_confirmation_any} | True on a any new bullish confirmation signal |
{bullish_confirmation_turn+} | True when a normal bullish confirmation signal turns strong |
{bearish_confirmation} | True on a new normal bearish confirmation signal |
{bearish_confirmation+} | True on a new strong bearish confirmation signal |
{bearish_confirmation_any} | True on any new bearish confirmation signal |
{bearish_confirmation_turn+} | True when a normal bearish confirmation signal turns strong |
{bullish_contrarian} | True on a new normal bullish contrarian signal |
{bullish_contrarian+} | True on a new strong bullish contrarian signal |
{bullish_contrarian_any} | True on any new bullish contrarian signal |
{bearish_contrarian} | True on a new normal bearish contrarian signal |
{bearish_contrarian+} | True on a new strong bearish contrarian signal |
{bearish_contrarian_any} | True on any new bearish contrarian signal |
{exit_buy} | True on a new exit buy signal |
{exit_sell} | True on a new exit sell signal |
{bullish_smart_trail} | True if Smart Trail is up-trending |
{bearish_smart_trail} | True if Smart Trail is down-trending |
{switch_bullish_smart_trail} | True if Smart Trail switches to bullish |
{switch_bearish_smart_trail} | True if Smart Trail switches to bearish |
{price_above_rzr1} | True if the closing price is above the lower Reversal Zones resistance R1 |
{price_below_rzs1} | True if the closing price is below the upper Reversal Zones support S1 |
{price_co_rzr1} | True if the closing price cross over the lower Reversal Zones resistance R1 |
{price_cu_rzs1} | True if the closing price cross under the upper Reversal Zones support S1 |
{bullish_catcher} | True if Trend Catcher is up-trending |
{bearish_catcher} | True if Trend Catcher is down-trending |
{switch_bullish_catcher} | True if Trend Catcher switches to bullish |
{switch_bearish_catcher} | True if Trend Catcher switches to bearish |
{bullish_tracer} | True if Trend Tracer is up-trending |
{bearish_tracer} | True if Trend Tracer is down-trending |
{switch_bullish_tracer} | True if Trend Tracer switches to bullish |
{switch_bearish_tracer} | True if Trend Tracer switches to bearish |
{bullish_neo} | True if Neo Cloud is up-trending |
{bearish_neo} | True if Neo Cloud is down-trending |
{switch_bullish_neo} | True if Neo Cloud switches to bullish |
{switch_bearish_neo} | True if Neo Cloud switches to bearish |
{trend_strength_trending} | True if the Trend Strength indicates a trending market (Trend Strength above 50) |
{trend_strength_ranging} | True if the Trend Strength indicates a ranging market (Trend Strength below 50) |
Price Action Concepts Placeholders
Data Series Placeholders
| Placeholder | Description |
|---|---|
{internal_high} | Internal high levels value |
{internal_low} | Internal low levels value |
{swing_high} | Swing high levels value |
{swing_low} | Swing low levels value |
{itrend} | The trend value is determined by internal market structures, with positive values for uptrends and negative values for downtrends. In an uptrend, an Internal Change of Character (I-CHoCH) has a value of +1, while an Internal Break of Structure (I-BOS) has a value of +2. The same logic applies to downtrends but uses negative values instead (−1 for an I-CHoCH and −2 for an I-BOS). |
{strend} | The trend value is determined by swing market structures, with positive values for uptrends and negative values for downtrends. In an uptrend, a Swing Change of Character (S-CHoCH) has a value of +1, while a Swing Break of Structure (S-BOS) has a value of +2. The same logic applies to downtrends but uses negative values instead (−1 for an S-CHoCH and −2 for an S-BOS). |
{ob_buy_volume} | Most recent order block buy volume |
{ob_sell_volume} | Most recent order block sell volume |
{ob_total_volume} | Most recent order block total volume |
{ob_per_volume} | Most recent order block percentage volume |
{prev_day_high} | Previous day high value |
{prev_day_low} | Previous day low value |
{prev_week_high} | Previous week high value |
{prev_week_low} | Previous week low value |
{prev_month_high} | Previous month high value |
{prev_month_low} | Previous month low value |
{prev_quarter_high} | Previous quarter high value |
{prev_quarter_low} | Previous quarter low value |
Trigger Placeholders
| Placeholder | Description |
|---|---|
{bullish_ichoch} | True on a new internal bullish CHoCH |
{bullish_ichoch+} | True on a new internal bullish CHoCH+ |
{bullish_ibos} | True on a new internal bullish BOS |
{bearish_ichoch} | True on a new internal bearish CHoCH |
{bearish_ichoch+} | True on a new internal bearish CHoCH+ |
{bearish_ibos} | True on a new internal bearish BOS |
{bullish_schoch} | True on a new swing bullish CHoCH |
{bullish_schoch+} | True on a new swing bullish CHoCH+ |
{bullish_sbos} | True on a new swing bullish BOS |
{bearish_schoch} | True on a new swing bearish CHoCH |
{bearish_schoch+} | True on a new swing bearish CHoCH+ |
{bearish_sbos} | True on a new swing bearish BOS |
{bullish_ob} | True on a new bullish order block |
{bearish_ob} | True on a new bearish order block |
{bullish_bb} | True on a new bullish breaker block |
{bearish_bb} | True on a new bearish breaker block |
{bullish_ob_mitigated} | True when a bullish order block is mitigated |
{bearish_ob_mitigated} | True when a bearish order block is mitigated |
{bullish_ob_within} | True when price is within a bullish order block |
{bearish_ob_within} | True when price is within a bearish order block |
{bullish_ob_entered} | True when price enters a bullish order block |
{bearish_ob_entered} | True when price enters a bearish order block |
{bullish_ob_exit} | True when price exits a bullish order block |
{bearish_ob_exit} | True when price exits a bearish order block |
{bullish_imbalance} | True on a new bullish imbalance |
{bearish_imbalance} | True on a new bearish imbalance |
{bullish_imbalance_mitigated} | True when a bullish imbalance is mitigated |
{bearish_imbalance_mitigated} | True when a bearish imbalance is mitigated |
{bullish_imbalance_within} | True when price is within a bullish imbalance |
{bearish_imbalance_within} | True when price is within a bearish imbalance |
{bullish_imbalance_entered} | True when price enters a bullish imbalance |
{bearish_imbalance_entered} | True when price enters a bearish imbalance |
{bullish_imbalance_exit} | True when price exits a bullish imbalance |
{bearish_imbalance_exit} | True when price exits a bearish imbalance |
{bullish_trendline_new} | True on a new bullish trendline |
{bullish_trendline_update} | True on a bullish trendline update |
{bullish_trendline_break} | True on a bullish trendline break |
{bearish_trendline_new} | True on a new bearish trendline |
{bearish_trendline_update} | True on a bearish trendline update |
{bearish_trendline_break} | True on a bearish trendline break |
{bullish_grab} | True on a new bullish liquidity grab |
{bearish_grab} | True on a new bearish liquidity grab |
{premium} | True when price is located within a premium zone |
{discount} | True when price is located within a discount zone |
{custom_alert_step} | True on a custom alert step completion |
{custom_alert_or} | True on a custom alert OR condition completion |
Oscillator Matrix Placeholders
Data Series Placeholders
| Placeholder | Description |
|---|---|
{moneyflow} | Money Flow oscillator value |
{overflow} | Overflow value |
{upper_mf_threshold} | Upper Money Flow threshold |
{lower_mf_threshold} | Lower Money Flow threshold |
{hyperwave} | HyperWave oscillator value |
{hyperwave_signal} | HyperWave signal line value |
{bullish_confluence} | Bullish confluence numerical value, 0 for no confluence, 1 for low confluence, 2 for strong confluence |
{bearish_confluence} | Bearish confluence numerical value, 0 for no confluence, 1 for low confluence, 2 for strong confluence |
{confluence_meter} | Confluence meter value |
Trigger Placeholders
| Placeholder | Description |
|---|---|
{regular_bullish_hyperwave_signal} | True on a new regular bullish HyperWave signal |
{regular_bearish_hyperwave_signal} | True on a new regular bearish HyperWave signal |
{oversold_bullish_hyperwave_signal} | True on a new oversold bullish HyperWave signal |
{overbought_bearish_hyperwave_signal} | True on a new overbought bearish HyperWave signal |
{hyperwave_co_80} | True when HyperWave crosses over 80 |
{hyperwave_cu_20} | True when HyperWave crosses under 20 |
{hyperwave_co_50} | True when HyperWave crosses over 50 |
{hyperwave_cu_50} | True when HyperWave crosses under 50 |
{hyperwave_above_80} | True when HyperWave is above 80 |
{hyperwave_below_20} | True when HyperWave is below 20 |
{hyperwave_above_50} | True when HyperWave is above 50 |
{hyperwave_below_50} | True when HyperWave is below 50 |
{moneyflow_co_50} | True when Money Flow crosses over 50 |
{moneyflow_cu_50} | True when Money Flow crosses under 50 |
{moneyflow_above_50} | True when Money Flow is above 50 |
{moneyflow_below_50} | True when Money Flow is below 50 |
{new_bullish_overflow} | True on a new bullish Overflow signal |
{new_bearish_overflow} | True on a new bearish Overflow signal |
{bullish_overflow} | True if bullish Overflow is active |
{bearish_overflow} | True if bearish Overflow is active |
{reversal_up-} | True on a new minor bullish reversal signal |
{reversal_up+} | True on a new major bullish reversal signal |
{reversal_down-} | True on a new minor bearish reversal signal |
{reversal_down+} | True on a new major bearish reversal signal |
{reversal_any_up} | True on any new bullish reversal signal |
{reversal_any_down} | True on any new bearish reversal signal |
{bullish_divergence} | True on a new bullish divergence |
{bearish_divergence} | True on a new bearish divergence |
{weak_bullish_confluence} | True on a new weak bullish confluence |
{weak_bearish_confluence} | True on a new weak bearish confluence |
{strong_bullish_confluence} | True on a new strong bullish confluence |
{strong_bearish_confluence} | True on a new strong bearish confluence |
{custom_alert_step} | True on a custom alert step completion |
{custom_alert_or} | True on a custom alert OR condition completion |