Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Stream live GPS and link telemetry for a kit over WebSocket.
WSS https://argus.hoplynk.com/api/kits/{kit_id}/ws
| Parameter | Type | Default | Description |
|---|---|---|---|
feeds | string | gps | Comma-separated feeds to subscribe to. Options: gps, starlink |
interval | float | 1.0 | Push interval in seconds. Range: 0.5–10.0 |
ready before streaming data.
Client → Server: { "type": "auth", "key": "hlk_..." }
Server → Client: { "type": "ready", "feeds": ["gps", "starlink"] }
Server → Client: { "type": "data", "feed": "gps", "payload": {...}, "ts": "..." }
{
"type": "data",
"feed": "gps",
"payload": {
"latitude": 31.111125,
"longitude": -93.273234,
"altitude": 550.2,
"source": "starlink",
"stale": false
},
"ts": "2026-05-18T14:27:01.123Z"
}
{ "type": "error", "message": "Invalid credentials" }
{ "type": "close", "code": 4001 }
stream.close().
| Feed | Payload fields |
|---|---|
gps | latitude, longitude, altitude, source, stale, kit_location |
starlink | latency_ms, download_mbps, upload_mbps, signal_quality, obstruction_pct |
with client.kit_stream(kit_id, feeds=["gps", "starlink"]) as stream:
for event in stream:
feed = event["feed"]
p = event["payload"]
if feed == "gps":
print(f"GPS: {p['latitude']}, {p['longitude']} ({p.get('kit_location')})")
elif feed == "starlink":
print(f"Starlink: {p['latency_ms']}ms ↓{p['download_mbps']} Mbps")
const stream = client.stream({ kitId, feeds: ['gps', 'starlink'] })
stream.on('ready', ({ feeds }) => console.log('streaming', feeds))
stream.on('data', ({ feed, payload, ts }) => {
if (feed === 'gps') {
console.log(payload.latitude, payload.longitude)
}
})
// Clean up
stream.close()
const ws = new WebSocket('wss://argus.hoplynk.com/api/kits/YOUR_KIT_ID/ws?feeds=gps,starlink&interval=1')
ws.onopen = () => ws.send(JSON.stringify({ type: 'auth', key: 'hlk_...' }))
ws.onmessage = ({ data }) => {
const msg = JSON.parse(data)
if (msg.type === 'data') console.log(msg.feed, msg.payload)
}