Skip to content

Meteorological information

A meteorological (met) station reports temperature, pressure, humidity and precipitation, plus optional power readings. See API usage information for authentication and the response envelope.

Add meteorological station

POST/add/met

Creates a new meteorological station for the logged-in user and returns its id and token.

Request

Auth: api_key (query param or cookie) · Content-type: application/x-www-form-urlencoded

Request body:

Send the fields as form data.

Field name Description Type
met_name Name of the station str
met_type Free-text station type str
update_period Expected seconds between updates; used to decide Online/Offline int
met_token [Optional] Token used to authenticate updates. Generated when omitted str
last_modified [Optional] Initial last-update time (epoch seconds). Default: now int

Request example:

https://spoilerinterface.com/interface/add/met?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Form data:

met_name=Rooftop station&met_type=Weather&update_period=600

Response

{
    "success": {
        "met_id": 551659085216623,
        "met_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
    }
}

Field description

Field name Description Type
met_id Generated meteorological station id. Use it with the token to push updates int
met_token The supplied token, or a generated 100-character hex token str

Fails with Maximum number of devices reached. Please upgrade your account. when the account's device limit is reached.

Meteorological station count

GET/met/count

Returns the number of meteorological stations owned by the user.

Request

Auth: api_key (query param or cookie)

Request body:

None

Request example:

https://spoilerinterface.com/interface/met/count?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Response

{
    "success": {
        "mets": 2
    }
}

List meteorological stations

GET/met/list

Lists every meteorological station owned by the user, with its token and current status.

Request

Auth: api_key (query param or cookie)

Request body:

None

Request example:

https://spoilerinterface.com/interface/met/list?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Response

{
    "success": [
        {
            "met_id": 551659085216623,
            "met_name": "Rooftop station",
            "met_type": "Weather",
            "met_status": "Online",
            "met_temperature": 22.4,
            "met_pressure": 1013.2,
            "met_humidity": 48.0,
            "met_precipitation": 0.0,
            "met_voltage": 12.6,
            "met_current": 0.4,
            "met_power": 5.0,
            "met_soc": 95.0,
            "met_details": "{}",
            "update_period": 600,
            "last_modified": 1763025300,
            "met_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2",
            "notification_enabled": true,
            "alarms": [],
            "whatsapp_enabled": false,
            "temperature_units": "C",
            "pressure_units": "hPa",
            "humidity_units": "%",
            "precipitation_units": "mm",
            "voltage_units": "V",
            "current_units": "A",
            "power_units": "W",
            "soc_units": "%",
            "sms_enabled": false,
            "notification_users": []
        }
    ]
}

Field description

Field name Description Type
met_id Station id int
met_name Station name str
met_type Station type str
met_status Online or Offline str
met_temperature Latest temperature float
met_pressure Latest pressure float
met_humidity Latest humidity float
met_precipitation Latest precipitation float
met_voltage Latest voltage float
met_current Latest current float
met_power Latest power float
met_soc Latest state of charge float
met_details Details JSON as stored json
update_period Expected seconds between updates. The device is reported Offline when no update arrives within this period int
last_modified Epoch time (seconds) of the last update, shifted by the account's time_offset (minutes) int
met_token Station token str
notification_enabled Email status notifications enabled. null in the database is reported as true by /status and /list bool
alarms Alarms configured for the device arr
whatsapp_enabled WhatsApp notifications enabled (may be null) bool
temperature_units Display units str
pressure_units Display units str
humidity_units Display units str
precipitation_units Display units str
voltage_units Display units str
current_units Display units str
power_units Display units str
soc_units Display units str
sms_enabled SMS notifications enabled (may be null) bool
notification_users Extra notification recipients (see /edit) arr

met_status is recalculated on every request: Online when the last update is within update_period seconds, otherwise Offline.

Meteorological station status

GET/met/status

Returns the current status of a single meteorological station. Authenticated with the device id and token.

Request

Auth: Device id + token (no api_key) · Content-type: application/json (only when sending a JSON body)

Request body:

Send as query parameters or a JSON body.

Field name Description Type
met_id Meteorological station id int
met_token Meteorological station token str

Request example:

Params:

https://spoilerinterface.com/interface/met/status?met_id=551659085216623&met_token=9f2c4e7a1b3d5f60718293a4

JSON body:

{
    "met_id": 551659085216623,
    "met_token": "9f2c4e7a1b3d5f60718293a4"
}

Response

{
    "success": {
        "met_id": 551659085216623,
        "met_name": "Rooftop station",
        "met_type": "Weather",
        "met_status": "Online",
        "met_temperature": 22.4,
        "met_pressure": 1013.2,
        "met_humidity": 48.0,
        "met_precipitation": 0.0,
        "met_voltage": 12.6,
        "met_current": 0.4,
        "met_power": 5.0,
        "met_soc": 95.0,
        "met_details": "{}",
        "last_modified": 1763025300,
        "update_period": 600,
        "notification_enabled": true,
        "whatsapp_enabled": false,
        "sms_enabled": false,
        "temperature_units": "C",
        "pressure_units": "hPa",
        "humidity_units": "%",
        "precipitation_units": "mm",
        "voltage_units": "V",
        "current_units": "A",
        "power_units": "W",
        "soc_units": "%",
        "alarms": [],
        "notification_users": null
    }
}

