Skip to main content
Quant & Models

Run a governed holdout forecast-model tournament

POST /quant/model-tournaments

Contract

Authentication
Bearer credential required
Required scope
quant:models:run
Status
Published

Request body

application/json ยท required
{
    "series": [
        1
    ],
    "name": "string",
    "holdout": 2,
    "forecast_horizon": 1,
    "metric": "mae",
    "candidate_models": [
        "string"
    ]
}

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "series": [
        1
    ],
    "name": "string",
    "holdout": 2,
    "forecast_horizon": 1,
    "metric": "mae",
    "candidate_models": [
        "string"
    ]
}' \
  "https://financegpt.dev/api/v2/quant/model-tournaments"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/quant\/model-tournaments", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "series": [
        1
    ],
    "name": "string",
    "holdout": 2,
    "forecast_horizon": 1,
    "metric": "mae",
    "candidate_models": [
        "string"
    ]
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/quant/model-tournaments',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"series":[1],"name":"string","holdout":2,"forecast_horizon":1,"metric":"mae","candidate_models":["string"]}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/quant/model-tournaments');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(array (
  'series' => 
  array (
    0 => 1.0,
  ),
  'name' => 'string',
  'holdout' => 2,
  'forecast_horizon' => 1,
  'metric' => 'mae',
  'candidate_models' => 
  array (
    0 => 'string',
  ),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Completed tournament with candidate errors and selected forecast
422 Invalid tournament input or no successful candidates

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

quant:models:run

Machine-readable sources