Skip to main content
GET
/
v1
/
flex
/
down
Get Device Flex Down
curl --request GET \
  --url https://api.sandbox.nox.energy/v1/flex/down \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "device_id": "0910947a-fab9-450e-b5ac-48e9c4f3e725",
      "flex_down": "2.56"
    },
    {
      "device_id": "1400d85b-47c3-49e1-9317-ae1bfccb635c",
      "flex_down": "3.58"
    }
  ],
  "meta": {
    "energy_supplier": "Energy Supplier A",
    "next_token": "AYABeH50-To0SRdAWC9BY9aCIaEAAAABAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6ND",
    "flex_unit": "kWh"
  }
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
limit
integer
default:1000

The maximum number of items to return per page of results.

This should be used together with the next_token parameter to paginate through results.

Read the pagination parameter documentation for more details.

Required range: 1 <= x <= 1000
​
next_token
string | null

The next_token is a token used to retrieve the next page of results when there are more results than can fit in a single page(=API response).

By default, the API will return a next_token of the first page if no token was given as a parameter.

If the token is null you have reached the end of the results.

This should be used together with the limit parameter to paginate through results.

To get all results of your call, you can keep calling the same API call with the previously returned next_token until it returns null.

​
aggregated
boolean
default:false

If true, sum the flex of the devices.

If false, return the flex of each device separately.

​
device_id
string

Device ID to get consumption of. If None, all devices are included.

Response

Successful response

The response is of type Response Get Device Flex Down V1 Flex Down Get · object.