WEGnology REST API

WEGnology is powered by a full REST API that provides access to nearly every feature. The WEGnology front-end web application itself is built on top of this API, and so almost all the data and functionality in the front end is available through the API itself. In fact, the front-end uses the open-source wegnology-rest-js JavaScript client to communicate with the WEGnology API. If JavaScript is not your language of choice, no need to worry! We have easy to use libraries for a number of different languages:

  • JavaScript with wegnology-rest-js
    Available in Node Package Manager: npm install wegnology-rest

  • Python with wegnology-rest-python
    Available in the Python Package Index: pip install wegnology-rest

    • Application MQTT Publish Message is limited to 30 calls in a 15-second window (per device) - on average, 2 calls per second. This matches the limiting that occurs when sending messages over MQTT.
    • Dashboard Send Report is limited to one call every five minutes per application.
    • Data Bulk Export by Query is limited to one call every hour per application.
    • Data Table Data Export is limited to one call every five minutes per data table.
    • Device Data Export is limited to one call every five minutes per device.
    • Device Send State is limited to 30 calls in a 15-second window (per device) - on average, 2 calls per second. This matches the limiting that occurs when sending messages over MQTT.
    • Device Send Command uses the same throttle as applied to Device Send State above, which is limited to 30 calls in a 15-second window (per device) - on average, 2 calls per second.
    • Device Set Connection Status uses the same throttle as applied to Device Send State above, which is limited to 30 calls in a 15-second window (per device) - on average, 2 calls per second.
    • Devices Export is limited to one call every five minutes per application.
    • Event Create is limited to 15 calls in a 15-second window (per application) - on average, 1 creation per second. This matches the limiting that occurs when creating events through a workflow.
    • Event Export is limited to 1 call per 5 minutes per application.
    • Notebook Input Data Export is limited to 1 call per 15 minutes per notebook.
    • Workflow Press Virtual Button is limited to 100 calls in a 10-second window (or, on average, 10 per second) per virtual button.