/* Used to create bullet points on CMS lists by adding matching class to each item */
The Push API allows users to send solar data into Charge HQ. It is intended for users with unsupported solar & battery systems who wish to develop their own data import mechanisms.
The API is provided as-is and with limited support. Please be aware that the API may change in future, requiring updates to your code.
To push solar / monitoring data into Charge HQ please use the following API endpoint:
POST https://api.chargehq.net/api/public/push-solar-data
This endpoint should be called no more frequently than once every 30 seconds.
Your API Key must be included in the JSON payload (see below), to obtain it ensure you have first created a Charge HQ account, then open the webapp (not the mobile app), go to My Equipment -> Solar / Battery Equipment, select Push API. You can then copy your API Key.
NOTE: the use of Site ID is deprecated and will be removed in future. Please update your software to use API Key instead.
The payload must be JSON and use the following fields. Most fields are optional. Note this is a Typescript schema, you need to send JSON.
Example JSON payload:
Before using the push API to send data into Charge HQ, in the app you will need to configure it as your solar data source:
Some users have made their scripts publicly available via GitHub, which may be a useful reference in developing your own. We thank these users for making their scripts available.
Charge HQ has not been involved in the development, nor tested the code and this list is not an endorsement of any of the referenced work. You should exercise your own judgement in choosing to adopt or use any part of it.