Zones

Get Zone Coverage

Discover data availability for a zone as a plottable coverage grid.

Returns bucketed point counts for every time series configured for the zone. Designed for direct visualisation as a heatmap:

  • y-axis: each entry in series (one per time series)
  • x-axis: the shared buckets array (time)
  • cell value: counts[i] — number of data points in that bucket (0 = missing)

Use resolution to control bucket granularity (1h, 1d, 1w). Use source and/or provenance to narrow which series appear.

get/v1/zone/{zone_key}/coverage

Request

  • Base URL: https://grid.rebase.energy/api
  • URL: https://grid.rebase.energy/api/v1/zone/{zone_key}/coverage
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-API-Key

Path parameters

zone_keystring required

Query parameters

resolutionstring

Bucket size: '1h', '1d', or '1w'.

startstring date-time nullable

Start of coverage window (ISO 8601). Default: 30 days ago.

endstring date-time nullable

End of coverage window (ISO 8601). Default: now.

sourcestring nullable

Filter to a single source (e.g. 'entsoe'). If omitted, all configured sources are checked.

provenancestring nullable

Filter by provenance: 'measured', 'energy_balance', 'estimated', 'modeled'.

Response

Successful Response

zone_keystring required
resolutionstring required

Bucket size used: '1h', '1d', or '1w'

startstring required

Start of coverage window (ISO 8601)

endstring required

End of coverage window (ISO 8601)

bucketsstring[] required

Shared time axis — bucket start timestamps (ISO 8601). Every entry in 'series' has a 'counts' array of the same length, aligned to these buckets.

Changes

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