Field description

Field name Description Type
met_id Station id int
met_name Station name str
met_type Station type str
met_status Online or Offline str
met_temperature Latest temperature float
met_pressure Latest pressure float
met_humidity Latest humidity float
met_precipitation Latest precipitation float
met_voltage Latest voltage float
met_current Latest current float
met_power Latest power float
met_soc Latest state of charge float
met_details Details JSON as stored json
last_modified Epoch time (seconds) of the last update, shifted by the account's time_offset (minutes) int
update_period Expected seconds between updates. The device is reported Offline when no update arrives within this period int
notification_enabled Email status notifications enabled. null in the database is reported as true by /status and /list bool
whatsapp_enabled WhatsApp notifications enabled (may be null) bool
sms_enabled SMS notifications enabled (may be null) bool
temperature_units Display units str
pressure_units Display units str
humidity_units Display units str
precipitation_units Display units str
voltage_units Display units str
current_units Display units str
power_units Display units str
soc_units Display units str
alarms Alarms configured for the device arr
notification_users Extra notification recipients (see /edit) arr

Update meteorological station

POST/update/met

Pushes new weather readings.

Request

Auth: Device id + token (no api_key) · Content-type: application/json (only when sending a JSON body)

Request body:

Send as query parameters or a JSON body (query parameters win when both are present).

Field name Description Type
met_id Station id int
met_token Station token str
met_temperature Temperature float
met_pressure Pressure float
met_humidity Humidity float
met_precipitation Precipitation float
met_voltage [Optional] Voltage. Default 0 float
met_current [Optional] Current. Default 0. In a JSON body it is only read when met_voltage is also sent float
met_power [Optional] Power. Default 0 float
met_soc [Optional] State of charge. Default 0. In a JSON body it is only read when met_power is also sent float
met_details [Optional] JSON object as a string. Default {} json
epoch_time [Optional] Measurement time (epoch seconds). Default: server time. Used for the history record; the current last_modified is set to server time int

Request example:

Params:

https://spoilerinterface.com/interface/update/met?met_id=551659085216623&met_token=9f2c4e7a1b3d5f60718293a4&met_temperature=22.4&met_pressure=1013.2&met_humidity=48&met_precipitation=0

JSON body:

{
    "met_id": 551659085216623,
    "met_token": "9f2c4e7a1b3d5f60718293a4",
    "met_temperature": 22.4,
    "met_pressure": 1013.2,
    "met_humidity": 48.0,
    "met_precipitation": 0.0,
    "met_voltage": 12.6,
    "met_current": 0.4,
    "met_power": 5.0,
    "met_soc": 95.0,
    "met_details": "{}",
    "epoch_time": 1763025300
}

Response

{
    "success": "success"
}

Updates are rate limited by the owner's account type (account type 1 or unset: 59 s, types 2-4: 30 s, type 5 and above: 1 s between updates, measured against the previous last_modified). A blocked update returns HTTP 400:

{
    "failed": {
        "message": "Please wait for the update period to lapse. Remaining time is: 21",
        "remaining_time_sec": 21
    }
}

Meteorological station history

GET/met/history

Returns the recorded history of the user's meteorological stations, oldest record first.

Request

Auth: api_key (query param or cookie) · Content-type: application/json

Request body:

Send the filters as a JSON body. A body is required, even if it is only {} (without one the request fails). limit and offset may also be sent as query parameters, but min_epoch_tm_sec, max_epoch_tm_sec and device_id are only read from the JSON body.

Field name Description Type
min_epoch_tm_sec [Optional] Start of the window (epoch seconds). Default: now minus 2 days (172800 s) float
max_epoch_tm_sec [Optional] End of the window (epoch seconds). Default: now float
device_id [Optional] Return only this meteorological station (must belong to the user, otherwise Invalid device_id). Default: all of the user's meteorological stations int
limit [Optional] Maximum records per device. Default and maximum: 20000 int
offset [Optional] Records to skip per device (for paging). Default: 0 int

Request example:

https://spoilerinterface.com/interface/met/history?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

JSON body:

{
    "min_epoch_tm_sec": 1762992000,
    "max_epoch_tm_sec": 1763078400,
    "device_id": 551659085216623,
    "limit": 1000,
    "offset": 0
}

Response

{
    "success": [
        {
            "met_id": 551659085216623,
            "met_name": "Rooftop station",
            "min_time": 1700000000,
            "max_time": 1763025300,
            "met_type": "Weather",
            "data": [
                {
                    "met_temperature": 22.4,
                    "met_pressure": 1013.2,
                    "met_humidity": 48.0,
                    "met_precipitation": 0.0,
                    "met_voltage": 12.6,
                    "met_current": 0.4,
                    "met_power": 5.0,
                    "met_soc": 95.0,
                    "met_details": "{}",
                    "update_time": "2026-11-13T09:15:00"
                }
            ]
        }
    ]
}

