# 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 |
{% tabs %}
{% tab title="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"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
Examples:
{
"detail": "The type_of_room in rooms features should have one of the following values: ['other', 'room']."
}
{
"detail": [
{
"loc": [
"body",
"sanitary",
0,
"shower_facility"
],
"msg": "The shower_facility must be one of ['shower', 'bath', 'shower/bath']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": " NTA c8800 in not an accepted energy_label_type. Please provide a energy_label_type from the list: ['NTA 8800', 'NEN 7120', '']",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## 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 |
{% tabs %}
{% tab title="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"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
{
"detail": [
{
"loc": [
"body",
"outdoor",
0,
"shared_addresses"
],
"msg": "ensure this value is greater than 0",
"type": "value_error.number.not_gt",
"ctx": {
"limit_value": 0
}
},
{
"loc": [
"body",
"energy_label"
],
"msg": "The energy_label must be one of ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']",
"type": "value_error"
},
{
"loc": [
"body",
"disabled_people"
],
"msg": "ensure this value is greater than 0",
"type": "value_error.number.not_gt",
"ctx": {
"limit_value": 0
}
},
{
"loc": [
"body",
"woz_valuation_year"
],
"msg": "woz_valuation_year must be 2021, 2022, or 2023",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## 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 |
{% tabs %}
{% tab title="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"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
Examples:
{
"detail": [
{
"loc": [
"body",
"source"
],
"msg": "unexpected value; permitted: 0, 1",
"type": "value_error.const",
"ctx": {
"given": 2,
"permitted": [
0,
1
]
}
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The energy_label must be one of ['A++++', 'A+++', 'A++', 'A+', 'A', 'B', 'C', 'D', 'E', 'F', 'G']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "If sanitary_facilities is True, list_sanitary_facilities cannot be an empty list. Please provide a list with the sanitary facilities",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"list_sanitary_facilities",
0
],
"msg": "The word 'TOILfET' is not spelled correctly, or it is not in the acceptable sanitary facilities. Choose between ['toilet', 'sink', 'bath', 'shower', 'bath shower']",
"type": "value_error"
},
{
"loc": [
"body",
"__root__"
],
"msg": "If sanitary_facilities is True, list_sanitary_facilities cannot be an empty list. Please provide a list with the sanitary facilities",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}
## 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 |
{% tabs %}
{% tab title="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"
}
}
```
{% endtab %}
{% tab title="400: Bad Request Unsuccessful response" %}
```
{
"We are not able to provide points at the moment."
}
```
{% endtab %}
{% tab title="422: Unprocessable Entity Wrong input format" %}
```
Examples:
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The sink must be one of ['private', 'shared']",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The toilet must be one of [0, 1, 2, 3, 4]",
"type": "value_error"
}
]
}
{
"detail": [
{
"loc": [
"body",
"__root__"
],
"msg": "The shower_bath must be one of [0, 1, 2, 3]",
"type": "value_error"
}
]
}
```
{% endtab %}
{% tab title="500: Internal Server Error Service is not available and/or down" %}
```
{
"message": "Internal server error"
}
```
{% endtab %}
{% tab title="403: Forbidden Forbidden" %}
```
{
"message": "Missing Authentication Token"
}
```
{% endtab %}
{% endtabs %}