API docs by Redocly

Vant API (0.6)

Download OpenAPI specification:Download

Access the currently measured weather data

Returns the currently measured weather data, which is automatically converted into the desired units. If no units are passed the configured will be used. Your api key needs read access. Also accessible via /current/live.

query Parameters
rainUnit
string (RainUnit)
Enum: "in" "mm"
windUnit
string (WindUnit)
Enum: "km/h" "mph" "ft/s" "knots" "Bft" "m/s"
pressureUnit
string (PressureUnit)
Enum: "hPa" "inHg" "mmHg" "mb"
solarRadiationUnit
string (SolarRadiationUnit)
Value: "W/m²"
temperatureUnit
string (TemperatureUnit)
Enum: "°C" "°F"
header Parameters
x-api-key
string <uuid>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with read access

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update the currently measured weather data

Updates the current weather conditions. You have to use the configured units. Your api key needs write access.

header Parameters
x-api-key
string <uuidv4>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with write access

Request Body schema: application/json
altimeter
number or null
chill
number or null
consoleBatteryVoltage
number or null
dewpoint
number or null
etDay
number or null
etMonth
number or null
etYear
number or null
forecast
string or null
Enum: "Mostly Clear" "Partly Cloudy" "Mostly Cloudy" "Mostly Cloudy" "Rain within 12 hours" "Mostly Cloudy" "Snow within 12 hours" "Mostly Cloudy" "Rain or Snow within 12 hours" "Partly Cloudy" "Rain within 12 hours" "Partly Cloudy" "Rain or Snow within 12 hours" "Partly Cloudy" "Snow within 12 hours"
forecastID
number or null
Enum: 8 6 2 3 18 19 7 22 23
forecastRule
number or null

Not documented. Please create an issue on https://github.com/harrydehix/vant-api if you know more about this.

heat
number or null
humExtra
Array of numbers or null = 7 items
humIn
number or null
humOut
number or null
leafTemps
Array of numbers or null = 4 items
leafWetnesses
Array of numbers or null = 4 items
press
number or null
pressAbs
number or null
pressCalibrationOffset
number or null
pressRaw
number or null
pressReductionMethod
string or null
Enum: "user offset" "altimeter setting" "NOAA bar reduction"
pressReductionMethodID
number or null
Enum: 0 1 2
pressTrend
string or null
Enum: "Falling Rapidly" "Falling Slowly" "Steady" "Rising Slowly" "Rising Rapidly"
pressTrendID
number or null
Enum: -60 -20 0 20 60
pressUserOffset
number or null
rain15min
number or null
rain1h
number or null
rain24h
number or null
rainDay
number or null
rainMonth
number or null
rainRate
number or null
rainYear
number or null
soilMoistures
Array of numbers or null = 4 items
soilTemps
Array of numbers or null = 4 items
solarRadiation
number or null
stormRain
number or null
stormStartDate
string or null
sunrise
string or null
sunset
string or null
tempExtra
Array of numbers or null = 7 items
tempIn
number or null
tempOut
number or null
thsw
number or null
time
string
transmitterBatteryStatus
number or null

Poorly documented. Create an issue on https://github.com/harrydehix/vant-api if you know more about this.

uv
number or null
wind
number or null
windAvg10m
number or null
windAvg2m
number or null
windDir
string or null
Enum: "NNE" "NE" "ENE" "E" "ESE" "SE" "SSE" "S" "SSW" "SW" "WSW" "W" "WNW" "NW" "NNW" "N"
windDirDeg
number or null [ 1 .. 360 ]
windGust
number or null
windGustDir
string or null
Enum: "NNE" "NE" "ENE" "E" "ESE" "SE" "SSE" "S" "SSW" "SW" "WSW" "W" "WNW" "NW" "NNW" "N"
windGustDirDeg
number or null [ 1 .. 360 ]

Responses

Request samples

Content type
application/json
{
  • "altimeter": null,
  • "chill": 12.3,
  • "consoleBatteryVoltage": 3.5,
  • "dewpoint": 10.3,
  • "etDay": null,
  • "etMonth": null,
  • "etYear": null,
  • "forecast": "Mostly Cloudy",
  • "forecastID": 2,
  • "forecastRule": 0,
  • "heat": 27.2,
  • "humExtra": [
    ],
  • "humIn": 40,
  • "humOut": 65.1,
  • "leafTemps": [
    ],
  • "leafWetnesses": [
    ],
  • "press": 1023.1,
  • "pressAbs": 1012.8,
  • "pressCalibrationOffset": 0.2,
  • "pressRaw": 1012.6,
  • "pressReductionMethod": "altimeter setting",
  • "pressReductionMethodID": 1,
  • "pressTrend": "Steady",
  • "pressTrendID": 0,
  • "pressUserOffset": 0.1,
  • "rain15min": 0.3,
  • "rain1h": 0.9,
  • "rain24h": 12.1,
  • "rainDay": 8.4,
  • "rainMonth": 244.1,
  • "rainRate": 1.2,
  • "rainYear": 823.12,
  • "soilMoistures": [
    ],
  • "soilTemps": [
    ],
  • "solarRadiation": null,
  • "stormRain": 5.6,
  • "stormStartDate": "2023-08-31",
  • "sunrise": "8:13",
  • "sunset": "18:23",
  • "tempExtra": [
    ],
  • "tempIn": 23.1,
  • "tempOut": 12.2,
  • "thsw": 10.3,
  • "time": "2023-08-31T12:23:01Z",
  • "transmitterBatteryStatus": null,
  • "uv": 2,
  • "wind": 13.2,
  • "windAvg10m": 5.3,
  • "windAvg2m": 7.5,
  • "windDir": "E",
  • "windDirDeg": 92,
  • "windGust": 34.4,
  • "windGustDir": "S",
  • "windGustDirDeg": 179
}

