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

getDailyConsumption

GET
https://residentia.fi/api/v1/location/{location_number}/daily_consumption
Get daily consumption data for a specific location number between the given start and end dates (YYYY-MM-DD format).
You must specify one of the available types: district_heating, water, or electricity.

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//daily_consumption?startDate&endDate&type' \
--header 'X-ApiKey: <api-key>'

Responses

🟢200OK
application/json
Successful operation, returns a list of daily consumption items.
Body

Example
[
    {
        "sensor_id": "string",
        "date": "2019-08-24",
        "consumption": 0,
        "unit": "string"
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
Modified at 2025-04-30 12:40:17
Previous
getMonthlyConsumption
Next
getDistrictHeating
Built with