---
title: "Get Config Schema"
method: GET
path: "/config-schemas/{market_region}/{version}/"
tags: ["Forecasts"]
---

# Get Config Schema

`GET /config-schemas/{market_region}/{version}/`

## Request

- Base URL: `https://api.modoenergy.com/pub/v1/forecasts`
- URL: `https://api.modoenergy.com/pub/v1/forecasts/config-schemas/{market_region}/{version}/`
- Auth: API key in header `X-token`

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.

## Path parameters

- `market_region` 'caiso' | 'ercot' | 'gb' | 'germany' | 'isone' | 'italy' | 'miso' | 'nem' | 'nyiso' | 'pjm' | 'poland' | 'spain' | 'spp', required
- `version` string, required

## Response `200`

The resolved config schema.

- ConfigSchemaDetail
  - `api_version` string: Deprecated alias of `schema_version`; use `schema_version` instead.
  - `id` string, uuid: Unique ID of this schema version.
  - `input_json_schema` object: 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' | 'isone' | 'italy' | 'miso' | 'nem' | 'nyiso' | 'pjm' | 'poland' | 'spain' | 'spp': The market region this schema applies to.
  - `schema_version` string: The exact schema version that served this request (the `version` path segment is resolved to the latest matching version).
  - `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.

## Other responses

- `401`: Missing or invalid X-token.
- `404`: Unknown market region, or no supported schema matches the requested version. The response lists the currently supported versions.

---

[API](https://skmtc.dev/modoenergy/apis/modo-energy-forecasts-api.md) - [All operations](https://skmtc.dev/modoenergy/apis/modo-energy-forecasts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/modoenergy/apis/modo-energy-forecasts-api/revisions/24a95c4b710c?raw)