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

session
string
default:new_york

preset session id (or shared id) to scan; defaults to new_york.

start_time
string | null

optional custom session start time, HH:MM:SS, in the requested timezone; provide together with end_time and timezone.

end_time
string | null

optional custom session end time, HH:MM:SS, in the requested timezone; provide together with start_time and timezone.

timezone
string | null

optional IANA timezone used to aggregate a custom session window.

lookback
enum<string>
default:6mo

scoring window for the ranking: 1mo, 3mo, 6mo, or 1y; defaults to 6mo.

Available options:
1mo,
3mo,
6mo,
1y
minimum_score
number
default:50

only include reports scoring at least this value (0-100); defaults to 50, lower to 0 to see every scored report.

Required range: 0 <= x <= 100

Response

Successful Response

market
string
required
ticker
string
required
session
string
required
lookback
string
required
minimum_score
number
required
generated_at
string
required
cached
boolean
required
coverage
DiscoveryCoverageResponse · object
required
rows
DiscoveryRowResponse · object[]
required
status
string
default:ready
Allowed value: "ready"
data_through
string | null