Skip to content

Commit

Permalink
Update vicare.markdown adding an API limitation note (home-assistant#…
Browse files Browse the repository at this point in the history
…36176)

Co-authored-by: Franck Nijhof <[email protected]>
  • Loading branch information
kristian and frenck authored Dec 6, 2024
1 parent 249af07 commit 7108476
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions source/_integrations/vicare.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,18 @@ It may take up to an hour for your new client to become active and usable. Other

### API limits

The Viessmann API is rate-limited. If you exceed one of the limits below, you will be blocked for 24 hours:
The Viessmann API is rate-limited. In the "Basic" (free) tier of their API plans, if you exceed one of the limits below, you will be blocked for 24 hours:

- 120 calls for a time window of 10 minutes
- 1450 calls for a time window of 24 hours

The {% term integration %} polls the API every 60 seconds and will work within these limits. However, any additional requests to the API, for example, by setting the temperature via the integration but also by interacting with the ViCare app, count into those limits.
For the paid API plans this limit increases to 3000 calls in 24 hours. The {% term integration %} polls the API every 60 seconds and will work within these limits. However, any additional requests to the API, for example, by setting the temperature via the integration and interacting with the ViCare app, count into those limits.

{% important %}
For any Viessmann API plan except the most expensive "Advanced" tier, Viessmann imposes certain limits on which APIs are accessible for end-user consumption. Unfortunately, this also affects APIs useful for smart home integrations, like controlling thermostats (TRVs) and climate sensors, which are only available in the "Advanced" plan API tier. In case you set up the integration with a lower-tier plan, TRVs and other smart home entities will not become accessible in your Home Assistant installation.

Please consider providing feedback to Viessmann as described in [their FAQ](https://developer.viessmann.com/start/faq.html) "Where can I give feedback on the API?" in case you consider this as a limitation for your use-case.
{% endimportant %}

{% note %}
If you have multiple Viessmann devices in Home Assistant, the limit is shared between them, meaning the poll interval is increased, and the values are less frequently updated!
Expand Down

0 comments on commit 7108476

Please sign in to comment.