Digiwatt Services API documentation (1.0)

Download OpenAPI specification:Download

Authentication

BearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Token authentication

The authentication flow follow the OAuth2 specification for client credentials grant: the client must call the /auth/token endpoint to get the bearer token that will use later to autheticate api calls.
The response returns a json object containing the access token, the token lifetime and the token type.
Token type and access token must set in Authorization header in the following manner in order to be authorized: token_type access_token.
Example: Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJiajE5UDNVT3psaEFGdVA3OXNXbl9PTE5EN1F1LUpJRV9oWU9wSlBKeENJIn0.eyJleHAiOjE2MzQwOTA5MzEsImlhdCI6MTYzNDA1NDkzMSwianRpIjoiY2JiZTc3YTEtZGM5Zi00YTU3LWI3ZjgtZmZhYTBhOTc4NGE5IiwiaXNzIjoiaHR0cDovL2tleWNsb2FrLmFpYWFzLmxvY2FsOjgwODAvYXV0aC9yZWFsbXMvYWlhYXMiLCJzdWIiOiJmMDRlZmIxOS1iMzg1LTRlZjUtODJjYi0yMzQ3MmE1Zjg5YzIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjbGllbnQxIi...

The OAuth2 client_credentials authentication flow.

Request Body schema: application/x-www-form-urlencoded

client_id	string
client_secret	string
grant_type	string Default: "client_credentials"

Responses

Response samples

200

Content type

application/json

{"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJiajE5UDNVT3psaEFGdVA3OXNXbl9PTE5EN1F1LUpJRV9oWU9wSlBKeENJIn0.eyJleHAiOjE2MzQwOTA5MzEsImlhdCI6MTYzNDA1NDkzMSwianRpIjoiY2JiZTc3YTEtZGM5Zi00YTU3LWI3ZjgtZmZhYTBhOTc4NGE5IiwiaXNzIjoiaHR0cDovL2tleWNsb2FrLmFpYWFzLmxvY2FsOjgwODAvYXV0aC9yZWFsbXMvYWlhYXMiLCJzdWIiOiJmMDRlZmIxOS1iMzg1LTRlZjUtODJjYi0yMzQ3MmE1Zjg5YzIiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJjbGllbnQxIi...",
"expires_in": 36000,
"token_type": "Bearer"
}

Estimated Costs

The costs in the specified period and the trend compared to previous period.

Authorizations:

BearerAuth

path Parameters

smartmeterId required	string (SmartmeterId) Example: 125fd56 ID of the smartmeter. It must be any non-empty string without whitespaces.
period required	string (Period) Enum: "yesterday" "last-seven-days" "this-week" "last-week" "this-month" "last-month" One of the allowed values that represent the requested period.

Responses

Response samples

200

Content type

application/json

{"value": 29.63,
"previousPeriodValueTrend": 20
}

Consumption

The consumptions in the specified period and the trend compared to previous period.

Authorizations:

BearerAuth

path Parameters

smartmeterId required	string (SmartmeterId) Example: 125fd56 ID of the smartmeter. It must be any non-empty string without whitespaces.
period required	string (Period) Enum: "yesterday" "last-seven-days" "this-week" "last-week" "this-month" "last-month" One of the allowed values that represent the requested period.

Responses

Response samples

200

Content type

application/json

{"value": 73.61,
"previousPeriodValueTrend": 19
}

Consumption Distribution

The total consumptions for each appliance in the specified period.

Authorizations:

BearerAuth

path Parameters

smartmeterId required	string (SmartmeterId) Example: 125fd56 ID of the smartmeter. It must be any non-empty string without whitespaces.
period required	string (Period) Enum: "yesterday" "last-seven-days" "this-week" "last-week" "this-month" "last-month" One of the allowed values that represent the requested period.

Responses

Response samples

200

Content type

application/json

[{"appliance": "fridge",
"consumption": 8800,
"cost": 3.52
},
{"appliance": "washingMachine",
"consumption": 5300,
"cost": 2.31
}
]

Performance

The user's performance in the specified period compared to similar users.

Authorizations:

BearerAuth

path Parameters

smartmeterId required	string (SmartmeterId) Example: 125fd56 ID of the smartmeter. It must be any non-empty string without whitespaces.
period required	string (Period) Enum: "yesterday" "last-seven-days" "this-week" "last-week" "this-month" "last-month" One of the allowed values that represent the requested period.

Responses

Response samples

200

Content type

application/json

{"minConsumption": 10,
"maxConsumption": 130,
"userConsumption": 73.61
}

Savings

The consumptions information collected in the last 30 days.

Authorizations:

BearerAuth

path Parameters

smartmeterId

required

string (SmartmeterId)

Example: 125fd56

ID of the smartmeter. It must be any non-empty string without whitespaces.

Responses

Response samples

200

Content type

application/json

