Read a result
get_resultReads a backtest result by its run_id (when run_backtest answered "running", call this until the run ends), or a study's runs by study_id (one of them with version). A run comes with its trades, a page at a time (trades_page).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_id | No | A run_id run_backtest or run_held_out_test returned. | |
| version | No | ||
| study_id | No | A study's id, for its runs (the newest 20 by default); with `version`, one of them. | |
| trades_page | No | With a run (run_id, or study_id with version): the page of its trade list, from 1; a page holds 100 trades. Left out: the first. | |
| before_version | No | With study_id: the 20 runs before this version (a list's `next` gives it). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | ||
| runs | No | ||
| basis | No | ||
| grade | No | ||
| lines | No | ||
| market | No | ||
| reason | No | ||
| run_id | No | ||
| status | Yes | ||
| window | No | ||
| message | No | ||
| metrics | No | ||
| notices | No | ||
| version | No | ||
| headline | No | ||
| held_out | No | ||
| hold_out | No | ||
| settings | No | ||
| study_id | No | ||
| warnings | No | ||
| retryable | No | ||
| disclaimer | No | The hypothetical-performance line, on a result (a run, or a study's runs): the same text the app shows with every result. | |
| look_ahead | No | ||
| trade_list | No | The run's trades in the order they were made, a page at a time: when each entered and left (a day on daily bars; a time on the `clock` on shorter ones; "open at the end" for a trade still open when the data ended), its side, whether it won or lost after costs, and which exit ended it (a word: stop, exit rule, target, time limit…). No prices, levels, sizes or returns. | |
| buy_and_hold | No | ||
| replayed_from | No | ||
| grade_withheld | No | ||
| runs_left_today | No | ||
| hold_out_estimate | No | ||
| poll_after_seconds | No | ||
| stated_rule_breaks | No | ||
| highest_simulated_value | No |