# REST API

The Home Assistant API: status per charge point, start, stop and switching between 1- and 3-phase charging, over HTTPS through the EdgeTech platform, with a subscription. Example Home Assistant configuration included. A wider third-party API with its own tokens is coming soon.

Canonical: https://edgetech.eu/docs/rest-api  
Updated: 2026-10-20

## Home Assistant API

In use today by Home Assistant installations. It runs through the EdgeTech platform, so it needs a subscription; without one, see [local control](#local-instead).

The address is `https://<server>/ev/api/v1/<user-id>/<site-id>`, followed by an action. The MyCharger app gives the server, your user ID and your site ID, and a ready-made Home Assistant configuration: **MyCharger > Settings > Expert > REST API**.

| Action | Call | What it does |
|---|---|---|
| Status, all charge points | `?action=status` | Status of every charge point on the site |
| Status, one charge point | `?action=status&socket=<socket-id>` | Status of one charge point |
| Start | `?action=start&socket=<socket-id>` | Allow charging on that charge point |
| Stop | `?action=stop&socket=<socket-id>` | Stop and block charging on that charge point |
| 1-phase | `?action=phase&phases=1` | Charge on one phase, for the whole site |
| 3-phase | `?action=phase&phases=3` | Charge on three phases, for the whole site |

GET and POST both work. At most 10 calls per minute per address; poll the status every 30 seconds or slower.

### Answer

```json
{"response": {"success": true, "API-version": "1.0", "message": "...",
  "data": {"site": "<site-id>", "sockets": [{"id": "<socket-id>", "name": "Driveway",
    "properties": {"cable_connected": "1", "cable_max_current": "32", "car_connected": "1", "charging": "1",
      "current_1": "15.9", "current_2": "16.0", "current_3": "15.8", "charger_board_temperature": "31",
      "session_kwh": "7.4", "last_session_kwh": "21.3", "allow_charging": "true"}}]}}}
```

| Property | Meaning |
|---|---|
| `cable_connected`, `car_connected`, `charging` | 1 or 0 |
| `cable_max_current` | What the cable allows, A |
| `current_1`, `current_2`, `current_3` | Charging current per phase, A |
| `charger_board_temperature` | Temperature of the charge controller, °C |
| `session_kwh`, `last_session_kwh` | Energy of the current and the previous session, kWh |
| `allow_charging` | Whether charging is allowed (start / stop) |

A value the charger has not reported yet is `unknown`. When something is wrong, `success` is `false` and `message` says why.

### Example for Home Assistant

```yaml
rest:
  - resource: "https://<server>/ev/api/v1/<user-id>/<site-id>?action=status&socket=<socket-id>"
    scan_interval: 30
    sensor:
      - name: "Charger current L1"
        unit_of_measurement: "A"
        device_class: current
        value_template: "{{ value_json.response.data.sockets[0].properties.current_1 }}"
      - name: "Charger session energy"
        unit_of_measurement: "kWh"
        device_class: energy
        value_template: "{{ value_json.response.data.sockets[0].properties.session_kwh }}"
    binary_sensor:
      - name: "Car connected"
        value_template: "{{ value_json.response.data.sockets[0].properties.car_connected == '1' }}"

rest_command:
  charger_start:
    url: "https://<server>/ev/api/v1/<user-id>/<site-id>?action=start&socket=<socket-id>"
    method: post
  charger_stop:
    url: "https://<server>/ev/api/v1/<user-id>/<site-id>?action=stop&socket=<socket-id>"
    method: post
```

The configuration from the app also contains a dashboard.

### Keep your user ID private

The user ID in the address gives control over your chargers, the same as your app. Do not share it or put it in screenshots. If it has been shared, ask [support](mailto:support@edgetech.eu) for a new one.

## Wider API

Coming soon: a third-party API with its own token per site, read-only or read-write, and an OpenAPI file.

| Area | Calls |
|---|---|
| Sites and sockets | list sites, site info, site status, sockets, socket status, socket and site configuration |
| Control | allow or disallow charging, start now, delayed start, schedule items, plug and charge, socket priority, phases per socket |
| Limits | max site current, grid connection type |
| Solar | solar mode, charge from solar only, extended trigger and condition |
| Insight | usage report per period, energy price setting, force status refresh |
| Support | diagnostics ticket, log upload, firmware check and upgrade |

## Local instead

No cloud, no subscription: drive the charge controller directly over Modbus RTU ([register map](/docs/modbus-registers)), with evcc or Home Assistant's Modbus integration. One master per bus.
