Crops (code+label)

GET /reference/crops

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

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

Crop catalog, sorted on the French name whatever lang is

• data array of CropReference always present

  A crop from the shared catalog. root_depth_min_cm and root_depth_max_cm do NOT describe root growth (a start and an end): they are the two bounds of one and the same MAXIMUM depth, which depends on the soil.

  Show 5 attributes Hide attributes

  • code string always present

    Stable identifier of the crop. This is the value to pass, as an integer, in cropId of PUT /modules/{id}/crop.

  • label string always present

    Name of the crop in the requested language (lang). With no English translation, falls back to the French name.

  • scientific_name string nullable always present

    Scientific name. null if not filled in.

  • root_depth_min_cm number always present

    Maximum root depth in HEAVY soil, in cm — the lower bound of the FAO-56 range. This is the one the hub uses to drive irrigation, constant over the whole cycle.

  • root_depth_max_cm number always present

    Maximum root depth in LIGHT soil, in cm — the upper bound. FAO-56 reserves it for water-stress modelling and rain-fed crops.

Errors

• 401

  Not authenticated

• 403

  Insufficient scope, or resource outside your company

GET /reference/crops

cURL JavaScript Python

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

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

import requests

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

Response

200 401 403

{
  "data": [
    {
      "code": "31",
      "label": "Avocado",
      "scientific_name": "Persea americana",
      "root_depth_min_cm": 50,
      "root_depth_max_cm": 100
    },
    {
      "code": "32",
      "label": "Gold kiwifruit",
      "scientific_name": "Actinidia chinensis",
      "root_depth_min_cm": 70,
      "root_depth_max_cm": 130
    },
    {
      "code": "26",
      "label": "Temporary grassland",
      "scientific_name": null,
      "root_depth_min_cm": 60,
      "root_depth_max_cm": 100
    },
    {
      "code": "24",
      "label": "Grapevine (wine grape)",
      "scientific_name": "Vitis vinifera",
      "root_depth_min_cm": 100,
      "root_depth_max_cm": 200
    }
  ]
}

application/json

{
  "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