Skip to main content
GET
/
v1
/
devices
/
pv
/
production
/
typical-production
Get Devices Pv Typical Production
curl --request GET \
  --url https://api.nox.energy/v1/devices/pv/production/typical-production \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "typical_production_time": "2025-05-01 07:45",
      "device_id": "1400d85b-47c3-49e1-9317-ae1bfccb635c",
      "production": "2.61"
    },
    {
      "typical_production_time": "2025-05-01 07:45",
      "device_id": "0910947a-fab9-450e-b5ac-48e9c4f3e725",
      "production": "1.75"
    }
  ],
  "meta": {
    "energy_supplier": "Energy Supplier A",
    "next_token": "AYABeH50-To0SRdAWC9BY9aCIaEAAAABAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6ND",
    "production_unit": "kWh",
    "granularity": "15min",
    "output_timezone": "UTC"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nox.energy/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
start_time
string
required

Start time when the production measurement were taken. The time is in UTC in ISO 8601 format.

Time format examples:

  • 2023-10-01T00:00:00Z
  • 2023-10-01T00:00:00
​
end_time
string
required

End time when the production measurement were taken. The time is in UTC in ISO 8601 format.

Time format examples:

  • 2023-10-01T00:00:00Z
  • 2023-10-01T00:00:00
​
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 production of the devices.

If false, return the production of each device separately.

Note: If device_id is given in the device_id parameter, the aggregated parameter is ignored.

​
device_id
string

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

Response

Successful response

​
data
PVPTPData · object[] | null

List of devices

​
meta
PVTPMeta · object

Response metadata