The API organises objects in a logical and hierarchical structure for straight-forward navigation.

Generally objects are organised as follows:

In order to get to the data, you'll need to traverse the API structure starting with the Controller. Here's an example:

Controller

First, you'll want to see what Controllers are available on your Account.

This will list your Controllers and their details.

Choose a specific Controller and request it using it's ID.

Request all Controllers

<!-- GET -->
https://nexcloud.io/v1.0/Controller

Request a specific Controller

<!-- GET -->
https://nexcloud.io/v1.0/Controller/5

Device

Now that you have a Controller chosen, you can list all Devices connected to it.

These could be LAN devices, like power meters, or other sources, like an internet weather feed, etc.

Choose a specific Device and request it using it's ID.

Request all Devices on a Controller

<!-- GET -->
https://nexcloud.io/v1.0/Controller/5/Device

Request a specific Device

<!-- GET -->
https://nexcloud.io/v1.0/Device/15

Data Point

Using the Device ID, you can see what Data Points are connected. A Data Point is a discreet data channel, like a temperature sensor reading, or phase-A current on a power meter.

Again, you can get the details of a specific Data Point using it's ID.

Now that we have a specific DataPoint, we are ready to retrieve data. This is covered in the next section.

Request all DataPoints on a Device

<!-- GET -->
https://nexcloud.io/v1.0/Device/15/DataPoint

Request a specific Data Point

<!-- GET -->
https://nexcloud.io/v1.0/DataPoint/123

Related articles

Browser not supported