Developer Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

RealTime API


The RealTime API is served over a secure WebSocket connection. Unlike the REST API, which accepts one request and sends one response per TCP connection, the RealTime API works over a single TCP connection that remains open until you disconnect it, or it is inadvertently interrupted. For more information about WebSockets, check out the Wikipedia article, and the MDN article.

How Does the RealTime API Work?

The RealTimeAPI is essentially a collection of different data streams that you can selectively turn on and off once you have connected and authenticated. Each data stream will contain messages in JSON format and will be pushed to you in real time when certain events occur. Of course, you will receive messages of a certain type only if you

  • have sufficient permissions to enable the data stream, and
  • send the command to actually enable the data stream for that message type over the connection.