Authentication, input and response

Determine the estimated current or potential NTA 8800 energy label

POST https://api.altum.ai/v2/energylabel/apartments

Headers

Name	Type	Description
x-api-key*	string	Unique API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Content-Type	string	application/json

Request Body

Field	Type	Description	Example/Default
postcode*	string	zip code in six-character format	1234AB
housenumber*	integer	house number	1
houseaddition	string	addition to the house number	A
position	integer	1 = 'Corner ground floor' 2 = 'In between ground floor' 3 = 'Corner mid floor' 4 = 'In between mid floor' 5 = 'Corner top floor' 6 = 'In between top floor' 7 = 'Entire top floor'	Default: 3
floors	integer	Does the unit has one or more floors? 1 = 'Single' 2 = 'Multiple'	Default: 1
back_facade	boolean	Does the unit has as back facade? false = no true = yes	Default: false
build_year	integer	build year	1960
apartment_type	integer	1 = 'Galerijflat' 2 = 'Portiekflat' 3 = 'Maisonnette' 4 = 'Benedenwoning' 5 = 'Bovenwoning' 6 = 'Portiekwoning'	2
inner_surface_area	float	inner surface area (m2)	70
wall_insulation	integer	see Measures	2
floor_insulation	integer	see Measures	2
roof_insulation	integer	see Measures	2
living_room_windows	integer	see Measures	2
installation	integer	see Measures	Default: 4
shower	integer	see Measures	Default: 1
cooling	integer	Is there a cooling system present? 1 = No cooling 2 = Air conditioning unit, direct air cooling	Default: 1
ventilation	integer	see Measures	Default: 1
electric_cooking	integer	What is used for cooking? 1 = Gas stove 2 = Electric stove	Default: 2 if Installation in [6,7], Else 1
inhabitants	integer	number of people living in the house	Default: 3
solar_panels	list	see Measures

Specifying both the position and the floors of the apartment is recommended for optimal results.

Differences from Houses endpoint

• apartment_type instead of house_type

• roof_insulation instead of sloped_roof_insulation and flat_roof_insulation

• no berdroom_windows

• apartment_type is not important but position and floors are

Request body

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1
}

Response Status Codes

200: OK Successful response

{
	"Output": {
		"warnings": [],
		"postcode": "2771DS",
		"housenumber": 87,
		"houseaddition": null,
		"build_year": 1961,
		"inner_surface_area": 131,
		"house_type": "Vrijstaand",
		"installation": 6,
		"wall_insulation": 3,
		"sloped_roof_insulation": 4,
		"flat_roof_insulation": 3,
		"floor_insulation": 4,
		"living_room_windows": 3,
		"bedroom_windows": 3,
		"shower": 1,
		"ventilation": 4,
		"cooling": 1,
		"electric_cooking": 2,
		"solar_panels": null,
		"CO2": 2766,
		"definitive_energy_label": "A+++",
		"definitive_energy_label_type": "NTA 8800:2024 (basisopname woningbouw)",
		"definitive_energy_label_validity_date": "2036-1",
		"definitive_BENG2_score": 49,
		"current_estimated_energy_label": "A++",
		"current_estimated_BENG2_score": 63,
		"estimated_gas_usage": 0,
		"estimated_energy_usage": 8135,
		"estimated_city_heating_usage": 0,
		"measures_method": 1,
		"response_meta": null
	}
}

422: Unprocessable Entity

400: Bad Request

301: Moved Permanently

303: See Other House-type error

500: Internal Server Error

401: Unauthorized No access

403: Forbidden Forbidden