API Documentation

This is the API documentation for wGrid's API.

API Endpoints

The API is currently in development, and will be documented more at some point. Endpoints should no longer change, and if they do a /v2/ or such will be used for the new ones, leaving the old ones online, even if deprecated.
There are no custom rate limits yet - please be kind to the API.
Please note that /api/all endpoints return a lot of data (north of 100MB for /api/all) and currently have a huge 12-hour edge cache on them. If you need to download the whole database, please use /api/db and parse it your end.

/api/current - the current electricity mix
/api/today - the current electricity mix, for today
/api/today/avg - the current electricity mix, for today, averaged
/api/past-x-hrs - historical data for a given time period
/api/past-x-hrs/avg - averaged historical data for a given time period
/api/past-week - historical data for the past week
/api/past-week/avg - averaged historical data for the past week
/api/past-month - historical data for the past month
/api/past-month/avg - averaged historical data for the past month
/api/past-year - historical data for the past year
/api/past-year/avg - averaged historical data for the past year
/api/past-year/day-avg - averaged historical data for the past year, by day
/api/past-year/week-avg - averaged historical data for the past year, by week
/api/all - historical data for all time
/api/all/avg - averaged historical data for all time
/api/all/week-avg - averaged historical data for all time, by week
/api/all/month-avg - averaged historical data for all time, by month
/api/all/year-avg - averaged historical data for all time, by year
/api/date - data for a given date
/api/date-range - data for a given date range
/api/date-range/avg - averaged data for a given date range
/api/average - universal averages endpoint
/api/co2/date-range - CO₂ data for a given date range
/api/co2/date-range/avg - averaged CO₂ data for a given date range
/api/db - the database