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 1 to ride the latest schema in the 1.x.x series, 1.0 to pin to 1.0.x, or a fully-specified version (e.g. 1.0.1) to pin exactly. The major version (1) is the recommended default for most users. Call GET /config-schema/?market_region=<region> to see the currently published versions for a 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 21 days ago

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

Updated 21 days ago