Introduction
Measure, monitor, and improve the sustainability of websites with the CarbonFooter API.
The CarbonFooter API is a measurement engine for web sustainability. A single scan returns interpreted, ready-to-render data: grade, CO₂e emissions, asset quality signals, delivery facts, and actionable issues.
The public website at carbonfooter.nl is one client of this API. The API is the product — built so agencies and developers can embed carbon insights into dashboards, CI pipelines, and client reports.
What you get from a scan
| Namespace | What it tells you |
|---|---|
co2 | Headline emissions per visit, per byte, and a min–max range |
measurement | Transfer size by load phase (aboveTheFold, fullPage, deferred) |
assets | Page-level quality signals: images, fonts, scripts, video, iframes |
delivery | TTFB, redirects, protocol, compression, caching |
hosting | Green-hosting verdict and provider evidence |
issues | Findings with severity and estimated savings |
methodology | Model, emissions basis, per-segment grid intensity |
Base URL
All v2 endpoints live under:
https://carbonfooter.nl/api/v2/Scanning needs an API key. Keys are issued by the CarbonFooter team and each comes with its own limits.
The original GET /api?target= endpoint is still served unchanged for existing plugins. It is frozen and has its own response shape; new integrations should use v2.
Quick example
curl -s -X POST https://carbonfooter.nl/api/v2/scans \
-H 'Authorization: Bearer cf_live_…' \
-H 'Content-Type: application/json' \
-d '{"url": "example.com"}' | jq '{grade, co2: .co2.perVisit, issues: .issueSummary}'Next steps
- Get started — run your first scan
- Scan a page — request parameters and options
- API reference — interactive OpenAPI documentation