Vprobe API Guide

How to Retrieve Live Data

Retrieve the most recent sensor data for your Vprobe device from the cloud. This includes the latest readings sampled by the device.

HTTP GET Request

URL:

https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-live-data?api-key={User API-KEY}&vprobe-sn={Serial Number}

Parameters

  • api-key: Your unique API key generated by the Vplants App. Find it under the ‘Vprobe API’ integration option on the Profile screen in the Vplants App.
  • vprobe-sn: The serial number of your Vprobe device, without leading zeros. The device must be linked to your Vplants account. Find the serial number on the product label or the Plant Overview screen in the Vplants App. (e.g., For Vprobe-SN00000123, use 123).

Example Request

https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-live-data?api-key=VzqLSngwIysS3MZBlOOhcBWOViChTNWOlbDB&vprobe-sn=123

Example in Python


import requests

api_key = "VzqLSngwIysS3MZBlOOhcBWOViChTNWOlbDB"
vprobe_sn = "123"

url = f"https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-live-data?api-key={api_key}&vprobe-sn={vprobe_sn}"

response = requests.get(url)
data = response.json()

print(data)

Response

Returns a JSON object containing the latest sensor readings.

Example Response

{
    "sn": 123,
    "SENSORS": "Lux,C,%,%,%,%,%,1-3",
    "light": 5669.5,
    "tmp": 27.3,
    "hum": 81.9,
    "ms1": 0,
    "ms2": 25,
    "ms3": 46.9,
    "moisture": 36,
    "mSnrs": 2,
    "INDICATORS": "0-GREEN, 1-ORANGE, 2-RED",
    "lightInd": 0,
    "tempInd": 1,
    "humInd": 1,
    "moistureInd": 0,
    "message": [
        "N241",
        "N231"
    ],
    "rev": 31,
    "batt": 2.67,
    "rssi": -69,
    "ts": 1719331200
}

Returned Sensor Values

  • sn: Serial number of the product.
  • SENSORS: Information about measurement units for each sensor.
  • light: Light level in Lux.
  • tmp: Air temperature in °C.
  • hum: Humidity in %.
  • ms1: Moisture sensor 1 in % (top sensor on the 3-level soil moisture sensor).
  • ms2: Moisture sensor 2 in % (middle sensor on the 3-level soil moisture sensor).
  • ms3: Moisture sensor 3 in % (lowest sensor on the 3-level soil moisture sensor).
  • moisture: Average soil moisture level in % from all active sensors.
  • mSnrs: Number of active soil moisture sensors (1-3).
  • INDICATORS: Information about the state of each indicator.
  • lightInd: Light level indicator. See ‘message’ code if not 0.
  • tempInd: Temperature level indicator. See ‘message’ code if not 0.
  • humInd: Humidity level indicator. See ‘message’ code if not 0.
  • moistureInd: Moisture level indicator. See ‘message’ code if not 0.
  • message: Plant health message codes.
  • rev: Message codes revision number.
  • batt: Battery voltage in volts.
  • rssi: Wi-Fi signal strength in dBm.
  • ts: Epoch timestamp in seconds when the reading was taken.

Standard Use Limitations

Up to 20 requests per minute per product. Requests exceeding this limit will fail.

Message Codes, rev 31

Type Code Description
Red N010 🚩 Scheduled watering
N011 🚩 Poor soil drainage
N012 🚩 Not enough water
N013 🚩 Blocked pot drainage
N020 🚩 Insufficient sunlight
N021 🚩 Too much sunlight
N030 🚩 Critically LOW air temperature
N031 🚩 Critically HIGH air temperature
N040 🚩 Relative humidity is LOW
N041 🚩 Relative humidity is HIGH
N070 🚩 Late watering
Orange N201 ⚠️ 3-level sensor not fully inserted
N210 ⚠️ Low moisture level
N211 ⚠️ High moisture level
N220 ⚠️ Insufficient sunlight
N221 ⚠️ Excessive sunlight exposure
N230 ⚠️ Low temperature
N231 ⚠️ High temperature
N240 ⚠️ Humidity is low
N241 ⚠️ Humidity is high
N246 ⚠️ 100% humidity warning
Setup, Greeting, and Other N301 👋 Setup is complete
N340 📷 Submit plant photo
N350 📝 Advisory Report is available
Good Health N410 🔔🍀 Health is good
N411 🔔🍀 Health is good, reminder
Error N700 ❌ Sensor not connected
N710 🌐❌ Vprobe is OFFLINE
N711 ❌ No response from Vprobe
Service N800 ⌛ Evaluating…
N810 ⌛ Identification in progress…
N811 ✅ Identification complete

