API Documentation
Access real-time grid data programmatically through our static JSON endpoints. Data is updated frequently.
GET /api/summary-cards.json
Retrieves the high-level summary metrics visible at the top of the dashboard, including zero-carbon percentage, grid frequency, demand, total generation, emissions, and wholesale price.
Example Response:{
"timestamp": "2026-05-02 12:30:00 UTC",
"zero_carbon_percentage": 56.4,
"frequency_hz": 50.015,
"demand_gw": 32.1,
"generation_gw": 34.5,
"emissions_g_kwh": 95,
"price_mwh": 48.2
}
GET /api/generation-by-type.json
Provides a breakdown of electricity generation aggregated by broader category types (e.g., Renewables, Fossil fuels, Interconnectors) in Megawatts (MW).
Example Response:{
"timestamp": "2026-05-02 12:30:00 UTC",
"Fossil fuels_mw": 8500,
"Renewables_mw": 14200,
"Other sources_mw": 5000,
"Interconnectors_mw": 4800,
"Storage_mw": 2000
}
GET /api/actionable-insights.json
Returns real-time actionable recommendations for appliance usage and EV charging, computed from the current carbon intensity and grid wholesale prices.
Example Response:{
"timestamp": "2026-05-02 12:30:00 UTC",
"appliance_usage": {
"status": "GREEN",
"recommendation": "Great time to run high-energy appliances! The grid is powered by clean energy."
},
"ev_charging": {
"recommendation": "The cheapest and greenest 4-hour window in the next 24 hours is forecasted to be 01:00 - 05:00 tomorrow morning."
},
"factors": {
"emissions": 85,
"price": 35.5,
"is_low_carbon": true,
"is_cheap": true
}
}
GET /data.json
The main firehose payload containing all aggregated datasets, histories, and raw generation arrays.
Example Response:{
"updated": "2026-05-02 12:30:00 UTC",
"generation": { ... },
"past_day_average": { ... },
...
}