Meetdata API 

API-versie v2.0

 

De meetdata API maakt het mogelijk om meetdata op te vragen waartoe u toegang heeft.

 

REST

De meetdata api maakt gebruikt van Representational State Transfer (REST) om gegevens via het web te ontsluiten.


Heeft u vragen of opmerkingen over de mogelijkheden tot data-ontsluiting of heeft u technische vragen neem dan contact op met Energiemissie via [email protected]

 

Fair use policy

De API wordt beschikbaar gesteld op basis van een ‘fair use’ policy. Bij overmatig gebruik, bijvoorbeeld door in korte tijd meerdere malen de totale historie opnieuw binnen te halen, kunnen wij kosten in rekening brengen of uw account tijdelijk- of geheel intrekken.

 

Content-Type: application/json

Voor de uitwisseling van gegevens wordt er gebruikt gemaakt van JSON. De webservice accepteert in een POST request uitsluitend een JSON en geeft altijd een JSON-response terug.

 

Statuscodes

Waar mogelijk wordt gebruikt gemaakt van de juiste http-statuscodes. De statuscodes die gehanteerd worden zijn conform de richtlijnen van W3C. De statuscodes die de API hanteert zijn:

 

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

500 - Internal Server Error

 

Base URI

https://mijnenergiemissie.nl

Authenticatie

Om gebruik te kunnen maken van de EM webservice v2 dient de api key in de x-api-key header te worden mee gestuurd.


Voorbeeld request met authenticatie:

curl -XPOST -H "Content-type: application/json"
            -H "X-API-KEY: xxxxx.apikey"
            https://mijnenergiemissie.nl/webservice/v2/path


Resources 

 

Get meter list 


URL

GET /webservice/v2/meters


Parameters 


NameDescription
statusstring (query)
name
string (query)
ean
string (query)
streetstring (query)
street_numberstring (query)
street_number_addition
string (query)
postal_code
string (query)
city
string (query)


 

Response 

List of meters (code: 200 - OK) 


Example: 

[
    {
        "id": "int",
        "status": "string",
        "meter_type_1": "string",
        "meter_type_2": "string",
        "meter_type_3": "string",
        "name": "string",
        "ean": "string",
        "street": "string",
        "street_number": "string",
        "street_number_addition": "string",
        "postal_code": "string",
        "city": "string",
        "gps": "string",
        "oda_status": "string|null",
        "measurement_data_source": "string",
        "financial_characteristic_1": "string|null",
        "financial_characteristic_2": "string|null",
        "financial_characteristic_3": "string|null",
        "financial_characteristic_4": "string|null",
        "financial_characteristic_5": "string|null",
        "financial_characteristic_6": "string|null",
        "measurement_data_source_timestamp": "int",
        "created_at": "2001-01-01T00:00:00+01:00",
        "commodity": "string"
    },
    ...
]

 

Get month measurement

URL:

GET /webservice/v2/measurements/{meterId}/types/{type}/months/{year}/{month}

 

Parameters

NameDescription
meterIdint (path)
typestring, options: interval, daily, month (path)
yearinteger (yyyy) (path)
monthinteger (1 - 12) (path)


Response

Measurement response (code: 200 - OK) 


Example: 


[
    {
        "channel": "string",
        "values": [
            {
                "timestamp": 123456789,
                "value": 1.1
            },
            {
                "timestamp": 123456789,
                "value": 1.1
            },
            ...
        ]
    },
    ...
]

Get day measurement

URL:

GET /webservice/v2/measurements/{meterId}/types/{type}/days/{year}/{month}/{day}

 

Parameters

NameDescription
meterIdint (path)
typestring, options: interval, daily (path)
yearinteger (yyyy) (path)
monthinteger (1 - 12) (path)
dayinteger (1 - 31) (path)


Response

Measurement response (code: 200 - OK) 


Example: 


[
    {
        "channel": "string",
        "values": [
            {
                "timestamp": 123456789,
                "value": 1.1
            },
            {
                "timestamp": 123456789,
                "value": 1.1
            },
            ...
        ]
    },
    ...
]

 

Channels


ChannelType
EenheidOmschrijving
DELIVERYIntervalwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ		Levering integraal
DELIVERY_LOW
Intervalwaarde
Elektra kWhLevering laag
DELIVERY_HIGH
Intervalwaarde
Elektra kWhLevering hoog
BACKDELIVERYIntervalwaardeElektra kWh
Gas m3
Warmte GJ
Koude GJ
Teruglevering integraal
BACKDELIVERY_LOWIntervalwaardeElektra kWh
Teruglevering laag
BACKDELIVERY_HIGH
IntervalwaardeElektra kWh
Teruglevering hoog
REACTIVE_DELIVERYIntervalwaarde
Elektra kVARh
Levering blindstroom
REACTIVE_BACKDELIVERY
IntervalwaardeElektra kVARh
Teruglevering blindstroom
DELIVERY_MAXDagwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ
Max. gemeten klokkwartier of klokuur levering 
BACKDELIVERY_MAXDagwaardeElektra kWh
Gas m3
Warmte GJ
Koude GJ		Max. gemeten klokkwartier of klokuur teruglevering
DELIVERY_MAX_INVOICE
MaandwaardeElektra kW
Gas m3/h
Warmte GJ/h
Koude GJ/h
Max. gemeten piekwaarde levering factuurwaarden
BACKDELIVERY_MAX_INVOICE
Maandwaarde
Elektra kW
Gas m3/h
Warmte GJ/h
Koude GJ/h
Max. gemeten piekwaarde teruglevering factuurwaarden
DELIVERY_INVOICEMaandwaardeElektra kWh
Gas m3
Warmte GJ
Koude GJ
Levering integraal factuurwaarden
DELIVERY_LOW_INVOICEMaandwaarde
Elektra kWh
Levering laag factuurwaarden
DELIVERY_HIGH_INVOICEMaandwaarde
Elektra kWh
Levering hoog factuurwaarden
BACKDELIVERY_INVOICE
Maandwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ		Teruglevering  integraal factuurwaarden
BACKDELIVERY_LOW_INVOICEMaandwaarde
Elektra kWh
Teruglevering laag factuurwaarden
BACKDELIVERY_HIGH_INVOICEMaandwaarde
Elektra kWh
Teruglevering hoog factuurwaarden
MANUAL_DELIVERY_LOWIntervalwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ
Handmatig ingevoerde meetdata levering laag
MANUAL_DELIVERY_HIGHIntervalwaardeElektra kWh
Gas m3
Warmte GJ
Koude GJ
Handmatig ingevoerde meetdata levering hoog
MANUAL_BACKDELIVERY_LOWIntervalwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ		Handmatig ingevoerde meetdata teruglevering laag
MANUAL_BACKDELIVERY_HIGHIntervalwaarde
Elektra kWh
Gas m3
Warmte GJ
Koude GJ		Handmatig ingevoerde meetdata teruglevering hoog