Developer Hub/API Reference

Carbon Intelligence External API

5 read-only endpoints for embedding MintCarb data into your systems. Authenticated via X-API-Key header. All endpoints are tenant-scoped — each key returns only your organization's data.

REST · JSONX-API-Key authTenant-isolated RLSRead-onlymc_live_ prefix

Base URL

116.203.153.145:8200/api/v1

Auth header

X-API-Key

Key format

mc_live_…

All methods

GET (read-only)

Authentication

Pass your API key in the X-API-Key header on every request. Keys are created in Settings → API Keys inside your MintCarb account.

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY_HERE" \
  "https://116.203.153.145:8200/api/v1/ext/v1/emissions"

Scopes

Each key is granted one or more scopes at creation time. A request to an endpoint without the required scope returns 401.

Scope	Grants access to
`read:emissions`	Access emission KPIs, record count, scope breakdown
`read:compliance`	Access framework status and regulatory deadlines
`read:credits`	Access carbon credit portfolio summary
`read:benchmarks`	Access sector GEI benchmarks (public data)
`read:market`	Access carbon credit market reference prices

Response Envelope

Every endpoint returns the same JSON structure regardless of success or error.

successboolean— true on success, false on error

dataobject | null— Response payload — null on error

error{ code, message } | null— Error details — null on success

meta.request_idstring— UUID for tracing/debugging

meta.timestampISO 8601— Server timestamp

meta.versionstring— API version ("1.0")

// Success
{
  "success": true,
  "data": { ... },
  "error": null,
  "meta": {
    "request_id": "f3a9...",
    "version": "1.0",
    "timestamp": "2026-06-25T10:00:00Z"
  }
}

// Error
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_KEY",
    "message": "Invalid or unauthorized API key"
  }
}

Error Codes

HTTP	Condition
`401`	Missing, invalid, revoked, or expired API key
`401`	Key does not have the required scope for this endpoint
`429`	Rate limit exceeded (Free: 100/hr, Pro: 1,000/hr, Enterprise: 10,000/hr)
`500`	Server error — contact support with the request_id from meta

Endpoints

GET/ext/v1/emissionsread:emissions

Emission KPIs — last 12 months

Returns total GHG emissions (tCO₂e) for the past 12 months, record count, latest record date, and a breakdown by Scope 1 / 2 / 3.

Response Fields

periodstring— "last_12_months"

total_co2e_tonnesnumber— Sum of all scope emissions for the period

record_countinteger— Number of emission records in the period

latest_recordISO 8601 | null— Date of most recent emission record

scope_breakdownarray— Array of { scope: "scope_1"|"scope_2"|"scope_3", co2e_tonnes }

Example

curl

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY" \
  "https://116.203.153.145:8200/api/v1/ext/v1/emissions"

response

{
  "success": true,
  "data": {
    "period": "last_12_months",
    "total_co2e_tonnes": 569471.2,
    "record_count": 108,
    "latest_record": "2026-03-31",
    "scope_breakdown": [
      { "scope": "scope_1", "co2e_tonnes": 412300.5 },
      { "scope": "scope_2", "co2e_tonnes": 98750.3 },
      { "scope": "scope_3", "co2e_tonnes": 58420.4 }
    ]
  },
  "meta": { "request_id": "...", "version": "1.0", "timestamp": "..." }
}

GET/ext/v1/complianceread:compliance

Compliance health — frameworks + deadlines

Returns the current status of all registered compliance frameworks (CCTS, BRSR, EU CBAM, Singapore CCS, etc.) and the next 10 upcoming regulatory deadlines.

Response Fields

frameworksarray— Array of { framework, status, last_updated }

frameworks[].frameworkstring— Framework code: CCTS, BRSR, EU_CBAM, SG_CCS, GHG_PROTOCOL, SBTi, CDP, TCFD

frameworks[].statusstring— compliant | action_required | pending_review | not_applicable

upcoming_deadlinesarray— Next 10 deadlines ordered by due_date

upcoming_deadlines[].due_dateISO 8601— Deadline date

Example

curl

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY" \
  "https://116.203.153.145:8200/api/v1/ext/v1/compliance"

response

