Skip to main content
GET
cURL

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 reference range for breakout detection.

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. breakouts of session 1 high or low are measured within this window.

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"

Response

Successful Response