Returns all current metric values. Filter by topic glob or retrieve a single value as plain text.

Query parameters

Request

curl -u admin:<password> http://192.168.0.100/api/v1/metrics

Response

[
  {"topic": "total/pv_power", "group": "Status", "name": "PV power", "value": 1240, "unit": "W"},
  {"topic": "total/load_power", "group": "Status", "name": "Load power", "value": 940, "unit": "W"},
  {"topic": "total/battery_state_of_charge", "group": "Status", "name": "Battery state of charge", "value": 80, "unit": "%"}
]

Returns one metric's recorded values, grouped into time buckets. A response holds up to 2000 buckets; when the range needs more, it includes a next time to pass as from for the following page. Battery metrics are not recorded in history.

Query parameters

Request

curl -u admin:<password> "http://192.168.0.100/api/v1/history?topic=total/pv_power&from=2026-09-16T12:00:00Z&to=2026-09-16T13:00:00Z&group_by=1m&agg=max"

Response

{
  "topic": "total/pv_power",
  "device": "totals",
  "group": "Status",
  "name": "PV power",
  "unit": "W",
  "agg": "max",
  "group_by": "1m",
  "from": "2026-09-16T12:00:00Z",
  "to": "2026-09-16T13:00:00Z",
  "points": [
    ["2026-09-16T12:00:00Z", 1240],
    ["2026-09-16T12:01:00Z", 1302]
  ]
}

Times are in UTC and buckets with no data are left out. An invalid parameter returns 400 and a topic that is unknown or not recorded returns 404, each with an error message in the body.

Returns one weather metric's forecast values, the counterpart of /api/v1/history for future times. It requires SolarAssistant Pro and the PV forecast to be enabled. Points are at the source's resolution of 15 minutes, and a response holds the whole range, so there is no paging.

The forecast topics are weather/pv_power_predicted (W), weather/outside_temperature (in the site's °C or °F setting), weather/weather_code (WMO code), weather/is_day, weather/cloud_cover (%), weather/wind_speed (km/h) and weather/global_tilted_irradiance (W/m²). For the PV power actually generated, use /api/v1/history with topic total/pv_power.

Query parameters

Request

curl -u admin:<password> "http://192.168.0.100/api/v1/forecast?topic=weather/pv_power_predicted"

Response

{
  "topic": "weather/pv_power_predicted",
  "device": "weather",
  "group": "Status",
  "name": "PV power predicted",
  "unit": "W",
  "last_updated": "2026-07-02T06:00:00Z",
  "from": "2026-07-02T08:00:00Z",
  "to": "2026-07-02T08:15:00Z",
  "points": [
    ["2026-07-02T08:00:00Z", 500.4],
    ["2026-07-02T08:15:00Z", 750.0]
  ]
}

last_updated is when the forecast was last fetched. Times are in UTC. An invalid parameter returns 400. A topic that is unknown, has no forecast, is not enabled for forecast, or has no forecast fetched yet since the device started returns 404, each with an error message in the body.

Returns the configured grid provider, with its day-ahead prices under pricing. Prices have the price multiplier and offset set on the device already applied. Slots follow the provider's resolution, which is 15 minutes, 30 minutes or an hour depending on the provider. When the provider publishes no prices, pricing is null, and before the first prices are fetched slots is an empty list.

Request

curl -u admin:<password> http://192.168.0.100/api/v1/grid

Response

{
  "provider": "Europe - EPEX",
  "schedule_type": "pricing",
  "pricing": {
    "currency": "EUR",
    "unit": "€/kWh",
    "slots": [
      {"from": "2026-07-02T10:00:00Z", "to": "2026-07-02T11:00:00Z", "price": 0.12, "rank": 3, "premium": -0.02}
    ]
  }
}

Providers with separate import and export tariffs, such as Octopus, report a schedule_type of import_export_pricing. Each slot then carries import_price, import_rank, import_premium, export_price, export_rank and export_premium instead.

Sends a new value to the inverter. On failure a 422 is returned with an error message. Use the topic field from a GET response to know what topics are writable.

Body parameters

Request

curl -u admin:<password> -X POST http://192.168.0.100/api/v1/metrics \
  -H "Content-Type: application/json" \
  -d '{"topic": "inverter_1/output_source_priority", "value": "Utility first"}'

Response

{"topic": "inverter_1/output_source_priority", "result": "ok"}

Streams live metrics as they update using the SolarAssistant WebSocket API. Pass your password or token as a query parameter when connecting.

Query parameters

Request

ws://192.168.0.100/api/websocket?password=<password>

After connecting, join the metrics channel. See the WebSocket API docs for channel events and topic format.