MOmodoenergy
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}/

Request

  • Base URL
    https://api.modoenergy.com/pub/v1/forecasts
  • URL
    https://api.modoenergy.com/pub/v1/forecasts/runs/{id}/
  • Auth
    API key in header X-token

Path parameters

idstring uuid required

The forecast run ID returned by POST /runs/.

Response

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'CAISO' | 'DE' | 'ERCOT' | 'ES' | 'GB' | 'ISONE' | 'IT' | 'MISO' | 'NEM' | 'NYISO' | 'PJM' | 'PL' | 'SPP'

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.

Changes

No recorded changes to this operation across all 1 revision of this API.