Changelog
Start typing to search…
Back to All

API Updates - Release 11/03/25

2 days ago by Allen Wang

Detailed electricity data and improved connection creation.

What's New in v2.1

Enhanced Electricity Data Fields

v2.1 now captures advanced electricity metrics:

  • Apparent Energy Usage: Total energy including both working and non-working components (measured in kVAh, MVAh, or GVAh).
  • Reactive Energy Usage: Non-working energy (measured in kVArh, MVArh, or GVArh).
  • Power Factor: Efficiency ratio indicating how effectively electrical power is being used (value between 0.0 and 1.0).

These fields are automatically extracted from utility bills when available and appear across all v2.1 usage data and document endpoints.

Reminder:
v2.1 also returns demand meter data alongside consumption meter data in a unified format through all usage data endpoints. The new electricity fields are currently only supported on normal USAGE electricity meters, not on demand meters.

Improvements to v2.0 and v2.1

Security Questions for Utility Authentication

Many utility providers require security questions during login. You can now provide security question answers when creating connections:

{
  "username": "[email protected]",
  "password": "password123",
  "url": "https://utility.com",
  "country": "US",
  "sites": ["site-uuid"],
  "securityQuestions": [
    { "key": "What is your mother's maiden name?", "value": "Smith" },
    { "key": "What city were you born in?", "value": "Boston" }
  ]
}

The securityQuestions field is optional and accepts an array of question–answer pairs.

Smarter Duplicate Connection Handling

We've improved how the API handles duplicate connection requests to prevent confusion:

  • The API now returns HTTP 400 with a clear error message when you attempt to create a duplicate, preventing accidental duplicates.
  • A connection is considered a duplicate when it has the same utility provider and username as an existing connection in your company.

Pre-filled Magic Links

When generating magic links for users to create connections, you can now pre-populate connection details using the
“Create Magic Link with Prefilled Data for Creating a Utility Account Connection” endpoint.

Options for pre-filled fields:

  • Utility URL
  • Initial sites
  • Country
  • Connection owner email
  • Data collection start date

Optional expiration:

  • Set a custom expiration time for magic links.

Migration Notes

  • v2.0 and v2.1: All connection-related changes are fully backward compatible. New fields are optional, and existing integrations continue to work without modification.
  • v2.1: New electricity fields return null when data is not available on utility bills.