Authentication, input and response

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

Fetch wws points for a living space that constitutes an independent home, based on rules of version 01-01-2025

POST https://api.altum.ai/wws/01012025

Request Body

Field	Type	Allowed Values & Description
house_type	String	Specifies the dwelling type. Must be one of: Eengezinswoning, Meergezinswoning, Duplexwoning.
rooms	Array of Objects	List of primary living spaces (bedrooms, living rooms) and other secondary spaces (halls, etc.).
rooms[].type_of_room	String	'room' for primary spaces (1 point/m²) or 'other' for secondary spaces (0.75 points/m²).
rooms[].surface_area	Float	Surface area of the space in square meters (m²).
rooms[].shared_addresses	Integer	Number of addresses sharing this space. 1 for a private space.
rooms[].heated	Boolean	true if the space is heated, false otherwise.
rooms[].cooled	Boolean	true if the space has mechanical cooling, false otherwise.
rooms[].attic_without_fixed_staircase	Boolean	true if the space is an attic reachable only by a loft ladder. This can lead to a point deduction.
kitchen	Array of Objects	List of kitchen spaces.
kitchen[].type_of_room	String	'room' or 'other'. Determines the base point value for its surface area.
kitchen[].open_kitchen	Boolean	true if it's an open-plan kitchen, which affects heating points.
kitchen[].surface_area	Float	Surface area of the kitchen in m².
kitchen[].countertop_length	Float	Length of the countertop in meters. Used to determine the cap for feature points.
kitchen[].shared_addresses	Integer	Number of addresses sharing the kitchen. 1 for private.
kitchen[].heated	Boolean	true if the kitchen is heated.
kitchen[].cooled	Boolean	true if the kitchen is cooled.
kitchen[].kitchen_features	Object	Contains boolean/integer flags for each feature. 1 for present, 0 for absent. Features include: extractor_system, induction_hob, ceramic_hob, gas_hob, refrigerator, freezer, oven_electric, oven_gas, microwave, dishwasher, extra_cupboard_space_per_60cm, one_hand_mixer_tap, one_hand_mixer_tap_with_boiling_function, thermostatic_mixer_tap, thermostatic_mixer_tap_with_boiling_function.
parking	Array of Objects	List of associated parking spaces.
parking[].parking_type	Integer	1: Private garage/carport. 2: Communal covered parking. 3: Communal open parking.
parking[].surface_area	Float	Surface area in m². Only required for parking_type: 1.
parking[].shared_addresses	Integer	Number of addresses sharing the parking space.
parking[].charging_station	Boolean	true if a private or shared EV charging station is provided.
sanitary	Array of Objects	List of bathrooms/shower rooms.
sanitary[].type_of_room	String	'room' or 'other'.
sanitary[].surface_area	Float	Surface area of the sanitary space in m².
sanitary[].heated	Boolean	true if the space is heated.
sanitary[].shower_facility	String	Must be one of: 'shower', 'bath', 'shower/bath'.
sanitary[].toilet	Integer	Count of standard toilets within this sanitary space.
sanitary[].wall_hung_toilet	Integer	Count of wall-hung toilets within this sanitary space.
sanitary[].shared_addresses	Integer	Number of addresses sharing the space. 1 for private.
sanitary[].sanitary_features	Object	Contains boolean/integer flags for features like: washbasin, multi_person_washbasin, cupboard_space, power_outlet, build_in_cupboard, complete_separation_of_shower, bath_with_bubble_function, one_hand_mixer_tap, thermostatic_mixer_tap, towel_radiator.
outdoor	Array of Objects	List of private or communal outdoor spaces. An empty list [] results in a -5 point deduction.
outdoor[].surface_area	Float	Surface area of the outdoor space in m².
outdoor[].shared_addresses	Integer	Number of addresses sharing the space. 1 for private.
toilet	Array of Objects	List of separate toilet rooms (not inside a bathroom).
toilet[].type_of_room	String	'room' or 'other'.
toilet[].surface_area	Float	Surface area of the toilet room in m².
toilet[].heated	Boolean	true if the room is heated.
toilet[].wall_hung_toilet	Boolean	true if the toilet is a wall-hung model.
toilet[].washbasin	Integer	Count of washbasins in the toilet room (usually 0 or 1).
toilet[].shared_addresses	Integer	Number of addresses sharing the room. 1 for private.
build_year	Integer	The year the dwelling was constructed (e.g., 2010).
energy_label	String	The energy label. Must be one of: A++++, A+++, A++, A+, A, B, C, D, E, F, G. Can be an empty string "" if not available.
energy_index_existence	Boolean	true if an Energy Index (EI) value is available (used as a fallback if energy_label is empty).
energy_index	Float	The numerical Energy Index value.
energy_performance_compensation	Boolean	true if the dwelling receives a specific energy performance compensation payment.
disability_costs	Float	Total documented costs spent on facilities for disabled persons.
disabled_people	Integer	Number of disabled persons for whom the facilities are intended.
monument	String	Monument status. Must be one of: 'national', 'municipal', 'provincial', or an empty string "".
doorbell	Boolean	true if the dwelling has a functioning doorbell.
woz_value	Float	The official WOZ value of the dwelling in Euros.
woz_valuation_year	Integer	The reference year for the woz_value (e.g., 2023, 2024).
corop_area_amsterdam_or_utrecth	Boolean	true only if the dwelling is in the COROP area of Amsterdam or Utrecht and meets other criteria for a specific WOZ calculation exception.
care_home	Boolean	true if the dwelling is part of a registered care home, which triggers a 35% point surcharge.

