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

start_date
string<date>
required

inclusive start date, YYYY-MM-DD. malformed calendar dates are rejected before the report queries historical data.

Example:

"2024-01-01"

end_date
string<date>
required

inclusive end date, YYYY-MM-DD. malformed calendar dates are rejected before the report queries historical data.

Example:

"2024-12-31"

gap_reference
enum<string>
default:friday_close

reference used to define the weekend gap. friday_close uses Friday's final close; friday_visible_gap uses Friday's high for gap ups and low for gap downs.

Available options:
friday_close,
friday_visible_gap
percentage
number
default:100

percentage of the weekend gap price must retrace. 100 requires a full return to the selected Friday reference; 50 requires half the gap.

Required range: x >= 0

Response

Successful Response