Residentia REST API
  1. consumption_report
Residentia REST API
  • Overview
  • location
    • /location
      GET
    • getLocationByLocationNumber
      GET
  • sensor
    • getSensorBySensorId
      GET
    • getSensorHistoryBySensorId
      GET
  • overdrive
    • setOverdriveSettings
      POST
    • getOverdriveSettings
      GET
    • getOneLocationOverdriveSettings
      GET
  • consumption_report
    • getMonthlyConsumption
      GET
    • getDailyConsumption
      GET
    • getDistrictHeating
      GET
    • specificEnergyConsumption
      GET
  • Schemas
    • Schemas
      • LocationItem
      • LocationSensorItem
      • SensorItem
      • SensorHistoryItem
      • HistoryData
      • OverdriveBody
      • Overdrive
      • OverdrivePostResponse
      • OverdriveGetResponse
      • MonthlyConsumptionItem
  1. consumption_report

specificEnergyConsumption

Developing
GET
https://residentia.fi/api/v1/location/{locationId}/specific_energy_consumption
Retrieves the specific energy consumption data for a given location and year, filtered by type of consumption data.

Request

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

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://residentia.fi/api/v1/location/123/specific_energy_consumption?year=2024&type=district_heating' \
--header 'X-ApiKey: <api-key>'

Responses

🟢200Success
application/json
Body

Example
{
    "district_heating": {
        "location_number": "156",
        "year": "2024",
        "type": "district_heating",
        "specificConsumption": 39.3346,
        "unit": "kWh/m3",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    },
    "water": {
        "location_number": "156",
        "year": "2024",
        "type": "water",
        "specificConsumption": 117.5956,
        "unit": "liters/occupant/day",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    },
    "electricity": {
        "location_number": "156",
        "year": "2024",
        "type": "electricity",
        "specificConsumption": 4.9065,
        "unit": "kWh/m3",
        "dataCompleteness": "full",
        "dataRange": {
            "start": "2024-01",
            "end": "2024-12"
        }
    }
}
🟠400Bad Request
🟠404Record Not Found
🟠429429
🔴500Server Error
Modified at 2025-10-22 11:05:22
Previous
getDistrictHeating
Next
LocationItem
Built with