Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

Incorrect payload example in /backtests/create endpoint

Open JosueNina opened this issue 3 months ago • 1 comments

The documentation for the /backtests/create endpoint contains an incorrect payload example. The parameters field is not properly structured.

Incorrect Example (current docs):

{
  "projectId": 23456789,
  "compileId": "c0edc6-49048b",
  "backtestName": "New Backtest",
  "parameters[name]": "parameters[ema_fast] = 10, parameters[ema_slow] = 100"
}

Correct Example:

{
    "projectId": 23456789,
    "compileId": "c0edc6-49048b",
    "backtestName": "New Backtest",
    "parameters": {
        "ema_fast": 789,
        "ema_slow": 789.34,
        "tag": "newTag"
    }
}

JosueNina avatar Oct 01 '25 20:10 JosueNina

The YAML has already been updated, we just haven't regenerated the reference pages yet.

DerekMelchin avatar Oct 02 '25 14:10 DerekMelchin