CarbonTrace REST API

Connect device data to traceable carbon calculations

Connect a refurbisher catalogue, ITAD inventory or customer portal to device-level lifecycle estimates. Submit the available configuration and service assumptions, then retain the returned method and source information with the result.

Base URL: https://carbontrace.cloud/api/v1

Read the evidence before using a result

Engine v4 retains supported manufacturer phases or uses disclosed model estimates. Check the exact device match, service life, lifecycle boundary and source issues. A manufacturer lifecycle footprint is not automatically a manufacturing-only factor. Missing evidence stays visible; sensitivity ranges are not statistical confidence intervals.

Reuse comparisons are modelled differences against a stated new-purchase reference. They do not prove actually avoided emissions and must not be deducted from inventory totals. Retain inputs, assumptions and evidence alongside customer-facing results.

Authentication

Some calculation endpoints accept anonymous requests within public limits. Organisation data, certificates and integrations require the authentication stated for each endpoint. Create an API key in your account and send it in the Authorization header; keep production keys on your server.

Authorization: Bearer ct_your_api_key_here

Request limits

Limits depend on the current organisation package, API key and endpoint. Response headers state the applicable limit and remaining allowance. Check the current package configuration on the pricing page; a fixed list of package names is not an API contract.

X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Plan

On HTTP 429, wait for the period indicated by Retry-After before retrying.

View current packages

OpenAPI specification

Use the machine-readable specification for code generation, Postman or Swagger UI. Paths, field names, response schemas and technical descriptions remain in English to match the API contract.

Download JSON

Test with synthetic data

Use a sandbox API key to exercise supported endpoints with deterministic fixtures. These responses test your integration; they are not device measurements or customer carbon evidence. Check each endpoint’s authentication and sandbox support before sending a request.

Create a sandbox key in your account’s API key settings. Send it using the same Authorization header as a production key. Check the sandbox marker before presenting or storing test results.

Manage API keys
Authorization: Bearer ct_test_...
X-CarbonTrace-Mode: sandbox

Synthetic response excerpt

{
  "product": { "brand": "SandboxCorp", "mpn": "TEST-001", "category": "laptop" },
  "_sandbox": true
}

English technical reference

The endpoint names, descriptions, parameters and code examples below come from the OpenAPI specification. They stay in English so you can compare them directly with the API’s request and response fields.

25 matching endpoints

Footprint

Calculate lifecycle carbon footprints for IT devices

Products

Search and identify products via built-in database and Icecat

Certificates

Generate and download verifiable CO₂ impact certificates

Reports

Generate sustainability and hotspot analysis PDF reports

Reference

Countries, grid factors, and device categories

Integrations

Third-party platform integrations (Blancco)

Export

Async org-wide GDPR bulk export jobs

BI Export

OData v4 read-only endpoint for Power BI, Tableau, and Excel. Enterprise-only. Every response is signed with a hash-linked proof header tied to the CarbonTrace audit log. See /docs/bi-export for setup instructions.

ReVend

Server-to-server contract: idempotent async job submit, status/results, key/status, and signed per-job webhooks. API-key auth; carbon-only payloads.