computes the high-low range of the first sessions of the week and measures how far the rest of the week extends beyond the opening week high or low in multiples of that range. returns hit counts at each configurable breakout and breakdown level. configurable via days, week_range_size, day_type, breakout_criteria, and per-level thresholds.
Documentation Index
Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ticker symbol. format varies by market_type: stocks use a plain symbol (e.g., SPY), forex uses a 6-character pair (e.g., EURUSD), crypto uses a contract pair (e.g., BTCUSD), futures uses the root symbol (e.g., ES).
"SPY"
"EURUSD"
"BTCUSD"
"ES"
market venue for the ticker. one of: forex, futures, crypto, stock. determines supported symbols and whether session-based intraday aggregation is available.
forex, futures, crypto, stock "stock"
"forex"
inclusive start date, YYYY-MM-DD, interpreted in the request timezone. sessions on or after this date are included in the calculation.
"2024-01-01"
inclusive end date, YYYY-MM-DD, interpreted in the request timezone. sessions on or before this date are included in the calculation.
"2024-12-31"
optional session start time, HH:MM:SS, interpreted in the request timezone. omit together with end_time to use daily OHLC data. provide together with end_time to aggregate intraday bars into a custom session (forex, futures, and crypto only; ignored for stocks).
optional session end time, HH:MM:SS, interpreted in the request timezone. omit together with start_time to use daily OHLC data. provide together with start_time to aggregate intraday bars into a custom session (forex, futures, and crypto only; ignored for stocks).
number of sessions used to form the opening-week range (1-3). the opening range spans the first days sessions of each week.
1 <= x <= 3size filter for the opening-week range relative to ADR. any includes all weeks; other values restrict to opening ranges within a specific size bucket.
0, 1, 2, 3, 4, 5, 6, 7 filter for the rest-of-week sessions used to measure level interactions. one of: all, green, or red.
price criterion that registers a level hit. wick counts a hit when the session high or low touches the level; close counts a hit only when the session closes beyond it; body counts a hit when the candle body crosses the level.
first upside level above the opening-week high, expressed as a multiple of the opening-week range.
second upside level above the opening-week high, as a multiple of the opening-week range.
third upside level above the opening-week high, as a multiple of the opening-week range.
fourth upside level above the opening-week high, as a multiple of the opening-week range.
fifth upside level above the opening-week high, as a multiple of the opening-week range.
sixth upside level above the opening-week high, as a multiple of the opening-week range.
seventh upside level above the opening-week high, as a multiple of the opening-week range.
eighth upside level above the opening-week high, as a multiple of the opening-week range.
first downside level below the opening-week low, expressed as a negative multiple of the opening-week range.
second downside level below the opening-week low, as a negative multiple of the opening-week range.
third downside level below the opening-week low, as a negative multiple of the opening-week range.
fourth downside level below the opening-week low, as a negative multiple of the opening-week range.
fifth downside level below the opening-week low, as a negative multiple of the opening-week range.
sixth downside level below the opening-week low, as a negative multiple of the opening-week range.
seventh downside level below the opening-week low, as a negative multiple of the opening-week range.
eighth downside level below the opening-week low, as a negative multiple of the opening-week range.
IANA timezone used to interpret all date and time parameters and to group sessions into calendar days. defaults to America/New_York.
Successful Response