success parameter on the redirect callback
- The Authenticator now appends a
successquery parameter to yourredirect_urlwhen redirecting the user back:?success=true(alongside the existing base64datapayload, which now also includesasset_type) on success, or?success=falseon failure, including when the user declines consent on the manufacturer’s OAuth screen. This lets a single redirect URL render both outcomes without inspecting thedatapayload. Applies to both the Energy Supplier and Manufacturer/OEM flows. See New Asset Integration.redirect_urlmust be a validhttp(s)URL; any query params you include are preserved.
Integration guides reorganized
- The Integration guides are now organized by connection type instead of by role: Bring Your Own Connection for asset types you already have a connection to, and New Asset Integration for asset types NOX Energy connects on your behalf. Both guides cover the Energy Supplier and Manufacturer/OEM flows side by side.
- Manufacturers/OEMs connecting a new device brand should now use the
POST /partner/link-sessionsendpoint, documented in the Manufacturer/OEM tab of New Asset Integration. The previousPOST /manufacturer/link-sessionsendpoint for this purpose will be deprecated.
Device data availability after connecting
- Clarified in the New Asset Integration guide that device data may not be immediately available after a user completes the Authenticator flow, as the connection may still need to finalize on the manufacturer’s (OEM) side. The /devices endpoint may return an empty result right after connecting. We advise polling for up to 10 minutes while showing a pending state to the end user.
API reference reorganized by asset type
- The NOX Control Package and Partner Control Package API references (formerly Full NOX Control Package and Supplier Control Package) have been merged into a single HP API reference, since they covered the same heat pump endpoints under different distribution models.
- Endpoint tags are now consistent across API references: read-only asset endpoints (devices, settings, consumption, telemetry) are tagged Asset Info, and heat pump steering endpoints are split into HP Control (submitting a control schedule) and Thermal Battery Control (reading current state and forecast). PV production endpoints moved from Device Production to Asset Info for the same reason.
New general_reason value
- Added
Too many heating zones, steering not supported for this configurationas a possiblegeneral_reasonvalue returned for heat pump devices that cannot be steered.
Heat Pump API Guide
- Added a Heat Pump API Guide documenting the thermal-battery endpoints: current state, forecast, and submitting a control schedule, with request examples in 7 languages.
- Documented polling /devices/telemetry/current for temporary real-time telemetry in the UI; recommended the webhook solution instead for consistently higher-granularity telemetry.
PV API Guide
- Added a PV API Guide documenting device info, production data (historical, forecasted, realtime forecast, and typical production), settings, and curtailing PV production via schedules or immediate fleet-wide flex control, with request examples in 7 languages.
- Added a delete endpoint for PV /user
PV production webhook event
- Added the
device.state.pv_production.updatedwebhook event, which delivers the current PV production reading (in kW) whenever it changes. See Partner webhooks to subscribe.
PV response latency
- The
GET /v1/devices/pvendpoint now returns aresponse_latency_secondsfield, indicating the expected latency in seconds before the device responds to a steering command.
PV production measurement timestamp
- The
GET /v1/devices/pvendpoint now returns alast_updated_attimestamp alongsidecurrent_production_kw, indicating when the production value was last measured. Treatcurrent_production_kwas the current production only iflast_updated_atis recent (e.g. less than 5 minutes in the past).
Production API update and new Authenticator
- Removed House predictions endpoint
- Removed flex up/down endpoints
- Added current production api endpoints
- Added integrated authentication endpoints
- Added energy supplier and manufacturer integration documentation
House predictions update
- Updated House predictions to be executed at 9:45 CET/CEST instead of 10:00 CET/CEST
- Updated from what time house predictions are done.
- Old version: House predictions predicted the house consumption from now until the next 72h.
- Current version: House predictions predict the house consumption for 72h starting from upcoming midnight 00:00 CEST/CET.
API Documentation redesign
- Redesigned the Nox Energy API documentation website to be more clear and structured.
- Added extra guides on how to get started with the Nox Energy API.
Nox Energy API Launch v1.0.0
- Official Nox API and Sandbox API launched! 🚀
- API endpoints to list device information.
- API endpoints to get historical and forecasted consumption data per asset or aggregated.
- API endpoints to get house consumption forecasts
- API endpoints to get current flex up/down and execute an amount of energy of flex across devices.