REST API¶

The simulator exposes a programmatic REST + WebSocket interface alongside the web dashboard. The dashboard itself is just the UI on top of this API — anything you can do from the dashboard you can do from a script.

Where to find the full interface¶

The simulator ships interactive API browsers built from the live OpenAPI spec — they always match what the running build supports, no out-of-date PDF to chase:

Replace <host> with whatever the simulator was bound to (--website_ip / -wi, defaults to 127.0.0.1) and the port with whatever --website_port / -wp was set to (defaults to 8111).

All simulator-control endpoints live under the /api/dersim prefix. The two interactive doc URLs (/docs, /redoc) are at the root by convention.

What you can drive from the API¶

The endpoint set is broken up by concern:

Simulator lifecycle¶

Telemetry + history¶

Inverter / DER controls¶

Device-specific endpoints¶

Communication-layer endpoints¶

Driving the simulator from a script¶

Every endpoint is documented in the live Swagger UI with request / response schemas and a "Try it out" button that fills in the right JSON shape. For a scripted run, hitting the JSON endpoints directly with curl is enough:

# Snapshot the live state
curl http://localhost:8111/api/dersim/overview | jq .

# Override the wind speed to 12 m/s (Wind-T4-3Phase devices)
curl -X POST http://localhost:8111/api/dersim/wind/override \
     -H 'Content-Type: application/json' \
     -d '{"wind_speed_m_s": 12.0}'

# Switch a Hybrid-DC plant from self-consumption to PV priority
curl -X POST http://localhost:8111/api/dersim/hybrid-dc/dispatch \
     -H 'Content-Type: application/json' \
     -d '{"policy": "pv_priority"}'

# Tail the OCPP module logs
curl 'http://localhost:8111/api/dersim/logs?modules=OCPP&limit=200'

For long-running test harnesses, generate a typed client from the OpenAPI JSON — every endpoint is fully schema'd, so a generated client gets compile-time guarantees on request / response shapes.

Authentication¶

The dashboard API is unauthenticated by design — it's a lab tool, not a production interface. Bind it to 127.0.0.1 (the default) when you don't want an external listener. The CSIP management UI on --csip_website_port follows the same convention.

Versioning¶

The API version is exposed in the OpenAPI spec (info.version) and on /api/dersim/server-info. Backwards-incompatible changes bump the major; additive endpoints bump the minor.