Coming Soon — SiteCAD Sim

API Reference

Connect sensors, actuators, and external systems

External APIs, SQL access, and control webhooks ship with SiteCAD Sim — a non-interactive SiteCAD that keeps one scenario running, where sensors, controllers, and an agent team can work alongside it. Sim is a separate product line with its own per-instance pricing, distinct from the editor subscription.

Primary Use Cases

Sensor Data Ingestion

Push readings from soil moisture sensors, temperature probes, flow meters, tank level sensors, and other IoT devices into your dynamics database.

Control Webhooks

Receive callbacks when control parameters change — open valves, adjust pump speeds, trigger irrigation zones, or activate equipment.

SQL Access

Query scenario and dynamics databases directly via SQL. List sites, find entities, aggregate sensor data — if the schema supports it, you can query it.

Planned Endpoints

POST /api/dynamics/:id/events

Push sensor readings and state changes

POST /api/dynamics/:id/batch

Bulk insert historical or buffered readings

POST /api/sql

Execute SQL queries against scenario or dynamics databases

WS /api/dynamics/:id/subscribe

Real-time stream of dynamics events

HOOK your-server/webhook

Receive control commands when parameters change

GET /api/export/:format

Export data as CSV, GeoJSON, glTF, etc.

API Capabilities

API Keys

Scoped keys for sensors, controllers, and integrations

SQL Interface

Full read/write access to databases with documented schemas

Webhooks

Push notifications for control changes and events

Export Formats

Programmatic access to CSV, GeoJSON, glTF, and more

Time-Series

Efficient storage and querying of sensor history

Real-Time Sync

WebSocket streams for live dashboards and monitoring

Get Early Access

The API ships with SiteCAD Sim on its own per-instance pricing. Be among the first to try it — we'll notify you when early access opens.

Coming soon — API access requests are not yet available

Already Building?

While SiteCAD Sim is in development, you can already drive scenarios programmatically from the browser DevTools SQL interface — full read/write access to the active scenario and dynamics databases, including CSV and GeoJSON codecs.

// In browser DevTools console
await runSQL('select * from Entity where type = \'s\'');

Explore the Editor

See how SiteCAD works firsthand — the API will provide programmatic access to everything you can do in the editor.