MOmodoenergy
Forecasts

List Zone Options

Returns the valid zones for a market region's zone layer as value/label options.

Use the value field for the corresponding zone field in your simulation_config when creating a run via POST /runs/.

Optionally pass ?lat= and ?long= for your site: when the coordinates fall inside a zone, the response's preselect holds that zone; otherwise message explains why a zone must be chosen manually.

get/zones/{region}/{layer}/

Request

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

Path parameters

region'caiso' | 'ercot' | 'gb' | 'germany' | 'isone' | 'italy' | 'miso' | 'nem' | 'nyiso' | 'pjm' | 'poland' | 'spain' | 'spp' required

Market region, case-insensitive. Uses the same vocabulary as simulation_config.market_region in POST /runs/.

layerstring required

Zone layer key for the region (e.g. zone).

Query parameters

latnumber

Site latitude, used to preselect the containing zone.

longnumber

Site longitude, used to preselect the containing zone.

Response

Zone options for the region and layer.

countinteger nullable

Total number of matching options, before limit/offset paging.

messagestring nullable

Guidance when no suggestion could be made; otherwise null.

Changes

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