{
  "success": true,
  "data": {
    "frameworks": [
      { "framework": "CCTS", "status": "action_required", "last_updated": "2026-06-01T..." },
      { "framework": "BRSR", "status": "compliant", "last_updated": "2026-05-29T..." }
    ],
    "upcoming_deadlines": [
      {
        "framework": "BRSR",
        "title": "BRSR Core Mandatory Disclosure",
        "due_date": "2026-07-31",
        "status": "pending"
      }
    ]
  }
}

GET/ext/v1/creditsread:credits

Carbon credit portfolio summary

Returns a summary of the tenant's carbon credit portfolio: total available and retired credits by quantity, count, and breakdown by credit type (CCC, VCS, Gold Standard, EUA, etc.).

Response Fields

available_creditsinteger— Total quantity of available (unsold, unretired) credits

available_countinteger— Number of distinct available credit batches

retired_creditsinteger— Total quantity of retired credits (permanent)

retired_countinteger— Number of distinct retirement transactions

by_typearray— Array of { credit_type, quantity } for available credits

Example

curl

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY" \
  "https://116.203.153.145:8200/api/v1/ext/v1/credits"

response

{
  "success": true,
  "data": {
    "available_credits": 4500,
    "available_count": 3,
    "retired_credits": 1200,
    "retired_count": 2,
    "by_type": [
      { "credit_type": "CCC", "quantity": 3000 },
      { "credit_type": "VCS", "quantity": 1500 }
    ]
  }
}

GET/ext/v1/benchmarksread:benchmarks

Sector GEI benchmarks

Returns Gross Emission Intensity (GEI) benchmarks for 10 major industrial sectors sourced from BEE PAT Cycle VI, IPCC 2006, and CEA India. Public reference data — no tenant context required.

Response Fields

benchmarksarray— Array of sector benchmark objects

benchmarks[].sectorstring— Sector name (Iron & Steel, Cement, Aluminium, ...)

benchmarks[].avg_geinumber— Sector average GEI value

benchmarks[].best_in_classnumber— Best-in-class GEI (top performers)

benchmarks[].unitstring— GEI unit (e.g. tCO₂e/t-steel)

benchmarks[].sourcestring— Data source citation

sourcestring— Combined source attribution

as_ofstring— Reference year

Example

curl

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY" \
  "https://116.203.153.145:8200/api/v1/ext/v1/benchmarks"

response

{
  "success": true,
  "data": {
    "benchmarks": [
      {
        "sector": "Iron & Steel",
        "avg_gei": 2.1,
        "best_in_class": 1.4,
        "unit": "tCO₂e/t-steel",
        "source": "BEE PAT VI"
      },
      {
        "sector": "Cement",
        "avg_gei": 0.72,
        "best_in_class": 0.52,
        "unit": "tCO₂e/t-cement",
        "source": "BEE PAT VI"
      }
    ],
    "source": "BEE PAT Cycle VI / IPCC 2006 / CEA India",
    "as_of": "2024"
  }
}

GET/ext/v1/marketread:market

Carbon credit market prices

Returns reference market prices for carbon credits across exchanges. Prices are updated periodically from exchange feeds (IEX Green, HPX, PXIL, CIX).

Response Fields

pricesarray— Array of price objects per credit type + exchange

prices[].credit_typestring— Credit type: CCC, ESCert, VCS, EUA, CCS_offset, ...

prices[].exchangestring— Exchange: IEX Green, HPX, PXIL, CIX, ICE, ...

prices[].pricenumber— Price per tCO₂e

prices[].currencystring— ISO 4217 currency code (INR, SGD, EUR, USD)

prices[].change_pct_24hnumber | null— 24-hour percentage change

prices[].updated_atISO 8601 | null— Timestamp of last price update

Example

curl

curl -s \
  -H "X-API-Key: mc_live_YOUR_KEY" \
  "https://116.203.153.145:8200/api/v1/ext/v1/market"

response

{
  "success": true,
  "data": {
    "prices": [
      {
        "credit_type": "CCC",
        "exchange": "IEX Green",
        "price": 1842.5,
        "currency": "INR",
        "change_pct_24h": 1.2,
        "updated_at": "2026-06-25T09:00:00Z"
      }
    ]
  }
}

Resources

Create API Key

Settings → API Keys in your account

Developer Sandbox

Test endpoints interactively

Knowledge Center

CCTS, BRSR, and carbon market guides