Skip to content

GPS information

A GPS device reports latitude, longitude and height. See API usage information for authentication and the response envelope.

Add GPS device

POST/add/gps

Creates a new GPS device 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
gps_name Name of the GPS device str
gps_type Free-text device type str
coordinate_system Coordinate system label, e.g. WGS84 str
update_period Expected seconds between updates; used to decide Online/Offline int
gps_latitude [Optional] Initial latitude. Default 0 float
gps_longitude [Optional] Initial longitude. Default 0 float
gps_height [Optional] Initial height. Default 0 float
gps_token [Optional] Token used to authenticate updates. Generated when omitted str
gps_details [Optional] JSON string stored with the device. Default {} json
last_modified [Optional] Initial last-update time (epoch seconds). Default: now int

Request example:

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

Form data:

gps_name=Truck 7&gps_type=Tracker&coordinate_system=WGS84&update_period=60

Response

{
    "success": {
        "gps_id": 451659085216623,
        "gps_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
    }
}

Field description

Field name Description Type
gps_id Generated GPS device id. Use it with the token to push updates int
gps_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.

GPS count

GET/gps/count

Returns the number of GPS devices owned by the user.

Request

Auth: api_key (query param or cookie)

Request body:

None

Request example:

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

Response

{
    "success": {
        "gps": 2
    }
}

List GPS devices

GET/gps/list

Lists every GPS device 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/gps/list?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

Response

{
    "success": [
        {
            "gps_id": 451659085216623,
            "gps_type": "Tracker",
            "gps_name": "Truck 7",
            "gps_status": "Online",
            "gps_latitude": -25.7479,
            "gps_longitude": 28.2293,
            "gps_height": 1339.0,
            "coordinate_system": "WGS84",
            "gps_token": "9f2c4e7a1b3d5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2",
            "update_time": 1763025300,
            "last_modified": 1763025300,
            "update_period": 60,
            "notification_enabled": true,
            "alarms": [],
            "whatsapp_enabled": false,
            "sms_enabled": false,
            "gps_details": "{}",
            "longitude_units": "deg",
            "latitude_units": "deg",
            "height_units": "m",
            "notification_users": []
        }
    ]
}

Field description

Field name Description Type
gps_id GPS id int
gps_type Device type str
gps_name Device name str
gps_status Online or Offline str
gps_latitude Latest latitude float
gps_longitude Latest longitude float
gps_height Latest height float
coordinate_system Coordinate system given when the device was added str
gps_token GPS token str
update_time Same value as last_modified int
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
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
gps_details Details JSON as stored json
longitude_units Display units for longitude str
latitude_units Display units for latitude str
height_units Display units for height str
notification_users Extra notification recipients (see /edit) arr

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

GPS status

GET/gps/status

Returns the current status of a single GPS device. 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
gps_id GPS id int
gps_token GPS token str

Request example:

Params:

https://spoilerinterface.com/interface/gps/status?gps_id=451659085216623&gps_token=9f2c4e7a1b3d5f60718293a4

JSON body:

{
    "gps_id": 451659085216623,
    "gps_token": "9f2c4e7a1b3d5f60718293a4"
}

Response

{
    "success": {
        "gps_id": 451659085216623,
        "gps_name": "Truck 7",
        "gps_type": "Tracker",
        "gps_status": "Online",
        "gps_latitude": -25.7479,
        "gps_longitude": 28.2293,
        "gps_height": 1339.0,
        "gps_details": "{}",
        "last_modified": 1763025300,
        "update_period": 60,
        "notification_enabled": true,
        "whatsapp_enabled": false,
        "sms_enabled": false,
        "longitude_units": "deg",
        "latitude_units": "deg",
        "height_units": "m",
        "alarms": [],
        "notification_users": null
    }
}

Field description

Field name Description Type
gps_id GPS id int
gps_name Device name str
gps_type Device type str
gps_status Online or Offline str
gps_latitude Latest latitude float
gps_longitude Latest longitude float
gps_height Latest height float
gps_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
longitude_units Display units for longitude str
latitude_units Display units for latitude str
height_units Display units for height str
alarms Alarms configured for the device arr
notification_users Extra notification recipients (see /edit) arr

Update GPS device

POST/update/gps

Pushes a new position.

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
gps_id GPS id int
gps_token GPS token str
gps_latitude Latitude float
gps_longitude Longitude float
gps_height Height float
gps_details [Optional] JSON object as a string. Default {}. Send it as a query parameter: the JSON-body field is typed as an integer, so a JSON string there is rejected with a validation error 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/gps?gps_id=451659085216623&gps_token=9f2c4e7a1b3d5f60718293a4&gps_latitude=-25.7479&gps_longitude=28.2293&gps_height=1339

JSON body:

{
    "gps_id": 451659085216623,
    "gps_token": "9f2c4e7a1b3d5f60718293a4",
    "gps_latitude": -25.7479,
    "gps_longitude": 28.2293,
    "gps_height": 1339.0,
    "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
    }
}

GPS history

GET/gps/history

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

JSON body:

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

Response

{
    "success": [
        {
            "gps_id": 451659085216623,
            "gps_name": "Truck 7",
            "gps_type": "Tracker",
            "coordinate_system": "WGS84",
            "min_time": 1700000000,
            "max_time": 1763025300,
            "data": [
                {
                    "gps_status": "Online",
                    "gps_latitude": -25.7479,
                    "gps_longitude": 28.2293,
                    "gps_height": 1339.0,
                    "gps_details": "{}",
                    "last_modified": "2026-11-13T09:15:00"
                }
            ]
        }
    ]
}

Field description

Field name Description Type
gps_id GPS id int
gps_name Device name str
gps_type Device type str
coordinate_system Coordinate system given when the device was added 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
gps_status Status stored with the record str
gps_latitude Latest latitude float
gps_longitude Latest longitude float
gps_height Latest height float
gps_details Details JSON as stored json
last_modified Record time as an ISO date-time string, shifted by the account's time_offset str

Edit GPS device

POST/edit/gps

Changes the name, token, update period, display units or notification recipients of a GPS device 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
gps_id GPS id (must belong to the user) int
gps_name [Optional] New name str
gps_token [Optional] New token. Devices must use the new token afterwards str
update_period [Optional] New update period (seconds) int
longitude_units [Optional] Display units. Reset to an empty string when omitted str
latitude_units [Optional] Display units. Reset to an empty string when omitted str
height_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/gps?api_key=3b9e1f0c7a5d4e2f8a6b0c1d

JSON body:

{
    "gps_id": 451659085216623,
    "gps_name": "Truck 7",
    "longitude_units": "deg",
    "latitude_units": "deg",
    "height_units": "m"
}

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 GPS device

POST/delete/gps

Deletes a GPS device 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
gps_id GPS id int
gps_token GPS token str

Request example:

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

Form data:

gps_id=451659085216623&gps_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 GPS device. 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 gps. 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 GPS id int
device_token GPS token str

URLs for this device type:

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

Request example:

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

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

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