Fetch wws points for a living space that constitutes an non-independent home, based on rules of version 01-01-2025

POST https://api.altum.ai/wws/non/01012025

Request Body

Field	Type	Allowed Values & Description
rooms, kitchen, sanitary, toilet, outdoor, parking	Array of Objects	These have the same structure and sub-fields as the Independent Home inputs, with the addition of the shared_spaces field.
...[].shared_spaces	Integer	Number of non-independent living units (rooms) that share this specific facility.
build_year	Integer	The year the property was constructed.
energy_label	String	The energy label of the property. Must be one of: A++++, A+++, A++, A+, A, B, C, D, E, F, G, or "".
energy_index_existence	Boolean	true if an Energy Index (EI) value is available.
energy_index	Float	The numerical Energy Index value.
disability_costs	Float	Costs for facilities for disabled persons.
disabled_people	Integer	Number of disabled people the facilities are for.
monument	String	Monument status. Must be one of: 'national', 'municipal', 'provincial', or "".
doorbell	Boolean	true if a doorbell is present for the unit.
glass_surface_living_room	Float	Surface area of glass (windows) in the main living room in m². Used for point deductions.
lowest_window_frame_living_room	Float	Height of the lowest window frame from the floor in meters. Used for point deductions.
accessibility_via_landlord	Boolean	true if access to the unit requires passing through an area controlled by the landlord. Leads to a point deduction.
woz_value	Float	The WOZ value of the entire property at the address.
woz_valuation_year	Integer	The reference year for the woz_value.
usable_surface_area	Float	The total usable surface area of the entire property at the address in m².
corop_region	String	The COROP region where the property is located. Must be one of the following (case-insensitive): 'east groningen', 'delfzijl and surroundings', 'other groningen', 'north friesland', 'southwest friesland', 'southeast friesland', 'north drenthe', 'southeast drenthe', 'southwest drenthe', 'north overijssel', 'southwest overijssel', 'twente', 'veluwe', 'back corner', 'arnhem/nijmegen', 'southwest gelderland', 'utrecht', 'head of north holland', 'alkmaar and surroundings', 'ijmond', 'haarlem agglomeration', 'zaan region', 'greater amsterdam', 'the gooi and vecht region', 'leiden and bulb region agglomeration', 'agglomeration of the hague', 'delft westland', 'east south holland', 'greater rhine estuary', 'southeast south holland', 'zeelandic flanders', 'other zeeland', 'west north brabant', 'central north brabant', 'northeast north brabant', 'southeast north brabant', 'north limburg', 'central limburg', 'south limburg', 'flevoland'.
care_home	Boolean	true if the property is a registered care home.

Fetch wws points for a living space that constitutes an independent home, based on rules of version 01-07-2024

POST https://api.altum.ai/wws/01072024

Request Body

