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

Authorizations

​
Authorization
string
header
required

Use your Edgeful API key as the bearer token. In the API Reference authorization drawer, paste only the key (for example, ef_live_<random>).

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

​
session1_start_time
string

session 1 start time, HH:MM:SS, interpreted in session1_timezone. session 1 defines the reference range whose size buckets breakouts.

​
session1_end_time
string

session 1 end time, HH:MM:SS, interpreted in session1_timezone.

​
session1_timezone
string
default:America/New_York

IANA timezone used to interpret session 1 times. defaults to America/New_York.

​
session2_start_time
string

session 2 start time, HH:MM:SS, interpreted in session2_timezone. session 2 is the window where breakouts are measured.

​
session2_end_time
string

session 2 end time, HH:MM:SS, interpreted in session2_timezone.

​
session2_timezone
string
default:America/New_York

IANA timezone used to interpret session 2 times. defaults to America/New_York.

​
seperate_days
boolean
default:false

when true, treats session 1 and session 2 as falling on separate calendar days; when false, both sessions belong to the same calendar day.

​
custom_size_start
number

inclusive lower bound of a custom session-1 size bucket. pair with custom_size_end to isolate sessions whose range falls within a specific band.

​
custom_size_end
number

inclusive upper bound of the custom session-1 size bucket. pair with custom_size_start.

​
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"

​
days_to_use
string[]

weekday filter limiting the calculation to specific sessions (e.g., ['Monday', 'Friday']). defaults to all weekdays.

Response

Successful Response