Authenticatie, invoer en resultaat

Headers

Name
Type
Description

x-api-key*

string

Unieke API-sleutel van Altum. Maak er een via Mopsus (https://mopsus.altum.ai)

Content-Type*

string

application/json

Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 01-01-2025

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

Request Body

Veld
Type
Toegestane Waarden & Beschrijving

house_type

String

Specificeert het woningtype. Moet een van de volgende zijn: Eengezinswoning, Meergezinswoning, Duplexwoning.

rooms

Array van Objects

Lijst van primaire leefruimtes (slaapkamers, woonkamers) en andere secundaire ruimtes (gangen, etc.).

rooms[].type_of_room

String

'room' voor primaire ruimtes (1 punt/m²) of 'other' voor secundaire ruimtes (0.75 punten/m²).

rooms[].surface_area

Float

Oppervlakte van de ruimte in vierkante meters (m²).

rooms[].shared_addresses

Integer

Aantal adressen dat deze ruimte deelt. 1 voor een privéruimte.

rooms[].heated

Boolean

true als de ruimte wordt verwarmd, anders false.

rooms[].cooled

Boolean

true als de ruimte mechanische koeling heeft, anders false.

rooms[].attic_without_fixed_staircase

Boolean

true als de ruimte een zolder is die alleen via een vlizotrap bereikbaar is. Dit kan leiden tot een puntenaftrek.

kitchen

Array van Objects

Lijst van keukenruimtes.

kitchen[].type_of_room

String

'room' of 'other'. Bepaalt de basiswaarde voor de oppervlaktepunten.

kitchen[].open_kitchen

Boolean

true als het een open keuken is, wat de punten voor verwarming beïnvloedt.

kitchen[].surface_area

Float

Oppervlakte van de keuken in m².

kitchen[].countertop_length

Float

Lengte van het aanrechtblad in meters. Wordt gebruikt om de limiet voor punten van keukenvoorzieningen te bepalen.

kitchen[].shared_addresses

Integer

Aantal adressen dat de keuken deelt. 1 voor privé.

kitchen[].heated

Boolean

true als de keuken wordt verwarmd.

kitchen[].cooled

Boolean

true als de keuken wordt gekoeld.

kitchen[].kitchen_features

Object

Bevat boolean/integer vlaggen voor elke voorziening. 1 voor aanwezig, 0 voor afwezig. Voorzieningen zijn o.a.: 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 van Objects

Lijst van bijbehorende parkeerplaatsen.

parking[].parking_type

Integer

1: Privégarage/carport. 2: Gemeenschappelijke overdekte parkeerplaats. 3: Gemeenschappelijke open parkeerplaats.

parking[].surface_area

Float

Oppervlakte in m². Alleen vereist voor parking_type: 1.

parking[].shared_addresses

Integer

Aantal adressen dat de parkeerplaats deelt.

parking[].charging_station

Boolean

true als er een privé of gedeeld oplaadpunt voor een EV aanwezig is.

sanitary

Array van Objects

Lijst van badkamers of doucheruimtes.

sanitary[].type_of_room

String

'room' of 'other'.

sanitary[].surface_area

Float

Oppervlakte van de sanitaire ruimte in m².

sanitary[].heated

Boolean

true als de ruimte wordt verwarmd.

sanitary[].shower_facility

String

Moet een van de volgende zijn: 'shower', 'bath', 'shower/bath'.

sanitary[].toilet

Integer

Aantal standaard toiletten in deze sanitaire ruimte.

sanitary[].wall_hung_toilet

Integer

Aantal wandclosetten in deze sanitaire ruimte.

sanitary[].shared_addresses

Integer

Aantal adressen dat de ruimte deelt. 1 voor privé.

sanitary[].sanitary_features

Object

Bevat boolean/integer vlaggen voor voorzieningen zoals: 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 van Objects

Lijst van privé of gemeenschappelijke buitenruimtes. Een lege lijst [] resulteert in -5 punten aftrek.

outdoor[].surface_area

Float

Oppervlakte van de buitenruimte in m².

outdoor[].shared_addresses

Integer

Aantal adressen dat de ruimte deelt. 1 voor privé.

toilet

Array van Objects

Lijst van aparte toiletruimtes (niet in een badkamer).

toilet[].type_of_room

String

'room' of 'other'.

toilet[].surface_area

Float

Oppervlakte van de toiletruimte in m².

toilet[].heated

Boolean

true als de ruimte wordt verwarmd.

toilet[].wall_hung_toilet

Boolean

true als het toilet een wandcloset is.

toilet[].washbasin

Integer

Aantal wastafels in de toiletruimte (meestal 0 of 1).

toilet[].shared_addresses

Integer

Aantal adressen dat de ruimte deelt. 1 voor privé.

build_year

Integer

Het bouwjaar van de woning (bijv. 2010).

energy_label

String

Het energielabel. Moet een van de volgende zijn: A++++, A+++, A++, A+, A, B, C, D, E, F, G. Kan een lege string "" zijn indien niet beschikbaar.

energy_index_existence

Boolean

true als er een Energie-Index (EI) waarde beschikbaar is (wordt gebruikt als energy_label leeg is).

energy_index

Float

De numerieke Energie-Index waarde.

energy_performance_compensation

Boolean

true als de woning een energieprestatievergoeding ontvangt.

disability_costs

Float

Totaal gedocumenteerde kosten voor voorzieningen voor mindervaliden.

disabled_people

Integer

Aantal mindervalide personen voor wie de voorzieningen zijn bedoeld.

monument

String

Monumentstatus. Moet een van de volgende zijn: 'national', 'municipal', 'provincial', of een lege string "".

doorbell

Boolean

true als de woning een functionerende deurbel heeft.

woz_value

Float

De officiële WOZ-waarde van de woning in euro's.

woz_valuation_year

Integer

Het peiljaar van de woz_value (bijv. 2023, 2024).

corop_area_amsterdam_or_utrecth

Boolean

true alleen als de woning in het COROP-gebied van Amsterdam of Utrecht ligt en aan andere criteria voldoet voor een specifieke WOZ-rekenuitzondering.

care_home

Boolean

true als de woning deel uitmaakt van een geregistreerde zorginstelling, wat een puntenopslag van 35% activeert.

Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 01-01-2025

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

Request Body

Veld
Type
Toegestane Waarden & Beschrijving

rooms, kitchen, sanitary, toilet, outdoor, parking

Array van Objects

Deze hebben dezelfde structuur en sub-velden als bij Zelfstandige Woonruimte, met toevoeging van het shared_spaces veld.

...[].shared_spaces

Integer

Aantal onzelfstandige wooneenheden (kamers) dat deze specifieke voorziening deelt.

build_year

Integer

Het bouwjaar van het pand.

energy_label

String

Het energielabel van het pand. Moet een van de volgende zijn: A++++, A+++, A++, A+, A, B, C, D, E, F, G, of "".

energy_index_existence

Boolean

true als er een Energie-Index (EI) waarde beschikbaar is.

energy_index

Float

De numerieke Energie-Index waarde.

disability_costs

Float

Kosten voor voorzieningen voor mindervaliden.

disabled_people

Integer

Aantal mindervalide personen voor wie de voorzieningen zijn bedoeld.

monument

String

Monumentstatus. Moet een van de volgende zijn: 'national', 'municipal', 'provincial', of "".

doorbell

Boolean

true als er een deurbel voor de eenheid aanwezig is.

glass_surface_living_room

Float

Oppervlakte van glas (ramen) in de hoofdleefruimte in m². Gebruikt voor puntenaftrek.

lowest_window_frame_living_room

Float

Hoogte van het laagste raamkozijn vanaf de vloer in meters. Gebruikt voor puntenaftrek.

accessibility_via_landlord

Boolean

true als toegang tot de eenheid via een door de verhuurder gecontroleerde ruimte gaat. Leidt tot puntenaftrek.

woz_value

Float

De WOZ-waarde van het gehele pand op het adres.

woz_valuation_year

Integer

Het peiljaar van de woz_value.

usable_surface_area

Float

De totale gebruiksoppervlakte van het gehele pand op het adres in m².

corop_region

String

De COROP-regio waar het pand zich bevindt. Moet een van de volgende zijn (hoofdletterongevoelig): '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 als het pand een geregistreerde zorginstelling is.

Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 01-07-2024

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

Request Body

Block name/General features
Feature
Type
Example

room

type_of_room

string, , mogelijke waarden: '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, mogelijke waarden: 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, mogelijke waarden: 'room', 'other'

'other'

surface_area

float

25, default = 0

heated

boolean

true, default = false

cooled

boolean

true, default = false

shower_facility

string,, mogelijke waarden: ['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, , mogelijke waarden: '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, , mogelijke waarden: 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, , mogelijke waarden: 'eengezinswoning', 'meergezinswoning', 'duplexwoning'

'eengezinswoning'

build_year

integer

energy_label

string, , mogelijke waarden: ['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, mogelijke waarden: "NTA 8800", "NEN 7120", ""

"NTA 8800"

disability_costs

float

1500.2, default = 0

disabled_people

integer

1, default = 1

monument

string, mogelijke waarden: 'national', 'municipal', 'provincial', ' '

'provincial' , default = ' '

doorbell

boolean

true, default = false

woz_value

float

150000, default = 0

woz_valuation_year

integer, mogelijke waarden: 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


{
	"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"
	}
}

Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 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, mogelijke waarden: '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, mogelijke waarden: '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, mogelijke waarden: 'room', 'other'

'other'

surface_area

float

25, default = 0

heated

boolean

true, default = false

cooled

boolean

true, default = false

shower_facility

string, mogelijke waarden: ['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, mogelijke waarden: '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, mogelijke waarden: 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, mogelijke waarden: ['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, mogelijke waarden: 'national', 'municipal', 'provincial', ' '

'provincial' , default = ' '

doorbell

boolean

true, default = false

woz_value

float

150000, default = 0

woz_valuation_year

integer, mogelijke waarden: 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


{
	"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"
	}
}

Haal wws-punten ophalen voor een woonruimte die een zelfstandige woning vormt, op basis van de regels van versie 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, mogelijke waarden: ['Eengezinswoning', 'Meergezinswoning', 'Duplexwoning']

'Eengezinswoning'

building_year

integer

2015

energy_label_available

boolean

true, default = False

energy_label

string, mogelijke waarden: ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']

'A++', default = '' lege tekenreeks

energy_performance_payment

boolean

false, default = False

inner_surface_area

float

78.5, default = 0

validity

string, mogelijke waarden: ['definitive', ‘expired’, ‘estimated’]

'estimated', default = '' lege tekenreeks

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

lijst met sanitaire voorzieningen, mogelijke waarden: ["toilet", "sink", "bath", “bath shower”, “shower”]

['toilet', 'shower'], default = [] lege lijst

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


{
	"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"
	}
}

Haal wws-punten ophalen voor een woonruimte die een niet-zelfstandige woning vormt, op basis van de regels van versie 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, mogelijke waarden: [0, 1, 2, 3, 4, 5, 6, 7]

3, default = 0

toilet

integer, mogelijke waarden: [0, 1, 2, 3, 4]

1, default = 0

shower_bath

integer, mogelijke waarden: [0, 1, 2, 3]

2, default = 0

sink

integer, mogelijke waarden: [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, mogelijke waarden: ['private', 'shared']

'private', default = '' lege tekenreeks

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


{
	"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"
	}
}

Last updated