UtilityAPI, version 2, is easy! Below are brief descriptions of our API endpoints. If you're not clear on how to use these endpoints, head over to the Quickstart to get a brief introduction to using UtilityAPI.
APIv2 URLs: https://utilityapi.com/api/v2/...
/templates
Templates are the base formatting object for our authorization forms.
/api/v2/templates
List or search your templates
/api/v2/templates/123
Get a specific template
/forms
Forms are individual authorization forms that you can send to utility customers.
/api/v2/forms
List or search your forms
/api/v2/forms
Create a new form
/api/v2/forms/123
Get a specific form
/api/v2/forms/123
Modify an existing form
/api/v2/forms/123
Delete a form
/api/v2/forms/123/test-submit
Simulate a user submitting a form
/authorizations
Authorizations are submitted by utility customers.
/api/v2/authorizations
List or search your authorizations
/api/v2/authorizations/123
Get a specific authorization
/api/v2/authorizations/123
Modify an existing authorization
/api/v2/authorizations/123
Delete a authorization (test-submits only)
/api/v2/authorizations/123/revoke
Revoke an authorization (deletes all meters and data)
/meters
Meters are the utility services for an authorized utility customer.
/api/v2/meters
List or search your meters
/api/v2/meters/123
Get a specific meters
/api/v2/meters/123
Modify an existing meters
/api/v2/meters/historical-collection
Collect historical billing and interval data for some meters
/api/v2/meters/ongoing-monitoring
Start or stop monitoring meters for new bills and intervals
/bills
Bills are the utility bills for an authorized utility customer.
/api/v2/bills
List or search your bills
/intervals
Intervals are the meter usage intervals for an authorized utility customer.
/api/v2/intervals
List or search your intervals
/files/...
Files are raw or formatted data linked to by other objects in the API.
/api/v2/files/...
Get a raw file referenced elsewhere in the API
/events
Events are webhook events that are created during authorization and data collection.
/api/v2/events
List or search your events
/api/v2/events/123
Get a specific event
/api/v2/events/123
Modify an existing event
/accounting
NOTE: We're in the process of rolling out the accounting API to all of the utilities we support. Accounting information is currently only available for ConEd, PCE, PG&E, PSE&G, SoCal Gas, SRP, Eversource, and SVCE.
In addition to billing data, we provide accounting data like billing account metadata and payments made to the utility.
/accounting/billing-accounts
Billing accounts are our representation of the information the utility uses to bill their customers.
/api/v2/accounting/billing-accounts
List or search your billing accounts
/api/v2/accounting/billing-accounts/123
Get a specific billing account
/accounting/billing-summaries
Billing summaries are summaries of payment-related information - usually collected from utility bills.
/api/v2/accounting/billing-summaries
List or search your billing summaries
/api/v2/accounting/billing-summaries/123
Get a specific billing summary