v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB

Forecasts

Get Forecast Run

Returns detail for a single forecast run.

Poll this endpoint until status is ready_for_review, then call GET /runs/{id}/results/{resolution}/ to retrieve results.

get/runs/{id}/

idstring uuid required

The forecast run ID returned by POST /runs/.

Forecast run detail.

created_atstring date-time

When the run was submitted.

f_model_version_usedstring

The fundamentals model version used to generate this run (e.g. Jan-26).

idstring uuid

Unique ID of the forecast run.

market_region'GB' | 'ERCOT' | 'NEM' | 'DE' | 'ES' | 'CAISO' | 'NYISO'

Market region the run was submitted for.

scenariostring

Scenario name (e.g. Central, High, Low, Backtest).

simulation_configobject

The exact simulation_config payload submitted at run creation.

status'draft' | 'processing' | 'ready_for_review' | 'failed'

Current status of the run. Poll GET /runs/{id}/ until ready_for_review, then call GET /runs/{id}/results/{resolution}/ to retrieve results.