REST API · JSON · API keys

Build on MintCarb API

Read your emissions, compliance status and credit portfolio, and recorded carbon prices with their sources — through a versioned JSON REST API with scoped API keys.

SandboxJSON envelopeX-API-Key authScoped keysVersioned URLsRate limited

Create an account API Reference Try sandbox

Base path:/api/v1/ext/v1

Current version:v1

Auth:X-API-Key header

Format:JSON

Example — Recorded carbon prices

GET /ext/v1/market

// Recorded carbon prices, each with its source
const res = await fetch(
  "https://<your-api-host>/api/v1/ext/v1/market",
  { headers: { "X-API-Key": "mc_live_YOUR_KEY" } }
);

const data = await res.json();

// Response when no price has been recorded
{
  "success": true,
  "data": {
    "prices": [],
    "live_feed_connected": false,
    "message": "No live exchange feed connected"
  },
  "meta": { "request_id": "...", "version": "1.0", "timestamp": "..." }
}

Example — Your credit portfolio

GET /ext/v1/credits

// Your credit portfolio
const res = await fetch(
  "https://<your-api-host>/api/v1/ext/v1/credits",
  { headers: { "X-API-Key": "mc_live_YOUR_KEY" } }
);

// Response (shape — values are your own records)
{
  "success": true,
  "data": {
    "available_credits": 0,
    "available_count": 0,
    "retired_credits": 0,
    "retired_count": 0,
    "by_type": []
  }
}

API Reference

All endpoints return a consistent JSON envelope: { success, data, error, meta }

Your organisation

GET/ext/v1/emissionsEmission KPIs and Scope 1 / 2 / 3 breakdown, last 12 monthsread:emissions

GET/ext/v1/complianceFramework status and the next regulatory deadlinesread:compliance

GET/ext/v1/creditsCredit portfolio: available and retired, by credit typeread:credits

Reference data

GET/ext/v1/benchmarksSector benchmarks with a cited source (empty until one is recorded)read:benchmarks

GET/ext/v1/marketRecorded carbon prices with source and date — no live exchange feed yetread:market

Standard Response Envelope

Every API response — success or error — returns the same JSON structure:

successboolean— true if request succeeded
dataT | null— response payload (typed per endpoint)
errorobject | null— { code, message } on failure
metaobject— { request_id, version, timestamp }

{
  "success": true,
  "data": { ... },
  "error": null,
  "meta": {
    "request_id": "req_abc123",
    "version": "v1",
    "timestamp": "2026-06-17T12:30:01Z"
  }
}

Getting access

API keys are created by your organisation's administrator in MintCarb and carry only the scopes you grant. API access comes with your MintCarb plan — see pricing for what each plan includes.

See plans Talk to us about API needs

Resources

API Reference

Every endpoint, field and example

Knowledge Center

Guides, tutorials, glossary

API Sandbox

Try endpoints live in browser

Changelog

API version history and migrations