Module detail

GET /modules/{id}

Scope readings:read
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Path parameters

id integer required

Query parameters

lang string

Language of the label fields, and of a probe’s default name (name: “Probe 3”, “Sonde 3”). The code values never vary. A crop with no translation falls back to its French name.

Values: enfr

Default: en

Response

200

The module

id integer always present
uid string always present

Technical identifier of the module, the one the gateway transmits.
name string nullable always present

Name of the probe, as the hub displays it: the one the customer gave it, otherwise its default name — “Probe 3” or “Sonde 3” depending on lang. Unique within the company. null: the module has neither a name nor a number — a tensiometer, for example.
serialHex string nullable always present

Hardware serial number, in hexadecimal. null if not filled in.
category string nullable always present

SOIL_PROBE: soil probe, moisture and temperature per depth. TENSIOMETER: tensiometer probe. WEATHER_STATION: weather station.

Values: SOIL_PROBETENSIOMETERWEATHER_STATIONnull
location ModuleLocation nullable always present

DECLARED position of the probe — the one that drives the weather and the charts. null: probe not positioned; it is placed on the hub’s map.
Show 5 attributes Hide attributes
- lat number always present
  
  WGS 84 latitude, in decimal degrees.
- lon number always present
  
  WGS 84 longitude, in decimal degrees.
- source string always present
  
  manual: placed by hand. seeded: taken, once, from a plausible GPS position of the gateway. gateway: taken automatically from the new gateway’s GPS, after the probe moved to another gateway.
  
  Values: manualseededgateway
- stale boolean always present
  
  true: the probe has moved to another gateway, or been detached from one, since it was declared — position to be reconfirmed.
- driftMeters integer nullable always present
  
  Gap with the gateway’s last GPS position, in metres. null if the gateway’s GPS is silent.
parcelId integer nullable always present

Parcel the module belongs to. null if none.
sensors array of ModuleSensor always present

One sensor of the module. A soil probe carries two per depth: moisture and temperature.
Show 4 attributes Hide attributes
- id integer always present
- type string nullable always present
  
  Quantity measured.
  
  Values: humiditytemperaturetensio
- depth number nullable always present
  
  Depth, in cm (0 = surface).
- label string nullable always present
  
  Free-form label. null if not filled in.
currentGateway object nullable always present

4G gateway the module is plugged into: it is the one transmitting its measurements. null: plugged into no gateway.
Show 2 attributes Hide attributes
- id integer always present
- imei string always present
  
  IMEI of the gateway.

Errors

400
Invalid parameter

invalid_id
401
Not authenticated
403
Insufficient scope, or resource outside your company
404
Module not found: owned, but never commissioned

not_found

GET /modules/{id}

curl https://api.hub.akuasense.com/v1/modules/256 \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/modules/256',
  {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/modules/256",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "id": 256,
  "uid": "DEMO-MOD-008",
  "name": "Probe 1",
  "serialHex": null,
  "category": "SOIL_PROBE",
  "location": {
    "lat": 48.995762,
    "lon": 1.775296,
    "source": "manual",
    "stale": false,
    "driftMeters": 0
  },
  "parcelId": null,
  "sensors": [
    {
      "id": 982,
      "type": "humidity",
      "depth": 0,
      "label": null
    },
    {
      "id": 983,
      "type": "humidity",
      "depth": 15,
      "label": null
    },
    {
      "id": 984,
      "type": "humidity",
      "depth": 30,
      "label": null
    },
    {
      "id": 985,
      "type": "humidity",
      "depth": 45,
      "label": null
    },
    {
      "id": 986,
      "type": "humidity",
      "depth": 60,
      "label": null
    },
    {
      "id": 987,
      "type": "temperature",
      "depth": 0,
      "label": null
    },
    {
      "id": 988,
      "type": "temperature",
      "depth": 15,
      "label": null
    },
    {
      "id": 989,
      "type": "temperature",
      "depth": 30,
      "label": null
    },
    {
      "id": 990,
      "type": "temperature",
      "depth": 45,
      "label": null
    },
    {
      "id": 991,
      "type": "temperature",
      "depth": 60,
      "label": null
    }
  ],
  "currentGateway": {
    "id": 191,
    "imei": "DEMO-GW-006"
  }
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_id"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "code": "not_found"
}

application/problem+json · example generated from the schema