CarbonSutra Carbon Emissions API
EmissionMetrics
CO₂e result returned by an emission calculator.
typeCarbonSutra calculation type.
co2e_gmEstimated emissions in grams of CO₂e.
Example: 83540
co2e_kgEstimated emissions in kilograms of CO₂e.
Example: 83.54
co2e_mtEstimated emissions in metric tonnes of CO₂e.
Example: 0.08
co2e_lbEstimated emissions in pounds of CO₂e.
Example: 184.17
explanationHuman-readable calculation explanation when provided.
EmissionResponse
Standard CarbonSutra emission-calculation response.
EmissionMetrics · required
CO₂e result returned by an emission calculator.
successWhether the request completed successfully.
statusAPI status value.
GenericJsonResponse
Generic JSON response because the supplied collection does not define the exact response fields.
ApiKeyResponse
API-key registration or retrieval response.
object
CarbonSutra_API_KEYSecret CarbonSutra API key. Store securely.
successstatusClusterRecord
A calculation stored under an emission cluster.
idUnique record identifier.
typeCalculation type.
cluster_nameDeveloper-defined cluster name.
object
Calculation-specific attributes.
estimated_atEstimate timestamp.