Where do I start with this API Integration?
The best place to start is our Quickstart guide, which walks you through creating an API token, sending a data request, and collecting data.
How do I test using the API?
Using the Test Submit API endpoint, you can simulate different test scenarios. Testing happens in a production environment account.
Do I need to create multiple API tokens for testing and production?
No, you can use the same API token across all environments. If you prefer to use separate API tokens for different use cases or applications, you can create new tokens in your dashboard settings under the API Settings section.
Does UtilityAPI charge by API call?
No, we charge for each collection of new data, whether that collection is triggered by you or triggered automatically when you set up Monitoring. Once data is collected, you can download it over API as many times as you want without additional charges.
See our pricing page for more information.
Can customers share their utility account credentials with us via API?
No, customers must enter their utility account credentials in our secure authorization form you send them.
How do I know when new data is available?
You can be notified when new data is available via email or webhooks. Webhooks include the meter or authorization IDs so you can automate your API workflows to download the new data.
What rate limits do you have for your APIs?
We support fifty (50) requests per second by default. We also encourage users to avoid requesting bill and interval data more than once per minute and sending other requests more than once per second.
Higher limits can be set up to accommodate high volume use cases. Please contact us to learn more about rate limit change pricing.
Why am I receiving a 402 error when trying to use the API?
You will see a 402 error when you are not yet on a prepaid account, or have a negative balance to your prepaid account.
You must be on a $50 minimum prepaid account to trigger collections over the API. You can upgrade to a prepaid account here.
Why am I receiving other errors when trying to collect data over the API?
Our general error format is documented here, and error codes are listed for each endpoint. Here are links to error information for a few commonly used endpoints:
When using the API, I received a message saying “Service exists but no logs yet.” What does this mean?
This message means the customer has authorized access to their account, but the individual meter in their account has not been activated.
To activate this meter, trigger a Historical Collection or set up Monitoring.