Response samples

Content type
application/json
{
  • "success": true,
  • "status": 201
}

Get the latest measured weather data in the given interval

Returns the latest measured weather data in the given interval, which is automatically converted into the desired units. If no units are passed the configured will be used. Your api key needs read access.

path Parameters
interval
required
string (Interval)
Default: "1h"
Enum: "1h" "12h" "24h"

Your desired interval

query Parameters
rainUnit
string (RainUnit)
Enum: "in" "mm"
windUnit
string (WindUnit)
Enum: "km/h" "mph" "ft/s" "knots" "Bft" "m/s"
pressureUnit
string (PressureUnit)
Enum: "hPa" "inHg" "mmHg" "mb"
solarRadiationUnit
string (SolarRadiationUnit)
Value: "W/m²"
temperatureUnit
string (TemperatureUnit)
Enum: "°C" "°F"
header Parameters
x-api-key
string <uuid>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with read access

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Access the currently measured value of a weather element

Returns the currently measured value of a weather element (and the time it has been measured). Your api key needs read access. Also accessible via /current/element/{element}/live.

path Parameters
element
required
string (Element)
Enum: "altimeter" "chill" "consoleBatteryVoltage" "dewpoint" "etDay" "etMonth" "etYear" "forecast" "forecastID" "forecastRule" "heat" "humExtra" "humIn" "humOut" "leafTemps" "leafWetnesses" "press" "pressAbs" "pressCalibrationOffset" "pressRaw" "pressReductionMethod" "pressReductionMethodID" "pressTrend" "pressTrendID" "pressUserOffset" "rain15m" "rain1h" "rain24h" "rainDay" "rainMonth" "rainRate" "rainYear" "soilMoistures" "soilTemps" "solarRadiation" "stormRain" "stormStartDate" "sunrise" "sunset" "tempExtra" "tempIn" "tempOut" "thsw" "transmitterBatteryStatus" "uv" "wind" "windAvg10m" "windAvg2m" "windDir" "windDirDeg" "windGust" "windGustDir" "windGustDirDeg"

Your desired weather element

query Parameters
rainUnit
string (RainUnit)
Enum: "in" "mm"
windUnit
string (WindUnit)
Enum: "km/h" "mph" "ft/s" "knots" "Bft" "m/s"
pressureUnit
string (PressureUnit)
Enum: "hPa" "inHg" "mmHg" "mb"
solarRadiationUnit
string (SolarRadiationUnit)
Value: "W/m²"
temperatureUnit
string (TemperatureUnit)
Enum: "°C" "°F"
header Parameters
x-api-key
string <uuid>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with read access

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Access the latest measured values of a weather element in the given interval

Returns the latest measured values of a weather element in the given interval, which is automatically converted into the desired units. If no units are passed the configured will be used. Your api key needs read access.

path Parameters
interval
required
string (Interval)
Default: "1h"
Enum: "1h" "12h" "24h"

Your desired interval

query Parameters
rainUnit
string (RainUnit)
Enum: "in" "mm"
windUnit
string (WindUnit)
Enum: "km/h" "mph" "ft/s" "knots" "Bft" "m/s"
pressureUnit
string (PressureUnit)
Enum: "hPa" "inHg" "mmHg" "mb"
solarRadiationUnit
string (SolarRadiationUnit)
Value: "W/m²"
temperatureUnit
string (TemperatureUnit)
Enum: "°C" "°F"
header Parameters
x-api-key
string <uuid>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with read access

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Generate a new api key

Returns a new api key. You need a admin api key to create new api keys.

query Parameters
role
string
Enum: "read" "write" "readwrite" "admin"

The role (access privileges) of the generated api key.

header Parameters
x-api-key
string <uuid>
Example: f9484f84-18c2-4318-9ee1-6d1f8fc87dba

An api key with admin rights

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "key": "f9484f84-18c2-4318-9ee1-6d1f8fc87dba",
  • "role": "readwrite",
  • "generated": "2023-08-31T12:23:01Z"
}