Block name/General features	Feature	Type	Example
room	type_of_room	string, possible values: 'room', 'other'	'room'
	attic_without_fixed_staircase	boolean	true, default = false
	surface_area	float	12.3, default = 0
	shared_addresses	integer	2, default = 1
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
kitchen	type_of_room	string, possible values: 'room', 'other'	'other'
	open_kitchen	boolean	true
	surface_area	float	24, default = 0
	countertop_length	float	12.5
	shared_addresses	boolean	2, default = 1
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	kitchen_features:
	extractor_system	integer	1, defaults = 0
	induction_hob	integer	3, defaults = 0
	ceramic_hob	integer	2, defaults = 0
	gas_hob	integer	1, defaults = 0
	refrigerator	integer	0, defaults = 0
	freezer	integer	2, defaults = 0
	oven_electric	integer	0, default = 0
	oven_gas	integer	2, defaults = 0
	microwave	integer	5, default = 0
	dishwasher	integer	1, default = 0
	extra_cupboard_space_per_60cm	integer	2, defaults = 0
	one_hand_mixer_tap	integer	3, defaults = 0
	one_hand_mixer_tap_with_boiling_function	integer	4, defaults = 0
	thermostatic_mixer_tap	integer	1, defaults = 0
	thermostatic_mixer_tap_with_boiling_function	integer	2, defaults = 0
sanitary	type_of_room	string, possible values: 'room', 'other'	'other'
	surface_area	float	25, default = 0
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	shower_facility	string, possible values: ['bath', 'shower/bath', 'shower']	'bath'
	toilet	integer	2, default = 0
	wall_hung_toilet	integer	1, default = 0
	shared_addresses	integer	3, default = 1
	sanitary_features:
	washbasin	integer	1, default = 0
	multi_person_washbasin	integer	0, default = 0
	cupboard_space	boolean	true, default = false
	power_outlet	integer	3, default = 0
	build_in_cupboard	integer	4, default = 0
	complete_separation_of_shower	integer	1, default = 0
	bath_with_bubble_function	integer	0, default = 0
	one_hand_mixer_tap	integer	2, default = 0
	thermostatic_mixer_tap	integer	1, default = 0
	towel_radiator	integer	4, default = 0
toilet	type_of_room	string, possible values: 'room', 'other'	'room'
	surface_area	float	12, default = 0
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	wall_hung_toilet	boolean	true, default = false
	washbasin	integer	2, default = 0
	shared_addresses	integer	2, default = 1
parking	parking_type	integer, possible values: 1, 2, 3	2, default = 0
	surface_area	float	12, default = 0
	shared_addresses	integer	2, default = 1
	charging_station	boolean	true, default = false
outdoor	surface_area	float	32.5, default = 0
	shared_addresses	integer	3, default = 1
house_type		string, possible values: 'eengezinswoning', 'meergezinswoning', 'duplexwoning'	'eengezinswoning'
build_year		integer
energy_label		string, possible values: ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']	'A', default = ' '
energy_index_existence		boolean	true, default = false
energy_index		float	default
energy_performance_compensation		float	0.5, default = 0
energy_valuation_date		string	'01022022'
energy_label_type		string, possible values: "NTA 8800", "NEN 7120", ""	"NTA 8800"
disability_costs		float	1500.2, default = 0
disabled_people		integer	1, default = 1
monument		string, possible values: 'national', 'municipal', 'provincial', ' '	'provincial' , default = ' '
doorbell		boolean	true, default = false
woz_value		float	150000, default = 0
woz_valuation_year		integer, possible values: 2022, 2023	2022
usable_surface_area		float	12.5, default = 0
corop_area_amsterdam_or_utrecth		boolean	true, default = false
care_home		boolean	true, default = false

200: OK Successful response

{
	"total_wws_points": "220",
	"points_per_component": {
		"inner_surface_area": "85.0",
		"heating_cooling": "21.0",
		"energy": "11",
		"kitchen": "22",
		"sanitary": "35.25",
		"disabilities": "4.52",
		"outdoor": "-5",
		"shared_parking": "4.5",
		"woz": "40",
		"special_provisions": "1.25"
	}
}

400: Bad Request Unsuccessful response

422: Unprocessable Entity Wrong input format

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden

Fetch wws points for a living space that constitutes a non-independent home, based on rules of version 01-07-2024

POST https://api.altum.ai/wws/non/01072024

Request Body

