Knaq API v1

GET /1/equipment-realtime

Returns real-time information of an equipment collection.

Endpoint URL

https://api.knaq.io/1/equipment-realtime

Authentication

Authorization request header Bearer token

Query parameters

Name Type Description
building string Optional.
department string Optional.

Example responses 

{
  "equipment": [
    {
      "id":"00010001-0001-0001-0001-000100010001",
      "building": "123 Main Street",
      "equipment_name": "PE 1",
      "asset_id": "001",
      "equipment_type": "hydraulic",
      "motor_status": "landed",
      "last_motor_stop": 1679536316,
      "last_motor_start": 1679536299,
      "floor": "1",
      "door_status": "closed",
      "net_uptime": 0.98917,
      "utilization": 0.02553,
      "battery_voltage": 4.131,
      "wall_wart_voltage": 5.115,
      "availability": 0.98582
    }
  ]
}

Response fields

Name Type Description
id string Unique identifier of this equipment.
building string The building or equipment location.
equipment_name string The name or label assigned to this equipment.
asset_id string Unique identifier used within the organization.
equipment_type string The type or category of this equipment.

Supported values:
  • hydraulic
  • traction
  • escalator
  • moving_walkway
  • HVAC
  • compressor
motor_status string The current motor status.
last_motor_stop integer The Unix timestamp when the motor was last stopped.
last_motor_start integer The Unix timestamp when the motor was last started.
floor string The current floor or level at which the equipment is located.
door_status string The current status of the door.
net_uptime number Percentage of time in which the equipment was operational or under planned maintenance.
utilization number Internet connectivity percentage of the Knaq device.
battery_voltage number The voltage level of the Knaq device backup battery.
wall_wart_voltage number The voltage level supplied by the Knaq device power supply.
availability number Internet connectivity percentage of the Knaq device.
Jump to