Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Query Parameters

source
enum<string>
default:run

Record source from the records endpoint.

Available options:
run,
saved,
favorite,
template
id
string<uuid>
required

Record ID returned by the records endpoint or completed job run_id.

result_id
string | null

Candidate ID from a summary page; required for run/saved detail.

Required string length: 1 - 128
section
enum<string>
default:summary

Summary page or one selected-result detail/chart section.

Available options:
summary,
settings,
trades,
equity,
drawdown,
monthly,
weekday
dataset
enum<string>
default:training

Base or holdout data. The training selector returns full_period for templates, template favorites and unvalidated runs; read the returned dataset label. Missing holdout is unavailable.

Available options:
training,
holdout
limit
integer
default:5

Results per page (maximum 20), or trades per page (maximum 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Continuation offset from the previous page.

Required range: 0 <= x <= 100000
points
integer
default:200

Maximum sampled equity/drawdown points, including endpoints.

Required range: 2 <= x <= 200

Response

Successful Response

source
enum<string>
required
Available options:
run,
saved,
favorite,
template
id
string
required
metadata
Metadata · object
required
items
Items · object[]
required

Candidate summaries, trades or chart points. Finite metrics are numbers; missing values are null; nonfinite values are {value: null, status: unavailable|positive_infinity|negative_infinity}. Chart y values use null with value_status. metrics.drawdownProfitPct is max drawdown as a percentage of net profit, null when the period was not profitable.

empty_result
Empty Result · object | null

Present when a run kept no candidates: the reason, how many strategies were tested, and each enabled filter's threshold against the best value any strategy achieved.

page
OptimizerPage · object | null
result
Result · object | null
dataset
enum<string> | null
Available options:
training,
holdout,
full_period
requested_dataset
string | null
available
boolean | null
reason
string | null
presentation
Presentation · object | null

Rendering hints: type, data reference, axes, title and units. No generated image.

sampling
Sampling · object | null
aggregation
string | null
request_settings
any
score_explanation
string | null