CED Monitoring Infrastructure — API v1

API Documentation

The EarthSentinel API provides programmatic access to CED operational metrics, coalition participation data, and CGCI time-series monitoring outputs. All responses are JSON. Authentication via API key header. Rate limits apply per tier.

API Version v1
Base URL https://earthsentinel.org/api
Format JSON — UTF-8
Endpoints 3
Auth X-CED-API-KEY
Status Phase 0 — Sandbox

Authentication

All API requests require an API key passed via the X-CED-API-KEY header. API keys are issued per organization. To request access, submit an API Access Request via the Contact page, specifying your organization, intended use case, and data access tier.

Request Header
GET /api/dashboard.php HTTP/1.1
Host: earthsentinel.org
X-CED-API-KEY: ced_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
Accept: application/json
API keys are bound to the requesting organization. Keys are not transferable. Misuse of the API key or unauthorized redistribution of CED data constitutes a violation of the CED data use agreement and will result in key revocation.

Rate Limits

Tier Access Requests / Hour Requests / Day Historical Data
Public Dashboard metrics only 120 1,000 Current cycle only
Institutional All endpoints 600 10,000 90 days
CSC Member All endpoints + raw alerts Unlimited Unlimited Full archive
NIA All endpoints + landholder data (own jurisdiction only) 1,200 25,000 Full archive
Rate limit headers are returned with every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix timestamp). Requests exceeding rate limits receive HTTP 429 with a Retry-After header.

Response Codes

CodeStatusMeaning
200OKRequest successful. Response body contains requested data.
400Bad RequestInvalid parameters. Check request format and parameter values.
401UnauthorizedMissing or invalid API key in X-CED-API-KEY header.
403ForbiddenAPI key does not have access to the requested resource or tier.
404Not FoundEndpoint or resource does not exist.
429Too Many RequestsRate limit exceeded. Check Retry-After header.
500Server ErrorInternal processing error. Retry after 60 seconds.
503Service UnavailableSystem maintenance or satellite feed interruption. Check /dashboard for status.

Versioning

API version is indicated in the response body meta.version field. The current version is 3.2.1 (aligned with CED document version). Breaking changes will increment the major version and provide a 90-day deprecation window. Non-breaking additions (new fields) are introduced without version increment.

GET /api/dashboard.php

Returns current operational metrics for the CED monitoring system. Updated every 30 seconds. Used by the EarthSentinel dashboard for live display.

Parameters
ParameterTypeRequiredDescription
No parameters required. Returns current system state.
Request
GET https://earthsentinel.org/api/dashboard.php
X-CED-API-KEY: ced_live_xxxxxxxxxxxxxxxxxxxxxxxx
Response — 200 OK
{
  "meta": {
    "version": "3.2.1",
    "timestamp": "2026-02-18T09:00:00Z",
    "source": "CED Monitoring Infrastructure",
    "next_refresh_seconds": 30
  },
  "status": {
    "system": "operational",
    "satellites_active": 9,
    "last_verification_cycle": "2026-02-18T08:58:22Z",
    "detection_accuracy_pct": 95.3,
    "alert_latency_hours": 18
  },
  "metrics": {
    "monitoring_coverage_pct": 94.7,
    "coalition_gdp_pct": 61.3,
    "active_alerts_24h": 12,
    "enforcement_actions_active": 3,
    "cpp_disbursed_ytd_usd_bn": 284.2,
    "landholders_registered": 4820000,
    "compliance_rate_pct": 91.4,
    "escalation_level_current": 2,
    "cgci_net_loss_ha_ytd": 48000
  },
  "compliance_distribution": {
    "green_pct": 91.4,
    "yellow_pct": 5.2,
    "orange_pct": 2.1,
    "red_pct": 1.3
  },
  "escalation_active": {
    "level_1": 48,
    "level_2": 12,
    "level_3a": 2,
    "level_3b": 1,
    "level_3c": 0,
    "level_4": 0,
    "level_5": 0
  }
}
Field Reference
FieldTypeDescription
status.systemstringoperational | degraded | incident | pre-operational
status.satellites_activeintegerNumber of satellite systems currently feeding data (max 9)
metrics.monitoring_coverage_pctfloatPercentage of CGCI zones under active satellite monitoring
metrics.coalition_gdp_pctfloatPercentage of global GDP represented by active coalition members
metrics.active_alerts_24hintegerVerified CGCI violation alerts in the past 24 hours
metrics.cpp_disbursed_ytd_usd_bnfloatYear-to-date Climate Preservation Payments disbursed, in US$ billions
metrics.compliance_rate_pctfloatPercentage of registered CGCI areas with GREEN compliance status
metrics.escalation_level_currentintegerHighest active escalation level (0–5). Level 5 requires unanimous CSC vote.
escalation_active.*integerCount of active enforcement actions at each level/phase

GET /api/coalition.php

Returns coalition membership data including member list, GDP coverage, trade coverage, and current enforcement scenario classification.

