> ## 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. # Get Households House Load Forecast > **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. Get the forecasted house load of your households in kWh for a specific timeframe with 15 min granularity. The house load is everything the household consumes except the battery, before pv production is subtracted. Heat pump consumption is included. The timestamp refers to the 15 minutes after it. ## OpenAPI ````yaml /api-docs/household/openapi-household.json get /v1/households/house-load/forecast openapi: 3.1.0 info: title: NOX Energy API - Household description: > # Household API Documentation This documentation shows only the household endpoints: the households of your users, the NOX-connected devices in them and the optimization settings they share. **Preview:** these endpoints are documented ahead of their release and currently answer `501 Not Implemented`. ## Authentication 1. Get your API key from [NOX Energy](mailto:support@nox.energy). 2. Include the API key in your API calls with the header: `x-api-key: YOUR_API_KEY`. Base URL: [https://api.nox.energy](https://api.nox.energy) version: 1.0.0 servers: - url: https://api.nox.energy description: Production Server security: - ApiKeyAuth: [] tags: - name: Asset Info description: API to get basic information about your assets. paths: /v1/households/house-load/forecast: get: tags: - Asset Info summary: Get Households House Load Forecast description: >- **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. Get the forecasted house load of your households in kWh for a specific timeframe with 15 min granularity. The house load is everything the household consumes except the battery, before pv production is subtracted. Heat pump consumption is included. The timestamp refers to the 15 minutes after it. operationId: get_households_house_load_forecast_v1_households_house_load_forecast_get parameters: - name: start_time in: query required: true schema: type: string description: > Start of the requested period. Intervals starting at or after this time are returned. The time is in UTC in ISO 8601 format. Time format examples: - 2023-10-01T00:00:00Z - 2023-10-01T00:00:00 title: Start Time description: > Start of the requested period. Intervals starting at or after this time are returned. The time is in UTC in ISO 8601 format. Time format examples: - 2023-10-01T00:00:00Z - 2023-10-01T00:00:00 - name: end_time in: query required: true schema: type: string description: > End of the requested period. Intervals starting before this time are returned. The time is in UTC in ISO 8601 format. Time format examples: - 2023-10-01T00:00:00Z - 2023-10-01T00:00:00 title: End Time description: > End of the requested period. Intervals starting before this time are returned. The time is in UTC in ISO 8601 format. Time format examples: - 2023-10-01T00:00:00Z - 2023-10-01T00:00:00 - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: > 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. default: 1000 title: Limit description: > 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. - name: next_token in: query required: false schema: anyOf: - type: string - type: 'null' description: > 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`. title: Next Token description: > 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`. - name: household_id in: query required: false schema: anyOf: - type: string - type: 'null' description: > Household ID to get data of. If `None`, all households are included. title: Household Id description: | Household ID to get data of. If `None`, all households are included. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/HouseLoadForecastResponse' example: data: - forecast_time: 2026-10-17 18:00 household_id: 8f14e45f-ceea-467a-9575-6c1b1f1e7c2a house_load_kwh: 0.92 meta: energy_supplier: Energy Supplier A next_token: >- AYABeH50-To0SRdAWC9BY9aCIaEAAAABAAdhd3Mta21zAE5hcm46YXdzOmttczpldS1jZW50cmFsLTE6ND energy_unit: kWh granularity: 15min output_timezone: UTC '403': description: Your API key has no access to the battery features content: application/json: example: detail: Energy Supplier A is not authorized to access this feature. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '501': description: Not implemented yet content: application/json: example: detail: This endpoint is not available yet. components: schemas: HouseLoadForecastResponse: properties: data: anyOf: - items: $ref: '#/components/schemas/HouseLoadForecast' type: array - type: 'null' title: Data description: List of 15 minute values meta: anyOf: - $ref: '#/components/schemas/HouseLoadForecastMeta' - type: 'null' description: Response metadata type: object title: HouseLoadForecastResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HouseLoadForecast: properties: forecast_time: anyOf: - type: string - type: 'null' title: Forecast Time description: Start of the 15 minute interval the value refers to household_id: anyOf: - type: string - type: 'null' title: Household Id description: Unique household identifier house_load_kwh: anyOf: - type: number - type: 'null' title: House Load Kwh description: >- Expected house load during the interval in kWh: everything the household consumes except the battery, before PV production is subtracted. Heat pump consumption is included. type: object title: HouseLoadForecast HouseLoadForecastMeta: properties: energy_supplier: anyOf: - type: string - type: 'null' title: Energy Supplier description: Energy supplier name next_token: anyOf: - type: string - type: 'null' title: Next Token description: Token for pagination energy_unit: anyOf: - type: string - type: 'null' title: Energy Unit description: Unit of the energy values, e.g. kWh granularity: anyOf: - type: string - type: 'null' title: Granularity description: Granularity of the data, e.g. 15min output_timezone: anyOf: - type: string - type: 'null' title: Output Timezone description: Timezone of the output data. type: object title: HouseLoadForecastMeta ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: 'API Key authentication. Enter your API key in the format: YOUR_API_KEY' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.