How to Retrieve Historical Data

Retrieve historical data from the cloud for your Vprobe device. This data includes past sensor readings.

HTTP GET Request

URL:

https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-historical-data?api-key={User API-KEY}&vprobe-sn={Serial Number}&time-range={Epoch1–Epoch2}

Parameters

  • api-key: Your unique API key generated by the Vplants App. Find it under the ‘Vprobe API’ integration option on the Profile screen in the Vplants App.
  • vprobe-sn: The serial number of your Vprobe device, without leading zeros. The device must be linked to your Vplants account. Find the serial number on the product label or the Plant Overview screen in the Vplants App. (e.g., For Vprobe-SN00000123, use 123).
  • time-range: Define the start and end time (in Epoch format) for the readings you want to retrieve. Format: Epoch1–Epoch2.

Example Request

https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-historical-data?api-key=VzqLSngwIysS3MZBlOOhcBWOViChTNWOlbDB&vprobe-sn=123&time-range=1719010800-1719097199

Example in Python


import requests

api_key = "VzqLSngwIysS3MZBlOOhcBWOViChTNWOlbDB"
vprobe_sn = "123"
time_range = "1719010800-1719097199"

url = f"https://nix2n3nq4jwhs6txesrbn4ih5a0tvacw.lambda-url.eu-west-1.on.aws/api-v1/get-historical-data?api-key={api_key}&vprobe-sn={vprobe_sn}&time-range={time_range}"

response = requests.get(url)
data = response.json()

print(data)

Response

Returns a JSON object containing the sensor readings between the specified epoch dates.

Example Response

[
    {
        "light": 3405.9,
        "tmp": 15.3,
        "hum": 83.3,
        "ms1": 0,
        "ms2": 23.2,
        "ms3": 19.4,
        "moisture": 21.3,
        "mSnrs": 2,
        "batt": 2.85,
        "rssi": -64,
        "ts": 1704099600
    },
    {
        "light": 1813.9,
        "tmp": 15.1,
        "hum": 82.9,
        "ms1": 0,
        "ms2": 23,
        "ms3": 19.4,
        "moisture": 21.2,
        "mSnrs": 2,
        "batt": 2.85,
        "rssi": -72,
        "ts": 1704103200
    },
    {
        "light": 2108.6,
        "tmp": 14.7,
        "hum": 84.5,
        "ms1": 0,
        "ms2": 23.1,
        "ms3": 19.3,
        "moisture": 21.2,
        "mSnrs": 2,
        "batt": 2.85,
        "rssi": -72,
        "ts": 1704106800
    }
]

Returned Sensor Values

  • light: Light level in Lux.
  • tmp: Air temperature in °C.
  • hum: Humidity in %.
  • ms1: Moisture sensor 1 in % (top sensor on the 3-level soil moisture sensor).
  • ms2: Moisture sensor 2 in % (middle sensor on the 3-level soil moisture sensor).
  • ms3: Moisture sensor 3 in % (lowest sensor on the 3-level soil moisture sensor).
  • moisture: Average soil moisture level in % from all active sensors.
  • mSnrs: Number of active soil moisture sensors (1-3).
  • batt: Battery voltage in volts.
  • rssi: Wi-Fi signal strength in dBm.
  • ts: Epoch timestamp in seconds when the reading was taken.

Standard Use Limitations

Up to 1000 readings (42 days of data) per request every 10 minutes. Requests for more than 1000 readings within 10 minutes will fail.

Enhance your plant care with Vortex Vitality’s Vprobe smart soil moisture meter. Monitor your plant’s health and environment effortlessly with live and historical data at your fingertips.