getMonthlyConsumption

GET

https://residentia.fi/api/v1/location/{location_number}/monthly_consumption

Get monthly consumption data for a specific location number, between the given start and end month (YYYY-MM format).
You can filter the data by one or more types (district_heating, water, electricity).

Request

Authorization

API Key

Add parameter in header

X-ApiKey

Example:

X-ApiKey: ********************

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://residentia.fi/api/v1/location//monthly_consumption?startMonth&endMonth&type' \
--header 'X-ApiKey: <api-key>'

Responses

🟢200OK

application/json

Successful operation, returns an object keyed by type with monthly consumption data.

Body

Example

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

Modified at 2025-04-30 12:20:30

getOneLocationOverdriveSettings

getDailyConsumption