API v1
Machine-readable intelligence for applications and validators. Responses use { data } or { error }. Intensity endpoints return a full object with unit, system, time, methodology, source, and provenance, not a bare number.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/health | Service health |
| GET | /api/v1/grids | List electricity systems and grid regions |
| GET | /api/v1/grids/{id|slug} | System or region detail with latest intensity |
| GET | /api/v1/intensity?location=Sydney&type=average | Resolve full intensity object |
| GET | /api/v1/intensity/history?system=au-nem&grid=nsw | Historical series |
| GET | /api/v1/markets | Markets catalogue |
| GET | /api/v1/generation | Generation observations when available |
| GET | /api/v1/demand | Demand observations when available |
| GET | /api/v1/sources | Data source register |
| GET | /api/v1/evidence-packages | List evidence packages |
| POST | /api/v1/evidence-packages | Create an evidence package |
Resolution example
GET /api/v1/intensity?location=Sydney×tamp=2024-06-01T00:00:00Z&type=average Sydney → NSW → NEM → NSW region → annual NGA average factor → full intensity object (unit, time, system, methodology, source, provenance, confidence)