Skip to main content
GET
Retrieve a version and its run state

Authorizations

Authorization
string
header
required

Enter 'Bearer' followed by a space and then your JWT or API Key. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... or Bearer YOUR_API_KEY_HERE

Path Parameters

strategyId
string<uuid>
required

UUID of the strategy.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
versionId
string<uuid>
required

UUID of the strategy version.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

asOfDate
string<date>

The as-of date in YYYY-MM-DD format that selects a specific run of the version. When omitted, the latest completed run for the version is used.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The version's metadata and run state.

A saved version of a strategy together with its run state. When no as_of_date is supplied, the response summarizes the version overall and populates latest_run_date and runs_count. When an as_of_date is supplied, the response describes the run on that date, echoes as_of_date, and leaves the summary-only fields null.

version_id
string<uuid>
required

Unique identifier for this version.

strategy_id
string<uuid>
required

Identifier of the strategy this version belongs to.

objective
string
required

The normalized objective captured for this version.

exclusions
string[]
required

The exclusion phrases captured for this version.

waivers
string[]
required

The waiver phrases captured for this version.

created_at
string<date-time>
required
is_active
boolean
required

Whether this version is the strategy's active version.

status
integer | null
required

Raw run status code. 1 through 95 means in progress, 100 means done, -1 means a temporary error that is retried, and -2 means failed. A live run still in progress 30 minutes after it was submitted counts as failed, and the next submit for its date runs it again.

completed
boolean
required
has_factsheet
boolean
required
factsheet_status
enum<string> | null
required

Factsheet state of the completed run this payload describes: the run on as_of_date when one was supplied, else the latest completed run. Null when there is no such run. See FactsheetStatus for generating, not_requested and unavailable; ready means the PDF can be downloaded.

Available options:
ready,
generating,
not_requested,
unavailable
started_at
string<date-time> | null
completed_at
string<date-time> | null
as_of_date
string<date> | null

The run's as-of date, echoed when an as_of_date was supplied, otherwise null.

latest_run_date
string<date> | null

The version's latest completed run date, or null when an as_of_date was supplied.

runs_count
integer | null

Total number of runs for the version, or null when an as_of_date was supplied.