Block name/General features	Feature	Type	Example
room	type_of_room	string, possible values: 'room', 'other'	'room'
	attic_without_fixed_staircase	boolean	true, default = false
	surface_area	float	12.3, default = 0
	shared_addresses	integer	2, default = 1
	shared_spaces	integer	2, default = 1
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
kitchen	type_of_room	string, possible values: 'room', 'other'	'other'
	open_kitchen	boolean	true
	surface_area	float	24, default = 0
	countertop_length	float	12.5
	shared_addresses	integer	2, default = 1
	shared_spaces	integer	2, default = 1
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	kitchen_features:
	extractor_system	integer	1, defaults = 0
	induction_hob	integer	3, defaults = 0
	ceramic_hob	integer	2, defaults = 0
	gas_hob	integer	1, defaults = 0
	refrigerator	integer	0, defaults = 0
	freezer	integer	2, defaults = 0
	oven_electric	integer	0, default = 0
	oven_gas	integer	2, defaults = 0
	microwave	integer	5, default = 0
	dishwasher	integer	1, default = 0
	extra_cupboard_space_per_60cm	integer	2, defaults = 0
	one_hand_mixer_tap	integer	3, defaults = 0
	one_hand_mixer_tap_with_boiling_function	integer	4, defaults = 0
	thermostatic_mixer_tap	integer	1, defaults = 0
	thermostatic_mixer_tap_with_boiling_function	integer	2, defaults = 0
sanitary	type_of_room	string, possible values: 'room', 'other'	'other'
	surface_area	float	25, default = 0
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	shower_facility	string, possible values: ['bath', 'shower/bath', 'shower']	'bath'
	toilet	integer	2, default = 0
	wall_hung_toilet	integer	1, default = 0
	shared_addresses	integer	3, default = 1
	shared_spaces	integer	2, default = 1
	sanitary_features:
	washbasin	integer	1, default = 0
	multi_person_washbasin	integer	0, default = 0
	cupboard_space	boolean	true, default = false
	power_outlet	integer	3, default = 0
	build_in_cupboard	integer	4, default = 0
	complete_separation_of_shower	integer	1, default = 0
	bath_with_bubble_function	integer	0, default = 0
	one_hand_mixer_tap	integer	2, default = 0
	thermostatic_mixer_tap	integer	1, default = 0
	towel_radiator	integer	4, default = 0
toilet	type_of_room	string, possible values: 'room', 'other'	'room'
	surface_area	float	12, default = 0
	heated	boolean	true, default = false
	cooled	boolean	true, default = false
	wall_hung_toilet	boolean	true, default = false
	washbasin	integer	2, default = 0
	shared_addresses	integer	2, default = 1
	shared_spaces	integer	3, default = 1
parking	parking_type	integer, possible values: 1, 2, 3	2, default = 0
	surface_area	float	12, default = 0
	shared_addresses	integer	2, default = 1
	shared_spaces	integer	2, default = 1
	charging_station	boolean	true, default = false
outdoor	surface_area	float	32.5, default = 0
	shared_addresses	integer	3, default = 1
	shared_spaces	integer	2, default = 1
build_year		integer
energy_label		string, possible values: ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']	'A', default = ' '
energy_index_existence		boolean	true, default = false
energy_index		float	default
disability_costs		float	1500.2, default = 0
disabled_people		integer	1, default = 1
monument		string, possible values: 'national', 'municipal', 'provincial', ' '	'provincial' , default = ' '
doorbell		boolean	true, default = false
woz_value		float	150000, default = 0
woz_valuation_year		integer, possible values: 2021, 2022, 2023	2022
usable_surface_area		float	12.5, default = 0
corop_region		boolean	true, default = false
care_home		boolean	true, default = false
glass_surface_living_room		float	1.8, default = 0.75
lowest_window_frame_living_room		float	2.4, default = 1.6
accessibility_via_landlord		boolean	true, default = false

200: OK Successful response

{
	"total_wws_points": "390",
	"points_per_component": {
		"inner_surface_area": "117.5",
		"heating_cooling": "9.0",
		"energy": "79.62",
		"kitchen": "14",
		"sanitary": "28.25",
		"disabilities": "4.52",
		"outdoor": "15",
		"shared_parking": "2.0",
		"woz": "14",
		"special_provisions": "110.28",
		"deductions": "-4"
	}
}

400: Bad Request Unsuccessful response

422: Unprocessable Entity Wrong input format

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden

Fetch wws points for a living space that constitutes an independent home, based on rules of version 01-01-2024

POST https://api.altum.ai/wws/01012024

Request Body

