ChartnautDocs

The Run object

A Run is one execution of one script on one instrument, timeframe and window. Create a run, Get a run and Cancel a run return one, and List runs returns a page of them. Runs started through the API have ids starting run_; study runs made in the app have ids starting srun_.

Fields

Field

Type

Description

id

string

run_ and 16 lowercase letters and digits, or srun_ and a number for a study run made in the app

kind

string

indicator, definition or study

script

string

The ref that ran, with its version: my-ema@3, jane/orb-breakout@7 or chartnaut/rsi@2. inline for inline source

instrument

string

Canonical symbol, such as HYPERLIQUID:BTC

timeframe

string

Timeframe

window

object

from and to as the run used them, after moving to your plan's history and ending on a closed bar

settings

object

The settings you sent. {} when you sent none

label

string

The label you sent. Left out when you sent none

status

string

queued, running, succeeded, failed or cancelled

progress

object

pct, an integer from 0 to 100, and phase while there is one

failure

Failure or null

Why the run failed or was cancelled. null otherwise

summary

Summary or null

Counts from a succeeded run. null until then

console

array of object

The first 50 lines an indicator or definition printed, [] when it printed nothing. Left out of lists, before the run finishes, after a cancel, and for studies. Fields below

usage

object

bars, the bars evaluated with warmup and dependencies, and compute_units, bars divided by 1,000. For a study, bars is the number of events it processed

app_url

string or null

Opens a study run in Chartnaut. null for indicator and definition runs, which are not stored in the app

created_at

string

When the run was created

started_at

string or null

When it started running

finished_at

string or null

When it finished

results_expire_at

string

When indicator and definition results are deleted: 7 days after created_at. Study results do not expire. A study run made in the app reports 0001-01-01T00:00:00Z

progress.phase is running while an indicator or definition executes. A study run shows collecting while it runs its definitions over the window, starting, and then the study's own phases. phase is left out once the run finishes.

console

Field

Type

Description

level

string

The level the script logged at

message

string

What the script printed

bar_index

integer

The bar it printed on