edgeful API: 150+ trading probability reports

curl --request GET \ --url 'https://api.edgeful.com/report_calculation/market-session-breakout-by-levels/<market_type>/<ticker>?start_date=<start_date>&end_date=<end_date>' \ --header 'Authorization: Bearer <api-key>'

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. defines the range whose high and low anchor the breakout/breakdown levels.

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 level interactions 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.

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"

breakout_level_1

number

default:0.5

first upside level above session 1 high, expressed as a multiple of the session 1 range.

breakout_level_2

number

default:1

second upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_3

number

default:1.5

third upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_4

number

default:2

fourth upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_5

number

default:2.5

fifth upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_6

number

default:3

sixth upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_7

number

default:3.5

seventh upside level above session 1 high, as a multiple of the session 1 range.

breakout_level_8

number

default:4

eighth upside level above session 1 high, as a multiple of the session 1 range.

breakdown_level_1

number

default:-0.5

first downside level below session 1 low, expressed as a negative multiple of the session 1 range.

breakdown_level_2

number

default:-1

second downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_3

number

default:-1.5

third downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_4

number

default:-2

fourth downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_5

number

default:-2.5

fifth downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_6

number

default:-3

sixth downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_7

number

default:-3.5

seventh downside level below session 1 low, as a negative multiple of the session 1 range.

breakdown_level_8

number

default:-4

eighth downside level below session 1 low, as a negative multiple of the session 1 range.

days_to_use

string[]

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

Response

Successful Response