curl --request POST \
  --url https://api.nox.energy/v1/devices/pv/flex \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "target_kw": 2.5
}
'

{
  "meta": {
    "energy_supplier": "Energy Supplier A"
  }
}

{
  "detail": "None of the provided device_ids allow steering or are compatible."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PV Control

Post Pv Control Flex

Execute pv flex controls at the current time based on % of max capacity or amount of kW in production you want to lower of its current aggregated production across the whole supplier client base. If you provide an end_time with a 1 min granularit, we will revert the curtailed amount to it’s original amount at that time. If no end_time is given, we do not automatically revert back. When you execute flex on already curtailed devices, we will overwrite their current curtailment and scheduled end time with the new flex command you provided.

Timestamp fields in UTC.

Time format examples:

2023-10-01T00:00:00Z
2023-10-01T00:00:00

control_type can be set to export_curtailment, production_curtailment or default.

100 % target_percentage means that we will enable full production on the full pv panel fleet again.
You can also provide a list of brands to filter on to fully turn off or on curtailment for all devices of a specific brand with the brand_filter parameter. If no brands are provided, we will execute flex on all brands.

NOTE:

The pv devices might need some time to react. If using end_time please provide end_time at least 4 minutes in the future to ensure the device can react in time. Some may react slower than others.

POST

devices

flex

curl --request POST \
  --url https://api.nox.energy/v1/devices/pv/flex \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "target_kw": 2.5
}
'

{
  "meta": {
    "energy_supplier": "Energy Supplier A"
  }
}

{
  "detail": "None of the provided device_ids allow steering or are compatible."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key

string

header

required

API Key authentication. Enter your API key in the format: YOUR_API_KEY

Body

application/json

target_kw

number | null

Target power in kW to reduce production with.

target_percentage

number | null

Target percentage of max capacity to reduce production with.

Required range: 0 <= x <= 100

end_time

string | null

End time for the flex request in ISO 8601 format in UTC. If not provided, the flex request will be applied indefinitely until a new request is made.

brand_filter

string[] | null

Filter devices by brands. If not provided, all brands will be considered.

Response

All controls accepted successfully

API setup

Full NOX Control Package

Supplier Control Package

Manufacturer Package

Connecting Users and Devices

PV

Post Pv Control Flex

Authorizations

Body

Response