API documentation Meterbeheer HUB

Table of contents

• Authentication
• Base URL
• Endpoints
  • Get list of all your feeds
  • Add a feed:
    • Response after adding a feed
    • What happens after creating a feed?
  • Delete a feed

---

Authentication

To authenticate, the API utilizes API keys. Please navigate to the API keys page to generate your own set of keys.
To ensure proper authentication, please include your API key in the Authorization HTTP header for all API requests, following the format below.

---

Base URL

Test base URL

Production base URL

---

Endpoints

Get list of all your feeds

GET /feed

Example curl GET query

---

Response after adding a feed

After a successful request, the API will return a JSON response with the following fields:

Field	Type	Description
uuid	string	The unique identifier of the newly created feed
provider	string	The name of the provider
name	string	The name of the feed
status	string	The status of the feed. Can be pending or verified.
ean	string	EAN of the meter (18 digits, e.g. 870111222333444557)
postalCode	string	Dutch postal code of the address of the meter (e.g. 1234 AB)
houseNumber	string	House number of the address of the meter
channels	array	Array of available channels of the feed. Each array item contains the code (string) and the url (string) of the channel.

---

What happens after creating a feed?

After creating a feed, the API will start the verification process if needed. Once a meter is verified, our system will start to fetch data from the provider. This process can take up to 24 hours. The data will then be available through the feeds.

The system will first fetch the data from the previous day. After that it will start to fetch historical data.

---

Delete a feed

DELETE /feed/{uuid}

Field	Type	Description
uuid	string	The unique identifier of the feed that needs to be deleted

Example curl DELETE query