← Developer Hub
Planning

Forecast History

Read governed FinanceGPT forecast revisions and their backtest/evaluation metadata.

Version: v2
Stability: stable
Sandbox: Available
Production: Entitlement required
Target latency: ≤ 450 ms
GET/api/v2/planning/forecasts

Read-only access to persisted forecast revisions and explainability metadata.

Required scope: planning:read
Try it in the FinanceGPT sandbox

The playground uses deterministic isolated sandbox fixtures. It never queries production workspace data and does not require you to paste an API secret into the browser.

Sign in to run
Example response
{
    "data": [
        {
            "metric": "revenue",
            "selected_method": "linear_trend",
            "confidence": "medium",
            "mape": 8.4000000000000003552713678800500929355621337890625
        }
    ]
}
Code examples

curl

curl -X GET \
  https://equitygpt.app/api/v2/planning/forecasts?metric=revenue \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Content-Type: application/json"

python

import os, requests

url = "https://equitygpt.app/api/v2/planning/forecasts?metric=revenue"
headers = {"Authorization": f"Bearer {os.environ['FINANCEGPT_API_KEY']}"}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())

javascript

const response = await fetch('https://equitygpt.app/api/v2/planning/forecasts?metric=revenue', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.FINANCEGPT_API_KEY}`, 'Content-Type': 'application/json' }
});
if (!response.ok) throw new Error(`FinanceGPT ${response.status}`);
console.log(await response.json());

php

<?php
$ch = curl_init('https://equitygpt.app/api/v2/planning/forecasts?metric=revenue');
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => ['Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'), 'Content-Type: application/json']]);
$response = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) throw new RuntimeException($response);
echo $response;
Versions & changelog
v2 published
M15 publication of this governed FinanceGPT API operation.

Ready to build?

Explorer gives immediate isolated sandbox access. Production plans require a commercial entitlement.

Create account