Version overview
| Version | Status | Base URL |
|---|---|---|
| v2.2 | Recommended | https://external.nectarclimate.com/v2.2 |
| v2.1 | Supported | https://external.nectarclimate.com/v2.1 |
| v2.0 | Legacy | https://external.nectarclimate.com/v2 |
X-API-Key header), the same endpoints, and the same pagination format. The differences are in the response shapes for document and usage data serializers.
What changed in v2.1
v2.1 updated the serializers for documents and usage data endpoints. Changes include:- Updated document response fields with additional metadata
- Updated usage data response fields with additional detail
- All other endpoints (companies, sites, connections, meters, jobs, webhooks) are identical to v2.0
What changed in v2.2
v2.2 updated the serializer for documents only. Changes include:- Updated document response fields with enhanced data
- Usage data endpoints are identical to v2.1
- All other endpoints are identical to v2.0
Migration path
From v2.0 to v2.2
- Update your base URL from
/v2to/v2.2 - Update any code that parses document responses — the response shape has changed
- Update any code that parses usage data responses — the response shape has changed
- Test against the sandbox before switching production traffic
From v2.1 to v2.2
- Update your base URL from
/v2.1to/v2.2 - Update any code that parses document responses — the response shape has changed
- Usage data and all other endpoints are compatible without changes
- Test against the sandbox before switching production traffic
Checking your version
The/ping endpoint returns version information. Use it to confirm which version you’re calling: