Welcome to the WaterCompass API Program!
The WaterCompass service provides flow monitoring for water visibility and leak detection. This page will provide you with essential resources to investigate and implement the WaterCompass API.
Documentation
The documentation for the WaterCompass API is available at the following web page:
WaterCompass API Technical documentation
In cases where it does not affect the functionality or implementation of the API, this documentation may be updated without notice in order to improve clarity and support for end users.
Notification will be provided at least one year in advance before an API version is retired.
Support
To receive the most effective service please utilize the following template:
Any support requests can be directed to your assigned Performance Management representative or delivered directly to APIsupport@hydropoint.com.
API Request Limits
Customers should adhere to both of the following request limits:
- Rate: Not to exceed 1 request per second.
- Total Requests: (# of meters * 10) per hour.
Example: Customer has 1000 meters, so up to 10,000 requests are permitted per hour.
Access
Access to the WaterCompass API will be included in your existing WaterCompass subscription at no additional cost and will include data from all devices for which a subscription is currently active.
If you choose to implement the WaterCompass API, a representative for your organization, as well as a representative from any of your relevant partner organizations, will be required to sign the following agreements:
- Fundamental terms and conditions applicable to all HydroPoint APIs
- Requires signature from HydroPoint CTO and Customer Representatives
If you’d like to request access to the API, you can begin this process by providing signed copies of the above documents to APIsupport@hydropoint.com.
Feedback
Please provide any feedback to your Customer Success representative via APIsupport@hydropoint.com.