Sign in

v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB
Forecasts

Get Config Schema

Returns the simulation config schema for a market region and version. version is a semver prefix: pass the major version (e.g. 1, recommended) to always get the latest compatible schema in that series. Minor and patch releases never break a valid config, so a major-version pin keeps working across them.

More precise pins (1.0, 1.0.1) resolve only while that version is still supported (the current schema or, during a release grace period, the previous one) — an exact pin will start returning 404 soon after any newer release, including cosmetic patch changes. Use one only to reproduce a specific past request, not in integrations.

Omit the version segment entirely (GET /config-schemas/{market_region}/) to get the region's current schema.

get/config-schemas/{market_region}/{version}/

Path parameters

market_region'caiso' | 'ercot' | 'gb' | 'germany' | 'miso' | 'nem' | 'nyiso' | 'pjm' | 'spain' required

Market region to fetch the schema for.

versionstring required

Semver prefix of the api_version to resolve; the major version (e.g. 1) is recommended.

Response

The resolved config schema.

api_versionstring

The exact API version that served this request (the version path segment is resolved to the latest matching version).

idstring uuid

Unique ID of this schema version.

input_json_schemaobject

JSON Schema (draft 2020-12) describing the simulation_config payload for this market region. Use this to validate your simulation_config before submitting a run.

market_region'caiso' | 'ercot' | 'gb' | 'germany' | 'miso' | 'nem' | 'nyiso' | 'pjm' | 'spain'

The market region this schema applies to.

status'current' | 'deprecated'

Whether this is the region's current schema or the previous (deprecated) one, still supported for a grace period after a new version is released.