Home / Products / FIAM – Eneco Data Consumer Overview
API menu
Overview

FIAM API Documentation

Why this API?

KPN FIAM enables external parties to retrieve usage data of Eneco’s customers, provided that the customer has given their consent.

The process works as follows:

  • The external party registers with KPN.
  • Eneco’s customers indicate via the app or portal whether they wish to share their usage data with this external party.
  • Consent is recorded by KPN.

Eneco has no knowledge of the external parties and therefore has no visibility into the consent that has been granted.

Endpoints

There are two endpoints to retrieve data from:

  • usages
  • metadata

Authentication is required. A Consumer-Token header must be provided.
This token can be obtained from KPN.

When calling the usages or metadata endpoint, the Consumer-Token is validated.
If the token is invalid or expired, no data will be returned.

The usages endpoint

This endpoint retrieves the customer’s usage data in hourly intervals.


      
      
        
        
        
            
      
/dataconsumer/{dataOwnerId}/{productType}/usages

Route parameters

Name Data type Description
dataOwnerId GUID The unique global identifier of the customer
productType String Only heat is supported

Response

Name Data type Description
startDate DateTime Start date of the usage period
endDate DateTime End date of the usage period
usageChannels UsageChannel[] List of usage channels

UsageChannel

Name Data type Description
channelId String Name of the usage source
unit Units Centigrade, KiloWattHour, CubicMeter
usageRecord UsageRecord[] List of usage records

Possible values for channelId:

  • Gas
  • Warmth
  • Electricity
  • Redelivery
  • Produced
  • Tapwater
  • Cooling

UsageRecord

Name Data type Description
amount Decimal Amount of unit used
timestamp DateTime Timestamp of the usage

Limitations

  • It is not possible to filter on a specific channel.

Errors

  • 404 – Data owner not found
  • 400 – Missing Consumer-Token header
  • 400 – Invalid route parameter
  • 400 – Access denied
  • 400 – Invalid end date
  • 500 – Server error

The metadata endpoint

This endpoint retrieves metadata of the customer.


      
      
        
        
        
            
      
/dataconsumer/{dataOwnerId}/{productType}/metadata

Route parameters

Name Data type Description
dataOwnerId GUID The unique global identifier of the customer
productType String Only heat is supported

Response

Currently, only the customer’s address is returned.

Name Data type Description
City String?
Country String?
HouseNumber Int?
PostalCode String?
HouseNumberSuffix String?
Street String?

Limitations

  • It is not possible to select single fields.

Errors

  • 404 – Data owner not found
  • 400 – Missing Consumer-Token header
  • 400 – Invalid route parameter
  • 400 – Access denied
  • 500 – Server error
Home / Products / FIAM – Eneco Data Consumer Overview