Zone brief — current state with historical context

Composite snapshot for one zone: current price, demand and — where the zone publishes them — carbon intensity and generation mix, each ranked against that zone's own trailing 30-day distribution (percentile, median, min/max), plus 24h trend direction and a plain-language summary. One call replaces the four-to-five separate requests otherwise needed, and returns the interpretation rather than raw series. Context blocks are omitted for metrics a zone does not publish; each reports its actual data window and sample count. Priced at $0.02 per call, payable via x402 (USDC on Base), or free with ?sample=true.

get/v1/brief/{zone}

Request

  • Base URL: https://api.grid-hub.app
  • URL: https://api.grid-hub.app/v1/brief/{zone}
  • Auth: none declared

Path parameters

zone'US-CAISO' | 'US-ERCOT' | 'US-PJM' | 'US-MISO' | 'US-NYISO' | 'US-ISONE' | 'US-SPP' | 'GB' | 'AU-NSW' | 'AU-QLD' | 'AU-VIC' | 'AU-SA' | 'AU-TAS' | 'DE-LU' | 'FR' | 'ES' | 'IT-NO' | 'NL' | 'BE' | 'PL' | 'SE-3' | 'NO-2' | 'DK-1' | 'AT' | 'CH' required

Zone identifier — see GET /v1/zones for the full list.

Query parameters

sampleboolean

Set to true for a free, truncated sample response with no credentials or payment (history capped at 50 rows).

Response

Success

zonestring
zone_namestring
as_ofinteger

Unix timestamp (seconds)

currentobject

Most recent value at or before request time, per metric.

contextobject

Trailing-window distribution stats per metric. Omitted for metrics with insufficient data.

context_window_requested_daysinteger
trend_24hobject
generation_mixobject

Generation by fuel. Unit varies by zone — see generation_mix_unit.

generation_mix_unitstring
summarystring

Plain-language reading, derived from the numbers above.

coverage_notestring
attributionstring
licensestring

Changes

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