{"estimatedConsumption": 253900,
"estimatedCost": 101.9,
"performance": {"minConsumption": 50000,
"maxConsumption": 410000,
"userConsumption": 253000
},
"washingMachine": {"singleUseConsumption": {"user": 850,
"average": 510
},
"usagesNumber": {"user": 18,
"average": 21
},
"effectiveCost": {"cost": 4.98,
"consumption": 1536
},
"improvementPercentage": 40,
"savings": 24.12
},
"dishwasher": {"singleUseConsumption": {"user": 860,
"average": 870
},
"usagesNumber": {"user": 17,
"average": 14
},
"effectiveCost": {"cost": 4.74,
"consumption": 1463
},
"improvementPercentage": 20,
"savings": 11.4
},
"fridge": {"totalConsumption": {"user": 2727,
"average": 2316
},
"effectiveCost": {"cost": 10.74,
"consumption": 2727
},
"improvementPercentage": 15,
"savings": 19.44
},
"standby": {"totalConsumption": {"user": 78.72,
"average": 40.52
},
"effectiveCost": {"cost": 30.58,
"consumption": 7872
},
"improvementPercentage": 15,
"savings": 19.44,
"history": {"threshold": 1013,
"consumptionsHistory": [{"periodStart": "2023-01-24T00:00:00Z",
"periodEnd": "2023-01-30T00:00:00Z",
"value": 1664
},
{"periodStart": "2023-01-31T00:00:00Z",
"periodEnd": "2023-02-06T00:00:00Z",
"value": 1866
},
{"periodStart": "2023-02-02T00:00:00Z",
"periodEnd": "2023-13-02T00:00:00Z",
"value": 2179
},
{"periodStart": "2023-02-14T00:00:00Z",
"periodEnd": "2023-02-20T00:00:00Z",
"value": 2163
}
]
}
}
}

Consumption History

The consumptions history of the last 12 months.

Authorizations:

BearerAuth

path Parameters

smartmeterId

required

string (SmartmeterId)

Example: 125fd56

ID of the smartmeter. It must be any non-empty string without whitespaces.

Responses

Response samples

200

Content type

application/json

[{"month": 6,
"year": 2022,
"consumption": 316873
},
{"month": 7,
"year": 2022,
"consumption": 444344
},
{"month": 8,
"year": 2022,
"consumption": 314714
}
]

Costs History

The costs history of the last 12 months.

Authorizations:

BearerAuth

path Parameters

smartmeterId

required

string (SmartmeterId)

Example: 125fd56

ID of the smartmeter. It must be any non-empty string without whitespaces.

Responses

Response samples

200

Content type

application/json

{"forecast": {"month": 2,
"year": 2023,
"cost": 218.72
},
"costs": [{"month": 6,
"year": 2022,
"cost": 191.1
},
{"month": 7,
"year": 2022,
"cost": 262.42
},
{"month": 8,
"year": 2022,
"cost": 190.13
}
]
}

Yearly Consumption Distribution

The consumptions history for each appliance of the last 12 months.

Authorizations:

BearerAuth

path Parameters

smartmeterId

required

string (SmartmeterId)

Example: 125fd56

ID of the smartmeter. It must be any non-empty string without whitespaces.

Responses

Response samples

200

Content type

application/json

[{"appliance": "fridge",
"consumption": 8800,
"cost": 3.52
},
{"appliance": "washingMachine",
"consumption": 5300,
"cost": 2.31
}
]

Yearly Compound Consumption

The compound consumptions of the last 12 months.

Authorizations:

BearerAuth

path Parameters

smartmeterId

required

string (SmartmeterId)

Example: 125fd56

ID of the smartmeter. It must be any non-empty string without whitespaces.

Responses

Response samples

200

Content type

application/json

[{"month": 6,
"year": 2022,
"appliancesConsumptions": [{"appliance": "fridge",
"consumption": 27000,
"cost": 16.3
},
{"appliance": "washingMachine",
"consumption": 16900,
"cost": 10.2
}
]
},
{"month": 7,
"year": 2022,
"appliancesConsumptions": [{"appliance": "fridge",
"consumption": 30000,
"cost": 17.9
},
{"appliance": "washingMachine",
"consumption": 15400,
"cost": 9.1
}
]
}
]

Disaggregation

The disaggregated consumptions for each appliance in the specified period.

Authorizations:

BearerAuth

path Parameters

smartmeterId required	string (SmartmeterId) Example: 125fd56 ID of the smartmeter. It must be any non-empty string without whitespaces.
period required	string (Period) Enum: "yesterday" "last-seven-days" "this-week" "last-week" "this-month" "last-month" One of the allowed values that represent the requested period.

Responses

Response samples

200

Content type

application/json

[{"appliance": "whashingMachine",
"consumptions": [{"time": "2023-02-15T09:00:00Z",
"power": 900
},
{"time": "2023-02-15T09:01:00Z",
"power": 910
},
{"time": "2023-02-15T09:02:00Z",
"power": 930
},
{"time": "2023-02-15T09:03:00Z",
"power": 905
},
{"time": "2023-02-15T09:04:00Z",
"power": 1000
}
]
},
{"appliance": "fridge",
"consumptions": [{"time": "2023-02-15T09:00:00Z",
"power": 59
},
{"time": "2023-02-15T09:01:00Z",
"power": 61
},
{"time": "2023-02-15T09:02:00Z",
"power": 61
},
{"time": "2023-02-15T09:03:00Z",
"power": 49
},
{"time": "2023-02-15T09:04:00Z",
"power": 62
}
]
}
]