Skip to main content
GET
/
api
/
kits
/
{kit_id}
/
telemetry
Get Telemetry
curl --request GET \
  --url https://argus.hoplynk.com/api/kits/{kit_id}/telemetry
{
  "online": true,
  "location": {},
  "wans": [
    {}
  ],
  "gateway": {},
  "battery": 123,
  "battery_charging": true,
  "clients": [
    {}
  ],
  "speedtest": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.hoplynk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
kit_id
string
required
UUID of the kit.
Use this endpoint when you need multiple fields at once. For single fields, use the dedicated endpoints (/location, /links) to keep responses small.

​
Response

​
online
boolean
Whether the kit is currently reachable.
​
location
object
GPS fix. Same schema as GET /location.
​
wans
array
WAN link objects. Same schema as GET /links.
​
gateway
object
UniFi gateway info: name, model, cpu_pct, mem_pct, uptime_s.
​
battery
number
Battery percentage (0–100). null if kit has no battery.
​
battery_charging
boolean
true if battery is currently charging. null if not reported.
​
clients
array
Devices connected to the kit’s network.
​
speedtest
object
Last speedtest result: download_mbps, upload_mbps, latency_ms.

​
Example

data = client.get_kit_telemetry(kit_id)
print(data["battery"], data["location"]["latitude"])

# Convenience wrappers for individual fields:
battery  = client.get_battery(kit_id)
gateway  = client.get_gateway(kit_id)
clients  = client.get_clients(kit_id)
speedtest = client.get_speedtest(kit_id)
Response
{
  "online": true,
  "location": {
    "latitude": 31.111125,
    "longitude": -93.273234,
    "source": "starlink",
    "stale": false
  },
  "battery": 85,
  "battery_charging": true,
  "gateway": {
    "name": "UniFi Dream Machine",
    "model": "UDM-Pro",
    "cpu_pct": 12,
    "mem_pct": 44
  },
  "wans": [],
  "clients": [],
  "speedtest": {}
}