API Reference

Create Forecast Run

post
https://api.modoenergy.com/pub/v1/forecasts/runs/

Submit a new custom forecast simulation run.

Select your market region from the dropdown below to see the required and optional configuration fields for that region.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to 1

The API version of the simulation_config schema you are using. Accepts a semver prefix: pass the major version (e.g. 1, recommended) to ride the latest schema in the 1.x.x series — minor and patch releases never break a valid config, so this keeps working across them. More precise pins (1.0, 1.0.1) are only accepted while that version is still supported, and start being rejected soon after any newer release — avoid them in integrations. Call GET /config-schemas/ to see the currently supported versions for each region.

simulation_config
required

The full configuration for your forecast run. Select a market region to see the fields for that region.

Responses

400

Invalid request — missing required fields or simulation_config failed schema validation.

401

Missing or invalid X-token.

403

Insufficient permissions for the requested market region.

429

Forecast quota exceeded.

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?