v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB

Forecasts

List Forecast Runs

Returns a paginated list of forecast runs for your company, ordered newest first by default.

Each item includes the original simulation_config submitted at creation. Use GET /runs/{id}/results/{resolution}/ to retrieve results for a completed run.

Filtering: combine any of the query parameters below — they are AND'd together. *__in parameters accept comma-separated values. Date filters accept any ISO 8601 datetime, e.g. 2026-01-01T00:00:00Z.

get/runs/

Query parameters

created_at_afterstring date-time

Only return runs created at or after this ISO 8601 datetime.

created_at_beforestring date-time

Only return runs created at or before this ISO 8601 datetime.

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

Filter to runs with this exact status.

status__instring

Comma-separated list of statuses to include. Allowed values: draft, processing, ready_for_review, failed.

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

Filter to runs in this market region.

market_region__instring

Comma-separated list of market regions to include. Allowed values: GB, ERCOT, NEM, DE, ES, CAISO, NYISO.

scenariostring

Filter to runs with this exact scenario name (e.g. Central, High, Low, Backtest).

scenario__instring

Comma-separated list of scenarios to include (e.g. Central,High).

run_namestring

Case-insensitive substring match on run_name.

f_model_version_usedstring

Filter to runs generated with this fundamentals model version (e.g. Jan-26). When this parameter is provided, runs without a recorded version are excluded; they remain visible in the unfiltered list.

f_model_version_used__instring

Comma-separated list of fundamentals model versions to include (e.g. Jan-26,Feb-26).

ordering'created_at' | '-created_at'

Sort order. created_at is oldest first; -created_at is newest first. Defaults to newest first.

limitinteger

Number of results per page.

offsetinteger

Offset for pagination.

Response

Paginated list of forecast runs.

countinteger

Total number of results.

{"stackTrail":"components:schemas:PaginatedForecastRunResponse:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:PaginatedForecastRunResponse:properties:previous","oasType":"schema","type":"unknown"}