UtilityAPI collects data that your customer has agreed to share.
When you sign up for UtilityAPI, we will generate a unique link for you to use to get your customer’s authorization to share their data. Each user you add to your account will also get a unique link to use for customer authorization. Whether you use UtilityAPI’s dashboard or API, the first thing you need to do is put that unique link in front of your customer, which we call ‘requesting data.’
1. Request data from customer
Via the Dashboard
Request data from your customer using your UtilityAPI dashboard. When you're logged in, click on ‘Request Data’ to get started. You can send a data request directly from our platform by filling out the email template form, or simply use your unique link in an existing email or text chain with a customer. Your authorization link can also be embedded in an iFrame (if you want to add it to your website or a customer-facing application).
Your customer will see that the data request comes from you, not from UtilityAPI. Your link has your name and your company name (taken from your email address). If you choose to upload your company logo, then your company’s logo will also be at the top of the authorization form.
Via the API
Use the API to create links to pre-filled authorization forms. Here’s how.
Either way, UtilityAPI offers you wide flexibility in requesting customer data. You decide the best way to interact with your customer. You can:
- Send your link via email, using our template or an email that you have written
- Send your link via text
- Integrate your link into your website
- Have your link pre-filled on a cell phone or tablet
2. Your customer authorizes
This is what the customer sees when you send them a data request or clicks on your unique portal link. They will need to enter their email, securely share their utility credentials, e-sign the form, and click on the button at the bottom to authorize access to the data. That's it!
We also include helpful links if they do not have an online account or forgot their password. These links will direct them to the utility website where they can either create a new account or reset their password.
3. We collect data
Via the API
When your customer authorizes sharing, their meter list will become available through the API. You’ll be notified via webhooks when it does, and you can begin to collect data.
Via the Dashboard
We will notify you via email when your customer authorizes data sharing. Login to UtilityAPI. New authorizations will display on the top of your dashboard. Click on 'Get Data' to start the meter data collection. Your data will be available shortly!
While we are collecting data, the Get Data button will turn orange and say “running.” When collection is finished, the button will turn green. However, you don't have to wait for collection to finish in order to see what data has been collected so far. (Go ahead. Click the orange button. It’s ok!)
Click on ‘See Data’ to download your data in the format that best fits your needs.
Examples of the data we collect
Types of data available vary by utility. See here for the complete list. The data we collect is cleaned and standardized across all utilities we support.
Intervals (as CSV, XML and Json file formats)
TOU breakdowns/Bill Tiers