Skip to content
English
Submit a request
Submit a request
  • There are no suggestions because the search field is empty.

Auto-collect feature

UtilityAPI’s auto-collect feature enables users to collect data upon customer authorization automatically. This is a self-serve opt-in feature and has restrictions based on the data access method for that utility. 

🔄 What is auto-collect?

Auto-collect is a feature that allows UtilityAPI to automatically collect bill, interval, and accounting from your customers' utility meters as soon as they authorize access.  

This feature works across all our utilities as described below.  

🔄 How does auto-collect work for web portal adapter utilities?

  • If enabled, we will only automatically collect data for authorizations with three electric meters or fewer (if an authorization has four or more meters, we won’t automatically collect any meters)
  • This feature is 100% opt-in and can be disabled at any time in your Dashboard settings

✅ How do I enable auto-collect for web portal adapter utilities?

  1. Log in to your UtilityAPI Dashboard
  2. Go to Settings
  3. Toggle auto-collect on for each supported utility you want to enable. You can disable auto-collect for any utility at any time.

 

Enable Auto-Collect for Utility Data (5)

Note: To enable auto-collect, you will need to be an admin for your organization. Have questions? Reach out to sales@utilityapi.com.

💸 How much does auto-collect cost for web portal adapter utilities?

With auto-collect enabled, your account will be charged the same price as if you were manually starting the initial (i.e., the first) collection of data from a meter or meters. 

  • If your account is on our standard pricing, the cost will depend on the default number of months you’ve set in your Settings. Learn more about setting your default duration.
  • If you are on a custom plan, the cost will match your contract’s price, and we will always attempt to collect up to three years of data where available.
  • The auto-collect feature is free to turn on or off. 

If you have any questions about your account’s pricing, contact your account manager or email sales@utilityapi.com. 

🔄 How does auto-collect work for green button OAuth utilities?

  • Auto-collect is enabled by default for all green button OAuth utilities and all authorizations.

✅ Can I disable auto-collect for green button proxy utilities?

  • No, currently you cannot disable this feature for initial collections made via our green button OAuth data access method.

💸 How much does auto-collect cost for green button Oauth utilities?

  • All collections made via our green button OAuth data access method, including auto-collections, are no-cost.

🔄 How does auto-collect work for green button proxy utilities?

  • If enabled, we will only automatically collect data for authorizations with three electric meters or fewer (if an authorization has four or more meters, we won’t automatically collect any meters)
  • This feature is 100% opt-in and can be disabled at any time in your Dashboard settings.

✅ How do I enable auto-collect for green button proxy utilities?

  1. Log in to your UtilityAPI Dashboard;
  2. Go to your Settings;
  3. Toggle auto-collect on for each supported utility you want to enable. You can disable auto-collect for any utility at any time.

Note: To enable auto-collect, you will need to be an admin for your organization. Have questions? Reach out to sales@utilityapi.com.

💸 How much does auto-collect cost for green button proxy utilities?

 To complete green button proxy collections, your account must be on a custom plan. 

  • If you are on a custom plan that includes green button proxy, your collection costs will match your contract's price, and by default, we will attempt to collect up to three years of data when available from the utility. 
  • If you are not on a custom plan, but want a custom plan proposal that includes green button proxy, please contact sales@utilityapi.com.
  • The auto-collect feature is free to turn on or off. 

🧪 Is Auto-collect available via API?

Yes, auto-collect behavior will be triggered when new authorizations are created via your API integration, just like when they are created via your account's dashboard. No additional parameters are required to initiate it.

You cannot enable and disable the auto-collect feature via API. If you would like this capability, please let us know.

Still Have Questions?

If you're seeing errors or are unsure if an authorization is eligible for auto-collect, please submit a help center request.