Skip to content

Battery monitor information

A battery monitor (batmon) reports voltage, current, power and state of charge. See API usage information for authentication and the response envelope.

Add battery monitor

POST/add/batmon

Creates a new battery monitor 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
batmon_name Name of the battery monitor str
batmon_type Free-text device type str
update_period Expected seconds between updates; used to decide Online/Offline int
batmon_token [Optional] Token used to authenticate updates. Generated when omitted str

Request example:

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

Form data:

batmon_name=Site A bank&batmon_type=48V LiFePO4&update_period=300

Response

{
    "success": {
        "batmon_id": 651659085216623,
        "batmon_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
    }
}

Field description

Field name Description Type
batmon_id Generated battery monitor id. Use it with the token to push updates int
batmon_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.

Battery monitor count

GET/batmon/count

Returns the number of battery monitors owned by the user.

Request

Auth: api_key (query param or cookie)

Request body:

None

Request example:

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

Response

{
    "success": {
        "batmons": 2
    }
}

List battery monitors

GET/batmon/list

Lists every battery monitor 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/batmon/list?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Response

{
    "success": [
        {
            "batmon_id": 651659085216623,
            "batmon_name": "Site A bank",
            "batmon_type": "48V LiFePO4",
            "batmon_status": "Online",
            "batmon_voltage": 52.4,
            "batmon_current": -12.3,
            "batmon_power": -644.5,
            "batmon_soc": 87.0,
            "batmon_details": "{}",
            "update_period": 300,
            "last_modified": 1763025300,
            "batmon_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2",
            "notification_enabled": true,
            "alarms": [],
            "whatsapp_enabled": false,
            "sms_enabled": false,
            "voltage_units": "V",
            "current_units": "A",
            "power_units": "W",
            "soc_units": "%",
            "notification_users": []
        }
    ]
}

Field description

Field name Description Type
batmon_id Battery monitor id int
batmon_name Device name str
batmon_type Device type str
batmon_status Online or Offline str
batmon_voltage Latest voltage float
batmon_current Latest current float
batmon_power Latest power float
batmon_soc Latest state of charge float
batmon_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
batmon_token Battery monitor 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
sms_enabled SMS notifications enabled (may be null) bool
voltage_units Display units str
current_units Display units str
power_units Display units str
soc_units Display units str
notification_users Extra notification recipients (see /edit) arr

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

Battery monitor status

GET/batmon/status

Returns the current status of a single battery monitor. 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
batmon_id Battery monitor id int
batmon_token Battery monitor token str

Request example:

Params:

https://spoilerinterface.com/interface/batmon/status?batmon_id=651659085216623&batmon_token=9f2c4e7a1b3d5f60718293a4

JSON body:

{
    "batmon_id": 651659085216623,
    "batmon_token": "9f2c4e7a1b3d5f60718293a4"
}

Response

{
    "success": {
        "batmon_id": 651659085216623,
        "batmon_name": "Site A bank",
        "batmon_type": "48V LiFePO4",
        "batmon_status": "Online",
        "batmon_voltage": 52.4,
        "batmon_current": -12.3,
        "batmon_power": -644.5,
        "batmon_soc": 87.0,
        "batmon_details": "{}",
        "last_modified": 1763025300,
        "update_period": 300,
        "notification_enabled": true,
        "whatsapp_enabled": false,
        "sms_enabled": false,
        "voltage_units": "V",
        "current_units": "A",
        "power_units": "W",
        "soc_units": "%",
        "alarms": [],
        "notification_users": null
    }
}

Field description

Field name Description Type
batmon_id Battery monitor id int
batmon_name Device name str
batmon_type Device type str
batmon_status Online or Offline str
batmon_voltage Latest voltage float
batmon_current Latest current float
batmon_power Latest power float
batmon_soc Latest state of charge float
batmon_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
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 battery monitor

POST/update/batmon
PUT/batmon

Pushes new battery readings. PUT /batmon is an alias of POST /update/batmon and takes the same fields.

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
batmon_id Battery monitor id int
batmon_token Battery monitor token str
batmon_voltage [Optional] Voltage. Default 0 float
batmon_current [Optional] Current. Default 0 float
batmon_power [Optional] Power. Default 0 float
batmon_soc [Optional] State of charge. Default 0 float
batmon_details [Optional] JSON object as a string. Default {} json
epoch_time [Optional] Measurement time (epoch seconds). Only used for the rate-limit check; the stored time is the server time int

Request example:

Params:

https://spoilerinterface.com/interface/update/batmon?batmon_id=651659085216623&batmon_token=9f2c4e7a1b3d5f60718293a4&batmon_voltage=52.4&batmon_current=-12.3&batmon_power=-644.5&batmon_soc=87

JSON body:

{
    "batmon_id": 651659085216623,
    "batmon_token": "9f2c4e7a1b3d5f60718293a4",
    "batmon_voltage": 52.4,
    "batmon_current": -12.3,
    "batmon_power": -644.5,
    "batmon_soc": 87.0,
    "batmon_details": "{\"cell_temp\": 24}"
}

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
    }
}

Battery monitor history

GET/batmon/history

Returns the recorded history of the user's battery monitors, 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 battery monitor (must belong to the user, otherwise Invalid device_id). Default: all of the user's battery monitors 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/batmon/history?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

JSON body:

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

Response

{
    "success": [
        {
            "batmon_id": 651659085216623,
            "batmon_name": "Site A bank",
            "batmon_type": "TODO",
            "min_time": 1700000000,
            "max_time": 1763025300,
            "data": [
                {
                    "batmon_voltage": 52.4,
                    "batmon_current": -12.3,
                    "batmon_power": -644.5,
                    "batmon_soc": 87.0,
                    "batmon_details": "{}",
                    "update_time": "2026-11-13T09:15:00"
                }
            ]
        }
    ]
}

Field description

Field name Description Type
batmon_id Battery monitor id int
batmon_name Device name str
batmon_type Device type 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
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
batmon_voltage Recorded voltage float
batmon_current Recorded current float
batmon_power Recorded power float
batmon_soc Recorded state of charge float
batmon_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

batmon_type is currently always the placeholder string TODO in history responses.

Edit battery monitor

POST/edit/batmon

Changes the name, token, update period, display units or notification recipients of a battery monitor 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
batmon_id Battery monitor id (must belong to the user) int
batmon_name [Optional] New name str
batmon_token [Optional] New token. Devices must use the new token afterwards str
update_period [Optional] New update period (seconds) int
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/batmon?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

JSON body:

{
    "batmon_id": 651659085216623,
    "batmon_name": "Site A bank",
    "update_period": 300,
    "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 battery monitor

POST/delete/batmon

Deletes a battery monitor 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
batmon_id Battery monitor id int
batmon_token Battery monitor token str

Request example:

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

Form data:

batmon_id=651659085216623&batmon_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 battery monitor. 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 batmon. 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 Battery monitor id int
device_token Battery monitor token str

URLs for this device type:

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

Request example:

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

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

{
    "device_id": 651659085216623,
    "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.