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

getDistrictHeating

GET
https://residentia.fi/api/v1/location/{location_number}/district_heating
Get monthly measured and normalized district heating consumption data for a specific location number and a specific year (e.g. 2025).

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/district_heating?year=2025' \
--header 'X-ApiKey: <api-key>'

Responses

🟢200OK
application/json
Successful operation. Returns an array of objects, each representing normalized heating data for a specific month.
Body

Example
[
    {
        "month": "2025-01",
        "simple_consmption": 68.734,
        "normalized_consumption": 80.24,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-02",
        "simple_consmption": 68.117,
        "normalized_consumption": 74.35,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-03",
        "simple_consmption": 55.228,
        "normalized_consumption": 66.26,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-04",
        "simple_consmption": 38.702,
        "normalized_consumption": 43.9,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-05",
        "simple_consmption": 25.617,
        "normalized_consumption": 25.92,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-06",
        "simple_consmption": 15.139,
        "normalized_consumption": 15.14,
        "unit": "mwh",
        "type": "District Heating"
    },
    {
        "month": "2025-07",
        "simple_consmption": 10.957,
        "normalized_consumption": 10.96,
        "unit": "mwh",
        "type": "District Heating"
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
Modified at 2025-07-30 17:38:19
Previous
getDailyConsumption
Next
specificEnergyConsumption
Built with