Field description

Field name Description Type
met_id Station id int
met_name Station name str
min_time Earliest last_modified across all of the user's history records of this type (not only the requested window), plus the account's time_offset int
max_time Latest last_modified across all of the user's history records of this type, plus the account's time_offset int
met_type Station type str
data History records in the requested window arr
has_more Present (true) only when the device returned 20000 records; request the next page with offset bool

Each data item:

Field name Description Type
met_temperature Recorded temperature float
met_pressure Recorded pressure float
met_humidity Recorded humidity float
met_precipitation Recorded precipitation float
met_voltage Recorded voltage float
met_current Recorded current float
met_power Recorded power float
met_soc Recorded state of charge float
met_details Details JSON stored with the record json
update_time Record time as an ISO date-time string, shifted by the account's time_offset str

Edit meteorological station

POST/edit/met

Changes the name, token, update period, display units or notification recipients of a meteorological station owned by the user.

Request

Auth: api_key (query param or cookie) · Content-type: application/json (only when sending a JSON body)

Request body:

Send as query parameters or a JSON body (query parameters win).

Field name Description Type
met_id Station id (must belong to the user) int
met_name [Optional] New name str
met_token [Optional] New token. Devices must use the new token afterwards str
update_period [Optional] New update period (seconds) int
temperature_units [Optional] Display units. Reset to an empty string when omitted str
pressure_units [Optional] Display units. Reset to an empty string when omitted str
humidity_units [Optional] Display units. Reset to an empty string when omitted str
precipitation_units [Optional] Display units. Reset to an empty string when omitted str
voltage_units [Optional] Display units. Reset to an empty string when omitted str
current_units [Optional] Display units. Reset to an empty string when omitted str
power_units [Optional] Display units. Reset to an empty string when omitted str
soc_units [Optional] Display units. Reset to an empty string when omitted str
notification_users [Optional] JSON string holding an array of extra notification recipients. Each item: email (required), name, status_alerts, threshold_alerts, sms_alerts, whatsapp_alerts (booleans) and mobile_number (required, + and country code, when sms_alerts or whatsapp_alerts is true). Omit it to keep the current list json

Request example:

https://spoilerinterface.com/interface/edit/met?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

JSON body:

{
    "met_id": 551659085216623,
    "met_name": "Rooftop station",
    "update_period": 600,
    "temperature_units": "C",
    "pressure_units": "hPa",
    "humidity_units": "%",
    "precipitation_units": "mm",
    "voltage_units": "V",
    "current_units": "A",
    "power_units": "W",
    "soc_units": "%"
}

Response

{
    "success": "success"
}

Fails with Not allowed... when the device belongs to another user, and with Validation error in notification_users: ... when notification_users is invalid.

Delete meteorological station

POST/delete/met

Deletes a meteorological station and all of its history records.

Request

Auth: api_key (query param or cookie) · Content-type: application/x-www-form-urlencoded

Request body:

Send the fields as form data.

Field name Description Type
met_id Meteorological station id int
met_token Meteorological station token str

Request example:

https://spoilerinterface.com/interface/delete/met?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Form data:

met_id=551659085216623&met_token=9f2c4e7a1b3d5f60718293a4

Response

{
    "success": "success"
}

Only the owner can delete a device (Not allowed otherwise).

Notification settings

POST/notifications/{device_type}/{alert_type}/{action}

Enables or disables email, WhatsApp or SMS notifications for one meteorological station. Replaces the old per-type enable/disable endpoints.

Request

Auth: api_key (query param or cookie) and device id + token · Content-type: application/json (only when sending a JSON body)

Request body:

device_type is met. alert_type is alerts (email status notifications, notification_enabled), whatsapp (whatsapp_enabled) or sms (sms_enabled). action is enable or disable.

Send the device credentials as query parameters or a JSON body.

Field name Description Type
device_id Meteorological station id int
device_token Meteorological station token str

URLs for this device type:

  • https://spoilerinterface.com/interface/notifications/met/alerts/enable
  • https://spoilerinterface.com/interface/notifications/met/alerts/disable
  • https://spoilerinterface.com/interface/notifications/met/whatsapp/enable
  • https://spoilerinterface.com/interface/notifications/met/whatsapp/disable
  • https://spoilerinterface.com/interface/notifications/met/sms/enable
  • https://spoilerinterface.com/interface/notifications/met/sms/disable

Request example:

https://spoilerinterface.com/interface/notifications/met/alerts/disable?api_key=3b9e1f0c7a5d4e2f8a6b0c1d&device_id=551659085216623&device_token=9f2c4e7a1b3d5f60718293a4

JSON body (with ?api_key= in the URL or the cookie):

{
    "device_id": 551659085216623,
    "device_token": "9f2c4e7a1b3d5f60718293a4"
}

Response

{
    "success": "success"
}

The change is logged in the notification history (e.g. Notifications disabled). See Notifications for details and error messages.