1. consumption_report
Residentia REST API
  • Residentia REST API
    • location
      • getLocations
      • getLocationByLocationNumber
    • sensor
      • getSensorBySensorId
      • getSensorHistoryBySensorId
    • overdrive
      • setOverdriveSettings
      • getOverdriveSettings
      • getOneLocationOverdriveSettings
      • getLocationOverdriveStatus
    • consumption_report
      • getMonthlyConsumption
        GET
      • getDailyConsumption
        GET
      • getDistrictHeating
        GET
      • specificEnergyConsumption
        GET
    • heating
      • getLocationHeatingCurve
      • getLocationTargetSetpoint
    • Schemas
      • LocationItem
      • LocationSensorItem
      • SensorItem
      • SensorHistoryItem
      • HistoryData
      • OverdriveBody
      • Overdrive
      • OverdrivePostResponse
      • OverdriveGetResponse
      • HeatingCurvePoint
      • HeatingCurveItem
      • TargetSetpointItem
      • OverdriveStatusItem
      • MonthlyConsumptionItem
      • SpecificEnergyTypeResult
  1. consumption_report

specificEnergyConsumption

GET
/location/{location_number}/specific_energy_consumption
Specific energy consumption for a given location and year, optionally filtered by type and optionally normalized (rolling 12-month window and/or district-heating weather correction — see normalize). Units: kWh/m³ for DH/electricity, liters/occupant/day for water.

Request

Authorization
API Key
Add parameter in header
X-ApiKey
Example:
X-ApiKey: ********************
or
Path Params

Query Params

Responses

🟢200
application/json
Per-type results keyed by consumption type, plus an optional missingInfo block listing types whose calculation failed (e.g. missing building volume, no data at this location). Only requested types appear as top-level keys; failed ones move to missingInfo.
Bodyapplication/json

🟠400
🟠404
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/location/10000123/specific_energy_consumption?year=2024&type=all&normalize=weather%2Crolling' \
--header 'X-ApiKey: <api-key>'
Response Response Example
200 - Default response (no normalize parameter), full year
{
    "district_heating": {
        "location_number": "10000123",
        "year": "2024",
        "type": "district_heating",
        "specificConsumption": 39.3346,
        "unit": "kWh/m3",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    },
    "water": {
        "location_number": "10000123",
        "year": "2024",
        "type": "water",
        "specificConsumption": 117.5956,
        "unit": "liters/occupant/day",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    },
    "electricity": {
        "location_number": "10000123",
        "year": "2024",
        "type": "electricity",
        "specificConsumption": 4.9065,
        "unit": "kWh/m3",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    }
}
Modified at 2026-06-18 14:38:42
Previous
getDistrictHeating
Next
getLocationHeatingCurve
Built with