Skip to main content

Viewtron IP Camera API

Build applications with AI security cameras — human detection, license plate recognition, face detection, PTZ control, and real-time webhooks. No cloud service required.

Get StartedBrowse Applications

What these docs cover

Viewtron IP cameras and NVRs expose an HTTP API. Requests use HTTP POST with XML payloads and HTTP Basic Authentication. Human, vehicle, face, and license plate detection run on the device. Those devices can also POST webhook events, including a snapshot, to an HTTP server you run.

The site is organized into four sections:

  • Getting Started covers authentication, the request and response format, API versions, error codes, and HTTP POST webhook setup. Install the Python SDK (pip install viewtron) or the Node.js SDK (npm install viewtron-sdk).
  • API Reference documents each endpoint: system, image and video, PTZ, alarm, webhook events, smart detection, playback, network, and security.
  • Applications are solution guides with Python and Node.js examples for human detection, license plate recognition, face detection, PTZ control, people counting, line crossing, relays, object tracking, and recording search.
  • Integrations cover Home Assistant (MQTT) and Node-RED (HTTP POST). Method-level pages are in the Python and Node.js SDK references. The Python SDK also sends camera commands. The Node.js SDK receives events.

Supported products lists which cameras and NVRs implement which calls. The longer overview, with a short request example, is on the documentation home.

AI Detection Webhooks

Receive real-time HTTP POST events when cameras detect humans, vehicles, faces, or license plates. Parse XML payloads with bounding boxes, target classification, and snapshot images.

Complete Camera Control

Configure image settings, PTZ movement, preset tours, video streams, alarm outputs, and detection zones — all through a standard HTTP API with XML payloads.

Open & NDAA Compliant

All AI runs on the camera. No cloud dependency, no per-device licensing, no monthly fees. All Viewtron products are NDAA compliant for US government use. Python server on GitHub.

Applications

Solution guides for common integration scenarios

Human Detection

Intrusion zones, person/vehicle filtering, real-time alerts

License Plate Recognition

LPR/ALPR camera API, plate database, gate access

Face Detection

Face detection and recognition, visitor management

PTZ Camera Control

Pan, tilt, zoom, presets, cruise tours, auto-tracking

Real-Time Tracking

Continuous object position data via traject streaming

Webhook Events

HTTP POST notification setup and event format reference

Integrations & SDK

Connect Viewtron cameras to smart home platforms or build custom applications

Home Assistant

LPR, person detection, and face detection as native HA sensors via MQTT auto-discovery. No Frigate or Coral TPU needed.

Node-RED

npm install node-red-contrib-viewtron — receive plate reads with images and access control groups direct to your flow. No middleware.

Python SDK

pip install viewtron — ViewtronServer with built-in HTTP server, event parsing, and camera control. Handles all XML and version differences.