Regions

List Regions

View as Markdown

List all available regions for a specific forecast metric within an ISO.

Returns metadata for each region including. Use this endpoint to discover which geographic regions have forecast data available for a specific metric.

Access: Requires core subscription level.

Authentication

X-API-Keystring

API key for authentication. Can also be provided in the api_key query parameter.

Path parameters

isoenumRequired
ISO identifier.
metricenumRequired
Forecast metric type.
Allowed values:

Response

Successful Response
idstring

Unique identifier for the region. Format typically follows ‘{ba}_{region_name}’ pattern.

namestring

Human-readable name of the region.

region_typestring

Type or classification of the region. Common values: ‘iso’ (entire balancing authority), ‘zone’ (load zone), ‘hub’ (trading hub).

isostring

Identifier of the parent Balancing Authority (ISO/RTO) that this region belongs to.

timezonestringformat: "zoneinfo"

IANA timezone identifier for the region’s local time (e.g., ‘America/New_York’). Used for converting UTC timestamps to local time.

Errors

422
Unprocessable Entity Error