Xovis Api Documentation May 2026

Include your API key in the header of every request:

X-API-Key: your_api_key_here
Content-Type: application/json

Xovis does not host its documentation on a public GitHub repository due to the proprietary nature of the software. To access the official, version-controlled documentation, you must:

Version Alert: Xovis frequently updates their sensor firmware. An API call that works on XCS v2.3 may fail on v3.0. Always verify the compatibility matrix in the documentation's introduction. xovis api documentation


  • Server-Sent Events (SSE): GET https://host/api/v1/stream/events

  • Before diving into the code, it is essential to understand the flow of data. Xovis sensors (like the PC2 or PC3 series) operate independently or through the Xovis Counting Service (XCS) – the central software that aggregates data from multiple sensors.

    The Xovis API is a RESTful web API that allows external applications to communicate with the XCS. It returns data in standard JSON format, making it universally compatible with cloud services, on-premise databases, and modern web frameworks. Include your API key in the header of

    The Xovis API documentation explicitly states that all timestamps are UTC. If your application runs in EST or PST, you must convert. Ignoring this leads to historical reports that look "shifted by 5 hours."

    Solution: Always parse the timestamp field with a UTC parser before converting to local time. Xovis does not host its documentation on a

    Xovis documentation takes security seriously but makes it cumbersome.

    | Feature | Xovis API Docs | Brickstream (now Sensormatic) | Traf-Sys | |---------|----------------|-------------------------------|-----------| | REST API | ✅ Detailed | ✅ Good | ❌ Limited | | Real-time streaming | ✅ (Socket/MQTT) | ❌ No | ✅ (WebSocket) | | Sandbox environment | ❌ No | ✅ Yes | ❌ No | | Rate limits documented | ❌ No | ✅ Yes | ❌ No |

    Xovis wins on data richness (trajectories, zone occupancy) but loses on developer experience due to missing sandbox and unclear limits.