# Nox Energy API Documentation ## Docs - [Authentication](https://docs.nox.energy/api-docs/authentication.md): How to get access to our API - [Get Devices](https://docs.nox.energy/api-docs/full-control/asset-info/get-devices.md): Get information about all NOX connected devices associated with your energy supplier account. If you want to know the response structure or possible enum values, like steerable reasons, you can check it in the response model `schema`. - [Get Device Consumption Forecast Historical](https://docs.nox.energy/api-docs/full-control/device-consumption/get-device-consumption-forecast-historical.md): Get the forecasted consumption for devices associated with your energy supplier account in kWh for a specific timeframe with 15min granularity. - [Get Device Consumption Historical](https://docs.nox.energy/api-docs/full-control/device-consumption/get-device-consumption-historical.md): Get the measured historical consumption data for devices associated with your energy supplier account in kWh for a specific timeframe in 15min granularity. - [Get Device Typical Consumption Historical](https://docs.nox.energy/api-docs/full-control/device-consumption/get-device-typical-consumption-historical.md): Get the typical consumption for devices associated with your energy supplier account in kWh for a specific timeframe with 15min granularity. - [Delete User](https://docs.nox.energy/api-docs/full-control/user-management/delete-user.md): Delete all data and connections associated to the user and the energy supplier. Some delete operations might be delayed by 1 day. - [Patch Devices Settings](https://docs.nox.energy/api-docs/full-control/user-management/patch-devices-settings.md): Update on a device or user level the device/user settings. If you want to update a setting on a device level, provide the device_id along with the user_id. Any of the settings can be updated separately or together. - [Connect User to NOX](https://docs.nox.energy/api-docs/manufacturer-integration-deprecated/manufacturer-integration/connect-user-to-nox.md): Connects a manufacturer user to NOX without linking to an energy supplier account. Use this endpoint when the user does not need to be connected to an energy supplier via OAuth. Creates or updates the subscriber record with the provided device IDs. - [Connect User to NOX with Supplier OAuth](https://docs.nox.energy/api-docs/manufacturer-integration-deprecated/manufacturer-integration/connect-user-to-nox-with-supplier-oauth.md): Connects a manufacturer user to NOX with the intent of linking them to an energy supplier via OAuth. Creates or updates the subscriber record and returns a link_url where the user should be redirected to complete the supplier OAuth flow. - [Create manufacturer device connection](https://docs.nox.energy/api-docs/manufacturer-integration/manufacturer/create-manufacturer-device-connection.md): Connect a user and his device(s) by a manufacturer. - [Create manufacturer link session](https://docs.nox.energy/api-docs/manufacturer-integration/manufacturer/create-manufacturer-link-session.md): Create a new link session to connect a user of a manufacturer, with the intend to authenticate with the energy supplier. The returned `link_url` should be used to redirect the end-user to the NOX Authenticator UI. - [Get Manufacturer Devices](https://docs.nox.energy/api-docs/manufacturer/asset-info/get-manufacturer-devices.md): Get information about all NOX connected devices associated with your manufacturer account. - [Submit Manufacturer Settings](https://docs.nox.energy/api-docs/manufacturer/manufacturer-control/submit-manufacturer-settings.md): Update on a user/device level the manufacturer settings. - [Get Devices Pv](https://docs.nox.energy/api-docs/pv/asset-info/get-devices-pv.md): Get information about all NOX connected pv devices associated with your external account. If you want to know the response structure or possible enum values, you can find it in the response model `schema`. - [Get Device Pv Production](https://docs.nox.energy/api-docs/pv/device-production/get-device-pv-production.md): Get the measured historical pv production data for devices associated with your energy supplier account in kWh for a specific timeframe in 15min granularity. - [Get Devices Pv Production Forecast](https://docs.nox.energy/api-docs/pv/device-production/get-devices-pv-production-forecast.md): Get the forecasted production for pv devices associated with your energy supplier account in kWh for a specific timeframe with 15min granularity. - [Post Pv Control Schedule](https://docs.nox.energy/api-docs/pv/pv-control/post-pv-control-schedule.md): Submit a steering schedule by providing a start and end time with a 1 min granularity of when you would like pv production to be off. Our system will look every minute to stop or re-enable the pv production. You can post several scheduled controls for the same device. They will be appended to the… - [Patch Devices Pv Settings](https://docs.nox.energy/api-docs/pv/user-management/patch-devices-pv-settings.md): Update on a device or user level the device/user settings. If you want to update a setting on a device level, provide the device_id instead. Any of the settings can be updated separately or together. - [Get Devices](https://docs.nox.energy/api-docs/supplier-control/asset-info/get-devices.md): Get information about all NOX connected devices associated with your energy supplier account. If you want to know the response structure or possible enum values, like steerable reasons, you can check it in the response model `schema`. - [Get Device Consumption Historical](https://docs.nox.energy/api-docs/supplier-control/device-consumption/get-device-consumption-historical.md): Get the measured historical consumption data for devices associated with your energy supplier account in kWh for a specific timeframe in 15min granularity. - [Get Device Typical Consumption Historical](https://docs.nox.energy/api-docs/supplier-control/device-consumption/get-device-typical-consumption-historical.md): Get the typical consumption for devices associated with your energy supplier account in kWh for a specific timeframe with 15min granularity. - [Get Thermal Control Current State](https://docs.nox.energy/api-docs/supplier-control/thermal-control/get-thermal-control-current-state.md): Get the current thermal state of a specific device. - [Get Thermal Control Forecast](https://docs.nox.energy/api-docs/supplier-control/thermal-control/get-thermal-control-forecast.md): Get the thermal model forecast data for a specific device. - [Submit Thermal Control Schedule](https://docs.nox.energy/api-docs/supplier-control/thermal-control/submit-thermal-control-schedule.md): Submit a steering schedule starting from the next quarter-hour for the 24hours thereafter. (= 96 15min intervals) Example: You submit at 10:07, the schedule will start at 10:15 and end at 10:00 the next day. You can provide a timestamp in the future to start the schedule at a later time. If the t… - [Submit Thermal Control Settings](https://docs.nox.energy/api-docs/supplier-control/thermal-control/submit-thermal-control-settings.md): [DEPRECATING] This endpoint will be deprecated in the future, please use the /devices/settings endpoint instead for both user and device level settings updates. the main change between them is steering_enabled migrating to optimization_settings -> flex_trading field. - [Delete User](https://docs.nox.energy/api-docs/supplier-control/user-management/delete-user.md): Delete all data and connections associated to the user and the energy supplier. Some delete operations might be delayed by 1 day. - [Patch Devices Settings](https://docs.nox.energy/api-docs/supplier-control/user-management/patch-devices-settings.md): Update on a device or user level the device/user settings. If you want to update a setting on a device level, provide the device_id along with the user_id. Any of the settings can be updated separately or together. - [Connect User to NOX](https://docs.nox.energy/api-docs/supplier-integration-deprecated/supplier-integration/connect-user-to-nox.md): Connects a user to NOX with the intent of linking them to a manufacturer asset. Provides a link_url where the user should be redirected to complete the manufacturer authentication flow. - [Create supplier link session](https://docs.nox.energy/api-docs/supplier-integration/supplier/create-supplier-link-session.md): Create a new link session to connect a user of an energy supplier, with the intend to authenticate with the device manufacturer. The returned `link_url` should be used to redirect the end-user to the NOX Authenticator UI. - [Product updates](https://docs.nox.energy/changelog/product-updates.md): Updates and Changes - [Energy Supplier Integration](https://docs.nox.energy/guides/energy-supplier-integration.md): Guide on how to integrate NOX Energy into the energy supplier website/app. - [Full NOX Control Package](https://docs.nox.energy/guides/full-control-package.md): Guide on how to use the full NOX control package. - [Getting Started](https://docs.nox.energy/guides/get-started.md): Start controlling and/or receiving data of our assets - [Introduction](https://docs.nox.energy/guides/introduction.md): Welcome to the Nox Energy API - [Partner webhooks](https://docs.nox.energy/guides/partner-webhooks.md): Receive real-time updates from NOX at your HTTPS endpoint. Register your URL with our team; verify signatures with your API key. - [Supported Assets Overview](https://docs.nox.energy/supported-assets/supported-assets-overview.md): Overview of the supported brands and device models by NOX Energy. ## OpenAPI Specs - [openapi-thermal-control](https://docs.nox.energy/api-docs/supplier-control/openapi-thermal-control.json) - [openapi-full-control](https://docs.nox.energy/api-docs/full-control/openapi-full-control.json) - [openapi-pv](https://docs.nox.energy/api-docs/pv/openapi-pv.json) - [openapi-supplier-auth](https://docs.nox.energy/api-docs/supplier-integration/openapi-supplier-auth.json) - [openapi-supplier-auth-v2](https://docs.nox.energy/api-docs/supplier-integration/openapi-supplier-auth-v2.json) - [openapi-manufacturer-auth](https://docs.nox.energy/api-docs/manufacturer-integration/openapi-manufacturer-auth.json) - [openapi-manufacturer](https://docs.nox.energy/api-docs/manufacturer/openapi-manufacturer.json) - [openapi-manufacturer-auth-v2](https://docs.nox.energy/api-docs/manufacturer-integration/openapi-manufacturer-auth-v2.json) ## Optional - [Blog](https://www.nox.energy/blog)