Skip to main content
GET
/
report_calculation
/
opening-week-range-by-levels
/
{market_type}
/
{ticker}
cURL
curl --request GET \
  --url 'https://api.edgeful.com/report_calculation/opening-week-range-by-levels/<market_type>/<ticker>?start_date=<start_date>&end_date=<end_date>' \
  --header 'Authorization: Bearer <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ticker
string
required

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).

Examples:

"SPY"

"EURUSD"

"BTCUSD"

"ES"

market_type
enum<string>
required

market venue for the ticker. one of: forex, futures, crypto, stock. determines supported symbols and whether session-based intraday aggregation is available.

Available options:
forex,
futures,
crypto,
stock
Examples:

"stock"

"forex"

Query Parameters

start_date
string
required

inclusive start date, YYYY-MM-DD, interpreted in the request timezone. sessions on or after this date are included in the calculation.

Example:

"2024-01-01"

end_date
string
required

inclusive end date, YYYY-MM-DD, interpreted in the request timezone. sessions on or before this date are included in the calculation.

Example:

"2024-12-31"

start_time
string

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).

end_time
string

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).

days
integer
default:2

number of sessions used to form the opening-week range (1-3). the opening range spans the first days sessions of each week.

Required range: 1 <= x <= 3
week_range_size
enum<integer>
default:0

size filter for the opening-week range relative to ADR. any includes all weeks; other values restrict to opening ranges within a specific size bucket.

Available options:
0,
1,
2,
3,
4,
5,
6,
7
day_type
string
default:all

filter for the rest-of-week sessions used to measure level interactions. one of: all, green, or red.

breakout_criteria
string
default:wick

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.

breakout_level_1
number
default:0.5

first upside level above the opening-week high, expressed as a multiple of the opening-week range.

breakout_level_2
number
default:1

second upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_3
number
default:1.5

third upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_4
number
default:2

fourth upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_5
number
default:2.5

fifth upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_6
number
default:3

sixth upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_7
number
default:3.5

seventh upside level above the opening-week high, as a multiple of the opening-week range.

breakout_level_8
number
default:4

eighth upside level above the opening-week high, as a multiple of the opening-week range.

breakdown_level_1
number
default:-0.5

first downside level below the opening-week low, expressed as a negative multiple of the opening-week range.

breakdown_level_2
number
default:-1

second downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_3
number
default:-1.5

third downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_4
number
default:-2

fourth downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_5
number
default:-2.5

fifth downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_6
number
default:-3

sixth downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_7
number
default:-3.5

seventh downside level below the opening-week low, as a negative multiple of the opening-week range.

breakdown_level_8
number
default:-4

eighth downside level below the opening-week low, as a negative multiple of the opening-week range.

timezone
string
default:America/New_York

IANA timezone used to interpret all date and time parameters and to group sessions into calendar days. defaults to America/New_York.

Response

Successful Response