System state

GET

/state

const url = 'https://demo.evcc.io/api/state?jq=.';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://demo.evcc.io/api/state?jq=.'

Returns the complete state of the system. This structure is used by the UI. It can be filtered by JQ to only return a subset of the data.

More information

Parameters

Query Parameters

string

Filter the state with JQ

Examples

complete state

only first loadpoint

.loadpoints[0]

Responses

200

Success

application/json

object

result

The actual state structure is not documented yet. Most values should be self-explanatory. Note: While the overall structure is quite stable, details may change between releases.