Name	Type	Example
living_area_m2	float	125.0, default = 0
toilet_installed_in_bathroom_or_shower	boolean	true, default = False
surface_area_other_spaces	float	128.0, default = 0
attic_space_area	float	12.3, default = 0
fixed_staircase	boolean	false, default = False
no_of_heated_rooms	integer	2, default = 0
no_of_other_rooms	integer	3, default = 0
no_of_rooms_heat_as_service_cost	integer	0, default = 0
house_type	string, possible values: ['Eengezinswoning', 'Meergezinswoning', 'Duplexwoning']	'Eengezinswoning'
building_year	integer	2015
energy_label_available	boolean	true, default = False
energy_label	string, possible values: ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']	'A++', default = '' empty string
energy_performance_payment	boolean	false, default = False
inner_surface_area	float	78.5, defaul = 0
validity	string, possible values: ['definitive', ‘expired’, ‘estimated’]	'estimated', default = '' empty string
countertop_with_base_cabinets	boolean	true, default = False
countertop_lenght	float	2, defaults = 0
investment_for_kitchen_extra_quality	float	15000, defaul = 0
sanitary_facilities	boolean
list_sanitary_facilities	list of sanitary facilties, possible values: ["toilet", "sink", "bath", “bath shower”, “shower”]	['toilet', 'shower'], default = [] empty list
investment_for_bath_extra_quality	float	0, defaults = 0
investment_for_shower_extra_quality	float	6000, default = 0
investment_for_bath_shower_extra_quality	float	0, default = 0
facilities_for_disabled	boolean	true, default = False
costs_spent_for_facilities_for_disabled	float	15000, default = 0
private_outdoor_space_m2	float	15, default = 0
carport	boolean	false, default = False
extra_quality_above_100m2	boolean	false, default = False
renovation_expenses	float	15000, default = 0
renovation_year	integer	2015, default = 0
monument	boolean	true, default = False

200: OK Successful response

{
	"total_wws_points": "537.3",
	"points_per_component": {
		"1_area_of_rooms": "125",
		"2_surface_area_other_spaces": "48.8",
		"3_heating": "4",
		"4_energy_label": "68",
		"5_kitchen": "14",
		"6_sanitary_facilities": "16",
		"7_facilities_for_disables": "66.1",
		"8_private_outdoor_spaces": "14",
		"9_woz_value": "6.8",
		"10_renovation": "0",
		"11_special_facilities": "124.6",
		"12_monument": "50"
	}
}

400: Bad Request Unsuccessful response

422: Unprocessable Entity Wrong input format

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden

Fetch wws points for a living space that constitutes a non-independent home, based on rules of version 01-01-2024

POST https://api.altum.ai/wws/non/01012024

Name	Type	Example
area_of_rooms_m2	float	128, default = 0
other_surface_area_m2	float	126, default = 0
number_of_living_spaces	integer	2, default = 0
central_heating	boolean	false, default = False
heated_rooms_m2	float	12, default = 0
gas_connection	boolean	true, default = False
flue_gas_discharge_duct	boolean	false, default = False
chimney	boolean	true, default = False
kitchen	integer, possible values: [0, 1, 2, 3, 4, 5, 6, 7]	3, default = 0
toilet	integer, possible values: [0, 1, 2, 3, 4]	1, default = 0
shower_bath	integer, possible values: [0, 1, 2, 3]	2, default = 0
sink	integer, possible values: [0, 1, 2, 3]	3, default = 0
thermostatic_control_knobs	boolean	true, default = False
outdoor_space_m2	float	32, default = 0
outdoor_area_for_shared_use_m2	float	12, default = 0
bicycle_shed	string, possible values: ['private', 'shared']	'private', default = '' empty string
living_sleeping_area_m2	float	12, default = 0
through_others_room	boolean	true, default = False
window_area_main_living_room	float	10, default = 0
lowest_window_frame_height_m	float	2, default = 0
facade_wall	boolean	true, default = False
severe_nuisance	boolean	false, default = False
living_room_floor_number	integer	6, default = 0
elevator_existence	boolean	true, default = False
hot_meal_preparation_allowed	boolean	true, default = False
monument	boolean	false, default = False

200: OK Successful response

{
	"total_wws_points": "790.7",
	"points_per_component": {
		"1_area_of_rooms": "694.2",
		"2_heating_options": "3",
		"3_cooking_facilities": "20",
		"4_toilet": "0",
		"5_washing_facilities": "13",
		"6_quality_factors": "10.5",
		"7_monument": "50"
	}
}

400: Bad Request Unsuccessful response

422: Unprocessable Entity Wrong input format

500: Internal Server Error Service is not available and/or down

403: Forbidden Forbidden