Parameters
ParameterTypeRequiredDefaultDescription
blocstringNoFilter by bloc: Asia-Pacific, Europe, Americas, Africa
statusstringNoFilter by status: active, provisional, observer
Response — 200 OK
{
  "meta": {
    "timestamp": "2026-02-18T09:00:00Z",
    "version": "3.2.1"
  },
  "coalition_summary": {
    "total_members": 47,
    "total_gdp_pct": 61.3,
    "trade_coverage_pct": 58.7,
    "scenario": "B",
    "enforcement_capacity": "Full Level 1-3 operational"
  },
  "members": [
    {
      "id": "SGP",
      "name": "Singapore",
      "bloc": "Asia-Pacific",
      "gdp_pct_global": 0.5,
      "role": "Data Coordination Hub",
      "status": "active",
      "cgci_areas": ["SE Asian Rainforests"],
      "joined": "2026-01-01"
    },
    {
      "id": "EUB",
      "name": "European Union",
      "bloc": "Europe",
      "gdp_pct_global": 17.9,
      "role": "Permanent CSC Member",
      "status": "active",
      "cgci_areas": ["Amazon", "Congo", "SE Asian Rainforests"],
      "joined": "2026-01-01"
    }
  ]
}
Field Reference
FieldTypeDescription
coalition_summary.scenariostringA | B | C | D — current coalition power classification per CED Chapter 14.7
members[].idstringISO 3166-1 alpha-3 country code, or bloc identifier (e.g. EUB)
members[].rolestringPermanent CSC Member | Technical Member | Data Coordination Hub | Participating Nation
members[].statusstringactive | provisional | observer | suspended
members[].cgci_areasarrayCGCI zones within this member's jurisdiction or enforcement scope

GET /api/metrics.php

Returns time-series operational data and per-region CGCI compliance metrics. Supports historical periods up to the caller's tier data retention limit.

Parameters
ParameterTypeRequiredDefaultOptions
periodstringNo30d7d, 30d, 90d, 365d
regionstringNoallCGCI region ID — see Region IDs reference below
metricstringNoallmonitoring_coverage_pct, active_alerts, compliance_rate_pct, cpp_disbursed_usd_bn
Request Example
GET https://earthsentinel.org/api/metrics.php?period=30d®ion=amazon
X-CED-API-KEY: ced_live_xxxxxxxxxxxxxxxxxxxxxxxx
Response — 200 OK
{
  "period": "30d",
  "series": {
    "dates": ["2026-01-17", "2026-01-18", "2026-01-19"],
    "monitoring_coverage_pct": [94.1, 94.3, 94.7],
    "active_alerts": [9, 11, 12],
    "compliance_rate_pct": [90.2, 91.1, 91.4],
    "cpp_disbursed_usd_bn": [1.2, 1.3, 1.4]
  },
  "cgci_regions": [
    {
      "id": "amazon",
      "name": "Amazon Basin",
      "area_mha": 550,
      "zone1_pct": 70,
      "compliance_rate_pct": 88.3,
      "alert_count_7d": 34,
      "cpp_rate_usd_ha": 500,
      "status": "yellow"
    },
    {
      "id": "congo",
      "name": "Congo Basin",
      "area_mha": 200,
      "zone1_pct": 70,
      "compliance_rate_pct": 95.1,
      "alert_count_7d": 8,
      "cpp_rate_usd_ha": 250,
      "status": "green"
    }
  ]
}

Reference — Compliance Status Values

ValueMeaningCPP PaymentMarket Notification
greenFull Compliance100%Certified Compliant
yellowRemediation Underway80%Remediation Notice
orangeWarning Issued50%Warning Notice
redMajor Violation0%Non-Compliance Alert

Reference — Escalation Level Values

LevelNameTriggerAutomatic
0Baseline ComplianceDefault stateYes
1Technical WarningThreshold breach — first occurrenceYes
2Individual SanctionsNon-remediation after Level 1Yes
3aNational Restrictions — Phase ASystematic government non-enforcementYes
3bNational Restrictions — Phase B90 days after Phase AYes
3cNational Restrictions — Phase C180 days after Phase BYes
4Financial System ExclusionPersistent non-compliance after Level 3Yes
5Complete Market IsolationImminent irreversible CGCI collapseNo — unanimous CSC vote required

Reference — CGCI Region IDs

IDNameCategoryArea (M ha)
amazonAmazon BasinCat. A550
congoCongo BasinCat. A200
se_asiaSE Asian RainforestsCat. A100
mesoamericanMesoamerican CorridorCat. A50
atlanticAtlantic ForestCat. A20
boreal_ruRussian TaigaCat. B500+
boreal_caCanadian Boreal ForestCat. B300+
indo_peatIndonesian PeatlandsCat. C25
congo_peatCongo PeatlandsCat. C15
mangrovesGlobal Mangrove SystemsCat. D15