API and Streaming (Home)


Use the SignalR stream to receive observations from your chargers, and the REST API to send commands.

Overview

For most home integrations the best approach is to use both the API and the SignalR Streaming service together:

I want to...Use
Know what my charger is doing, for example when a car is plugged in, when it starts charging, or the current charge rateSignalR Streaming API
Make something happen, for example start or stop charging, or change the currentREST API

The stream is for receiving data only. Commands should always be sent through the REST API.

Why stream instead of polling?

  • You get every observation as it happens. Once subscribed, each change from your charger is pushed to you straight away, such as the car being plugged in, charging starting or stopping, or the charge rate changing.
  • You avoid hitting rate limits. Repeatedly calling the API to check for changes uses up your allowance. With the stream you make one connection and receive updates as they occur, leaving your API calls free for commands.

Did this page help you?