DEPRECATED - You can now use the emissions=true parameter on the GET /consumption endpoint.
This is a general purpose endpoint for getting emissions for accounts, assets, entities and portfolios. Consumptuon units are converted to kWh or m3 (water only), and emission units are all in Kg CO2e.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Deprecated: This endpoint is deprecated. We recommend using the Get consumption endpoint with
emissions=true, which returns emissions data alongside consumption metrics.
Retrieve aggregated emissions data for a given date range, calculated from consumption data using emission factors. Data can be retrieved at the account or asset level.
Unlike the consumption endpoint, this returns an emissions-only response (no consumption, cost, or rate data).
Endpoint
GET /2.0/emissionsQuery Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startDate | string | Yes | - | Start date (ISO 8601 format, e.g. 2024-01-01). Normalised to start of day UTC. |
endDate | string | Yes | - | End date (ISO 8601 format, e.g. 2024-12-31). Normalised to start of day UTC. |
granularity | string | No | monthly | Time granularity: halfhourly, hourly, daily, weekly, quarterly, monthly, yearly |
source | string | No | combined | Data source: hh, invoice, reading, custom, combined, reading-hh |
accountType | string | No | - | Filter by utility type (comma-separated). Values: electricity, gas, water, waste, solar, heating, flow, cooling, temperature |
accountId | string | No | - | Retrieve emissions for a specific account. Automatically sets data type to account-level. |
assetId | string | No | - | Retrieve emissions for a specific asset. Automatically sets data type to asset-level. |
assetGroupId | string | No | - | Retrieve emissions for a specific asset group |
Response
The response contains only emissions-related data. Consumption, cost, and rate fields are excluded. The units field is always set to kgco2e (kilograms of CO2 equivalent).
{
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-12-31T00:00:00.000Z",
"granularity": "monthly",
"units": "kgco2e",
"isMissing": false,
"emissions": {
"total": 12500,
"scope1": 1000,
"scope2": 10500,
"scope3": 1000
},
"data": [
{
"date": "2024-01-01",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-02-01T00:00:00.000Z",
"isMissing": false,
"emissions": {
"total": 1050,
"scope1": 85,
"scope2": 880,
"scope3": 85
}
},
{
"date": "2024-02-01",
"startDate": "2024-02-01T00:00:00.000Z",
"endDate": "2024-03-01T00:00:00.000Z",
"isMissing": false,
"emissions": {
"total": 980,
"scope1": 78,
"scope2": 824,
"scope3": 78
}
}
]
}Response Fields
Emissions Object
| Field | Type | Description |
|---|---|---|
total | number | Total emissions (kgCO2e) |
scope1 | number | Scope 1 emissions - direct emissions (kgCO2e) |
scope2 | number | Scope 2 emissions - indirect from energy (kgCO2e) |
scope3 | number | Scope 3 emissions - other indirect (kgCO2e) |
Top-level Fields
| Field | Type | Description |
|---|---|---|
startDate | string | Query period start date (ISO 8601 UTC) |
endDate | string | Query period end date (ISO 8601 UTC) |
granularity | string | Requested time granularity |
units | string | Always kgco2e |
isMissing | boolean | Whether complete data coverage exists |
emissions | object | Aggregated emissions for the entire period |
data | array | Array of granular results, one per time period |
Granular Data Array (data)
data)Each element contains:
| Field | Type | Description |
|---|---|---|
date | string | Formatted date for the period |
startDate | string | Period start (ISO 8601 UTC) |
endDate | string | Period end (ISO 8601 UTC) |
isMissing | boolean | Whether data coverage exists for this period |
emissions | object | Emissions for this period (total, scope1, scope2, scope3) |
Example Request
curl -X GET "https://api.etainabl.com/2.0/emissions?startDate=2024-01-01&endDate=2024-12-31&assetId=507f1f77bcf86cd799439011&granularity=monthly" \
-H "x-api-key: YOUR_API_KEY"Scope Required
read:accounts