GET
/
v1
/
house
/
consumption
/
forecast
/
historical
Get House Consumption Forecast Historical
curl --request GET \
  --url https://api.sandbox.nox.energy/v1/house/consumption/forecast/historical \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "forecast_generation_time": "2025-04-29 08:00",
      "forecast_time": "2025-04-29 08:15",
      "consumption": "20008.7"
    },
    {
      "forecast_generation_time": "2025-04-29 08:00",
      "forecast_time": "2025-04-29 08:30:00",
      "consumption": "15755.8"
    }
  ],
  "meta": {
    "energy_supplier": "Energy Supplier A",
    "next_token": "AYABeH50-To0SRdAWC9BY9aCIaEAAAABAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6ND",
    "consumption_unit": "kWh",
    "granularity": "15min",
    "output_timezone": "UTC",
    "house_id": "12345"
  }
}

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 forecasts were generated. 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 forecasts were generated. The time is in UTC in ISO 8601 format.

Time format examples:

  • 2023-10-01T00:00:00Z
  • 2023-10-01T00:00:00
​
house_id
string | null

The ID of the house to get the forecast for. If not provided, the aggregated forecast for all houses is returned.

​
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
​
forecast_generation_timestamp
boolean
default:false

If true, query based on the datetime when the forecast was generated. Additionally, the output will include each day's coming 72 hour forecast starting from midnight 00:00 CET/CEST instead of the 24 hour forecast if you would query based on forecast time.

If false, query based on the datetime of the forecast time and not when the forecasts were generated. You query based on for what time the consumption forecast is predicting.

Note: If false, the output will not include the forecast for the coming 3 days. But it could include the forecast of the current day if queried on current day.

​
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.

Response

200
application/json

Successful response

The response is of type object.