Residentia REST API
  1. sensor
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. sensor

getSensorHistoryBySensorId

GET
https://residentia.fi/api/v1/sensor/{sensorId}/history
Returns one sensor and its 24 hour history

Request

Authorization
API Key
Add parameter in header
X-ApiKey
Example:
X-ApiKey: ********************
or
Path 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/sensor//history' \
--header 'X-ApiKey: <api-key>'

Responses

🟢200OK
application/json
successful operation
Body

Example
[
    {
        "sensor_id": "A000000001",
        "disp_name": "KL meno",
        "unit": "°C",
        "data": [
            {
                "value": 85.5,
                "timestamp": 1541769538
            }
        ]
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠429429
Modified at 2025-04-30 12:20:30
Previous
getSensorBySensorId
Next
setOverdriveSettings
Built with