SDS P4 API

<back to all web services

Reading

Get readings of a metering point

The following routes are available for this service:
GET/api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom}Shows all readings available after DateFrom
GET/api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom}/{DateTo}Shows readings for period
Reading Parameters:
NameParameterData TypeRequiredDescription
EanpathEAN (18 numbers)NoRequest of details of specific metering point with Ean
FilterpathEnum: none/hour/day/month/yearYesDetail gives hourly readings for gas and 15 minutes readings for electricity. Only register 1.8.0 (G&E) and 2.8.0 (E) are available. The Day and Month filter are by default also based on the detail readings. Optional it is possible to get the values from the day channels. Advantage: readings are the readings visible as on the smart meter and for electricity the High/Low distinction is available. Downside: for some of the older smart meter models, no decimals are available. Registers starting with 1 are usage, starting with 2 are return. Registers ending on 1 are normal/high tariff, ending on 2 are low/night/weekend tariff. For gas only register 1.8.0 is available. For electricity 1.8.1/1.8.2/2.8.1/2.8.2 are available
DateFrompathDate: yyyy-mm-ddYesStart date the readings are requested for
DateTopathDate: yyyy-mm-ddNoEnd date the readings are requested for (this date is included in the response). If no date is provided the DateTo will be seven days from DateFrom.
SourcequeryEnum: detail/dayNoSee filter. Readings are available from the Detail or Day channel. Default value: Detail
AddDateNLqueryBooleanNoAdd column with Dutch day (Default: false)
AddFirstReadingNextDayqueryBooleanNoAdd the first reading of the next day if available. Only available/relevant if no aggregation / source is detail (Default: true)
AddTimestampsqueryBooleanNoAdd columns with CreatedOn and LastUpdated (Default: false)
AddEanqueryBooleanNoAdd column with ean (Default: false)
AddMeterIdqueryBooleanNoAdd column with the meter serial number (Default: false)
RegistersInRowsqueryBooleanNoCreate a row for each register instead of a column/field for each register (Default: false)
Generic Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformStringYesApi-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY
OnlyPayloadformBooleanNoNormally the result of the request is put inside a resultobject with some status information about the request. If you want the output as csv this outer object can be irritating. Default value: FALSE
ShowRequestformBooleanNoShow the request as interpreted by the api. Useful to see how filters / dates are parsed. If no value us provided, the default value is: FALSE
DateTimeFormatformEnumNoFormat all DateTime in the response object. If used in browser, sometimes ISO8601 is not correctly transformed. Enum options: ISO8601 (DEFAULT), UTC, NL, NLOffset, Unix, UnixMillis
DateTimeFormat Enum:
ISO8601
UTC
NL
NLOffset
IN
INOffset
Unix
UnixMillis
Filter Enum:
None
Hour
Day
Month
Year
MeasurementSource Enum:
Detail
Day
Month
Unknown

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v5/meteringpoints/{Ean}/readings/{Filter}/{DateFrom} HTTP/1.1 
Host: p4v8.smartdatasolutions.nl 
Accept: application/json