curl --request PATCH \
--url https://api.nox.energy/v1/devices/battery/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"device_id": "e4da3b7f-bbce-4a45-9d2b-1c0e8f7a6b5c",
"optimization_settings": {
"pv_self_consumption": false,
"dynamic_tariff": true,
"flex_trading": false,
"imbalance_optimization": true
}
}
'{
"detail": "Energy Supplier A is not authorized to access this feature."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "This endpoint is not available yet."
}Patch Devices Battery Settings
Preview: not available yet. This endpoint is documented ahead of its release and currently
answers 501 Not Implemented. Its contract may still change before release.
Update the settings of a single battery, or of all batteries of a user. To update a single battery,
only the device_id needs to be provided. To update all batteries of a user, provide the
user_id instead. Omitted settings are left unchanged.
You can change the following settings:
- Enable/Disable steering optimizations.
flex_tradingis mutually exclusive with the other optimizations. The other optimizations can be enabled together. Ifflex_tradingis enabled, we disable all other optimizations. If any other optimization is enabled, we disableflex_trading. If all optimizations are disabled, NOX Energy leaves the battery untouched.flex_tradingmeans that you steer the battery with the schedules you provide to NOX Energy (seePOST /v1/devices/battery/schedules). If you are a supplier that has a nox control package integration with Nox Energy, you should not enableflex_tradingbut instead the other optimization options like:imbalance_optimizationto optimize the battery to minimize imbalances based on the imbalance prices of the users country.dynamic_tariffmeans that we will optimize the battery based on the day-ahead market prices of the users country.pv_self_consumptionto optimize the battery to maximize self-consumption of pv production.
curl --request PATCH \
--url https://api.nox.energy/v1/devices/battery/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"device_id": "e4da3b7f-bbce-4a45-9d2b-1c0e8f7a6b5c",
"optimization_settings": {
"pv_self_consumption": false,
"dynamic_tariff": true,
"flex_trading": false,
"imbalance_optimization": true
}
}
'{
"detail": "Energy Supplier A is not authorized to access this feature."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "This endpoint is not available yet."
}Authorizations
API Key authentication. Enter your API key in the format: YOUR_API_KEY
Body
Battery device ID to update settings for
Your own ID of the user, to update the settings of all their batteries
Optimization settings for flex trading, dynamic tariff, PV self-consumption and imbalance optimization
Show child attributes
Show child attributes
Response
No Content - Settings updated successfully