Build on your Teqlogy devices

Read live data, switch relays, set meter quotas, schedule resets and listen to every change — from your own scripts, dashboards and systems. A plain REST API with JSON, a WebSocket for live events, and personal API keys with clear access levels.

Choose your device

Each device has its own page with every endpoint, field, command and event that applies to it.

Quick start

export KEY=tk_live_…

curl "https://teqhome.teqlogy.com/api/devices/me" \
  -H "Authorization: Bearer $KEY"

{
  "ok": true,
  "devices": [
    {
      "deviceId": "aabbcc112233",
      "name": "Living Room",
      "type": "PowerMatrix-8",
      "status": true,
      "relays": [1, 0, 1, 0, 0, 0, 0, 0]
    },
    "…"
  ]
}

Authentication

Every request carries your personal API key in the Authorization header. There is nothing else to sign.

Authorization: Bearer tk_live_<your key>
Content-Type: application/json

Get an API key

What a key can do

Keys come in two types, and some things are never available to a key at all. The rules are enforced by the server on every request, on the REST API and on the WebSocket alike — a read-only key cannot change anything, however it asks.

Every endpoint at a glance

Conventions

• Requests and answers are JSON. Send Content-Type: application/json with a body.
• Every answer has ok: true or false.
• Dates are ISO 8601 in UTC, for example 2026-10-03T14:20:00.000Z.
• Energy in kWh unless the name says Wh; voltage in V, current in A, power in W, frequency in Hz.

Numbering: where counting starts

Rate limits

Errors

Errors use the HTTP status first, and most carry a stable code you can switch on. The message is for humans and may change.

{
  "ok": false,
  "code": "API_KEY_READONLY",
  "message": "This API key is read-only: it can read data but cannot change anything.",
  "requestId": "req_a1b2c3d4e5f6g7h8"
}

Real time (WebSocket)

A WebSocket pushes every change as it happens, so you do not have to poll. Open it with a one-time ticket from POST /api/ws-ticket. Each device page lists the commands and events of that device.

// 1. exchange the key for a one-time ticket (valid 30 s, works once)
const { ticket } = await fetch('https://teqhome.teqlogy.com/api/ws-ticket', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + process.env.TEQLOGY_KEY },
}).then((r) => r.json())

// 2. open the socket with it
const ws = new WebSocket('wss://teqhome.teqlogy.com/ws/app?ticket=' + ticket)
ws.onmessage = ({ data }) => console.log(JSON.parse(data))
ws.onclose = () => { /* get a NEW ticket, then connect again */ }

// 3. keep it alive and (full key only) send commands
setInterval(() => ws.send(JSON.stringify({ type: 'ping' })), 25000)
ws.send(JSON.stringify({ type: 'toggleRelay', deviceId: 'aabbcc112233', relay: 0, state: true }))

• You receive the events of every device you own and of every device shared with you, as soon as they happen.
• A socket opened with a read-only key only listens. Every command it sends is answered with an error frame (API_KEY_READONLY) and nothing reaches a device.
• A socket opened with a full key may send the commands below. Anything else — factoryReset, deleteDevice, an unknown type — is refused with API_KEY_NOT_ALLOWED: those need a login.
• At most 30 messages per 10 seconds per connection; extra messages are ignored. The server does not ping app connections and proxies close idle ones, so send { "type": "ping" } every 25–30 seconds.
• A command is addressed with deviceId and goes to the device only if it is yours or shared with you with control access. There is no answer to a command that worked: watch for telemetryUpdate.

A refused command

The socket stays open and tells you why:

{
  "type": "error",
  "code": "API_KEY_READONLY",
  "message": "This API key is read-only: it can read data but cannot change anything.",
  "command": "toggleRelay"
}

Address: wss://teqhome.teqlogy.com/ws/app?ticket=…

Using keys safely

• Use a read-only key for dashboards, reports and monitoring. Give a full key only to the integration that really has to switch things.
• Keep keys on a server. A key in a web page or a phone app can be read by anybody who opens it. (Browsers on other websites are also stopped by CORS.)
• One key per integration, named after it. Revoke a key the moment it is lost, leaked or no longer used — it stops working at once.
• Always use HTTPS / WSS. Never put a key in a URL or in a log; send it in the Authorization header only.
• Your key acts as you: it only sees and changes your own devices and the devices shared with you, and never more than your share allows.