Analysis¶

Options¶

GET /analysis/options

Everything an analysis can be asked for: each section of settings with its defaults, every statistic, every report at both levels, labels for figure names, the large tables a run gives, and every reason a statistic can be unavailable.

Responses

Status	Meaning	Body
200	Successful Response	AnalysisCatalogue

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Analyses¶

GET /strategies/{strategy_id}/analyses

Every analysis kept by name with the strategy's latest run, newest first; a new backtest of the strategy leaves none.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
200	Successful Response	SavedAnalyses

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Saved¶

GET /strategies/{strategy_id}/analyses/{name}

An analysis kept by name with the strategy's latest run.

Raises: DataNotFoundError: If none is kept under the name.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.
`name`	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
200	Successful Response	SavedAnalysisView

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Delete¶

DELETE /strategies/{strategy_id}/analyses/{name}

Remove an analysis kept by name.

Raises: DataNotFoundError: If none is kept under the name.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.
`name`	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
204	Successful Response

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Analytics¶

GET /strategies/{strategy_id}/analytics

The analysis of the strategy's latest run, the block its backtest job answered with; not_computed for a run made without one.

Raises: DataNotFoundError: Until the strategy has been backtested.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
200	Successful Response	AnalyticsView

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Rerun Analytics¶

POST /strategies/{strategy_id}/analytics

Give an analysis of the strategy's latest run, as a job: with the choices its own analysis was made with, the run's analysis gains what is asked for and is kept, and only that is worked out; with other choices, everything asked for is, kept only under save. The job's result is the whole analysis.

Raises: DataNotFoundError: Until the strategy has been backtested.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.

Request body: AnalyticsRerun or null

Responses

Status	Meaning	Body
202	Successful Response	AnalyticsJobStatus

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Table¶

GET /strategies/{strategy_id}/tables/{name}

One of the strategy's latest run's large tables, whole: by column, repeated text as its distinct values and a code a row; or as Arrow, with Accept: application/vnd.apache.arrow.stream.

Raises: DataNotFoundError: Until the strategy has been backtested, or for a table the run does not give.

Parameters

Name	In	Type	Required	Description
`strategy_id`	path	string	yes	Letters, digits, dash and underscore; up to 64.
`name`	path	string	yes

Responses

Status	Meaning	Body
200	The whole table: by column in JSON, or as an Arrow IPC stream when asked for with `Accept: application/vnd.apache.arrow.stream`.	ColumnarTable

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.