Authentication, input and response
Request a sustainability advice based on address.
POST https://api.altum.ai/v2/sustainability
This endpoint allows you to receive response from the Altum AI Sustainability API regarding sustainability and the Ecovalue, using the post code, house number and house addition.
Headers
Content-Type
string
application/json
x-api-key*
string
Unique API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Request Body
postcode*
string
zip code in six character format e.g. 1234AB
housenumber*
integer
house number of the object e.g. 1
houseaddition
string
addition to the house number e.g. A
build_year
integer
build year of the property
roof_type
integer
1 = (mostly) sloped roof
2 = (mostly) flat roof
3 = part sloped, part flat roof
inner_surface_area
float
square meter surface area
house_type
integer
1 = vrijstaande woning
2 = 2-onder-1-kapwoning
3 = hoekwoning
4 = tussenwoning
cooling
integer
Is there a cooling system present?
1 = No cooling
2 = Air conditioning unit, direct air cooling
Default
1
electric_cooking
integer
What is used for cooking?
1 = Gas stove
2 = Electric stove
2 if Installation in [6,7],
Else 1
inhabitants
integer
number of people living in the house
gas_usage
float
overwrites estimated yearly gas consumption in m3
heat_usage
float
overwrites specified yearly heat consumption in GJ.
electricity_usage
float
overwrites specified yearly electricity consumption in KWh
electricity_generation
float
total yearly electricity yield of solar panels in kWh.
Net usage = consumption - yield
minimum_solar_panels
integer
The minimum number of new panels to be placed
search_criteria
integer
1 = lowest investment costs
2 = lowest energy costs
3 = highest return on investment
4 = lowest beng2 (highest label)
3
target_label
string
desired target energy label - default is energy label A or D
max_investment
integer
maximum investment, use 0 for unlimited
natural_gas
integer
1 = no filter 2 = natural gas mandatory 3 = natural gas free
heat_pump_allowed
boolean
0 = not allowed
1 = allowed
0
district_heating_allowed
boolean
0 = not allowed
1 = allowed
0
heatpump_insulation_req
integer
1 = no minimum requirement
2 = envelope, including glass min 2
3 = house meets “standaard”
3
lock_measures
array
lock measures excluded from calculation
exclude_measure
array
NOT YET
excluda_vat
boolean
Prices are with or without VAT included.
0 = VAT included
1 = VAT excluded
0
cost_indicators
see
fetch_definitive_label
integer
activate fetching of definitive label from EP-online with 1
0
eco_delta
boolean
disable fetching of ecovalue with 0
1
replace_windowframes
activate extra costs for glass related codes with 1, see PDF cost table NOT YET
0
{
"address": {
"postcode": "2771DS",
"housenumber": 87,
"houseaddition": null,
"street": "Zuidkade",
"city": "Boskoop",
"location": {
"lat": 52.06839381665532,
"lon": 4.6580852694533394
}
},
"building": {
"build_year": 1961,
"inner_surface": 131.0,
"floor_surface": 97.0,
"flat_roof_surface": 0,
"pitched_roof_surface": 124.4,
"wall_surface": 150.7,
"glass_living_room_surface": 24.9,
"glass_bedrooms_surface": 6.9,
"type": "vrijstaand"
},
"label": {
"current": "G",
"potential": "A++++"
},
"provided_label": {
"temporary": "F",
"definitive": "C",
"definitive_type": null,
"definitive_validity": null
},
"BENG1": {
"current": 165,
"potential": 139
},
"BENG2": {
"current": 422,
"potential": -1
},
"meta": null,
"energyindex": {
"current": null,
"potential": null
},
"ELG": {
"current": null,
"potential": null
},
"comfortscore": {
"current": 1,
"potential": 3
},
"CO2": {
"current": 10632,
"potential": 2564
},
"financial": {
"total_investment": 67638.64,
"total_saving": 8119.28,
"months_to_pay_off": 99,
"eco_value": null,
"savings_monthly": 677,
"energy_cost_monthly": 681,
"loan": {
"monthly_payment": 280.0
}
},
"usage": {
"gas": 6059,
"energy": 4077,
"city_heating": 0
},
"usage_potential": {
"gas": 0,
"energy": 903,
"city_heating": 0
},
"energy_prices": {
"variable_gas_price": 1.144,
"variable_electricity_price": 0.293,
"solarpanel_watt_peak_per_m2": 212
},
"measures": {
"wall_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 2
},
"after": {
"desc": "Geen",
"value": 0,
"points": 2
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"floor_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 0
},
"after": {
"desc": "Goed",
"value": 2,
"points": 7
},
"investment": 2865.38,
"saving": 1426,
"co2_reduce": 2223,
"BENG2": "20.8%",
"gas_savings": 1205,
"electricity_savings": 161
},
"roof_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 0
},
"after": {
"desc": "Goed",
"value": 2,
"points": 3
},
"investment": 12441.24,
"saving": 1928,
"co2_reduce": 3005,
"BENG2": "28.1%",
"gas_savings": 1629,
"electricity_savings": 218
},
"living_room_windows": {
"before": {
"desc": "Dubbel glas",
"value": 1,
"points": 1
},
"after": {
"desc": "Dubbel glas",
"value": 1,
"points": 1
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"bedroom_windows": {
"before": {
"desc": "Dubbel glas",
"value": 1,
"points": null
},
"after": {
"desc": "Dubbel glas",
"value": 1,
"points": null
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"ventilation": {
"before": {
"desc": "Natuurlijk",
"value": 0,
"points": 0
},
"after": {
"desc": "Natuurlijk",
"value": 0,
"points": 0
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"solar_panels": {
"before": {
"desc": "0",
"value": 0,
"points": null
},
"after": {
"desc": "59",
"value": 59,
"points": null
},
"investment": 21849.7,
"saving": 3279,
"co2_reduce": 3705,
"BENG2": "19%",
"gas_savings": 0,
"electricity_savings": 11192
},
"instalation": {
"before": {
"desc": "HR-combi",
"value": 4,
"points": 15
},
"after": {
"desc": "WP bodem combi",
"value": 7,
"points": 20
},
"investment": 29686.14,
"saving": 2665,
"co2_reduce": 4254,
"BENG2": "64.0%",
"gas_savings": 6059,
"electricity_savings": -15438
},
"shower": {
"before": {
"desc": "Geen Douche WTW",
"value": 0,
"points": null
},
"after": {
"desc": "Douche WTW",
"value": 1,
"points": null
},
"investment": 796.18,
"saving": 93,
"co2_reduce": 146,
"BENG2": "0.4%",
"gas_savings": 82,
"electricity_savings": 0
}
},
"response_meta": null
}Request a sustainability advice based on BagID. TBA
POST https://api.altum.ai/v2/sustainability/bag
This endpoint allows you to receive response from the Altum AI Sustainability API regarding sustainability and the Ecovalue, using the bag id of the object instead of the post code, house number and house addition.
Headers
Content-Type
string
application/json
x-api-key*
string
API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Request Body
bag_id*
string
16 digits BAG_ID
build_year
integer
build year of the property
roof_type
integer
1 = (mostly) sloped roof
2 = (mostly) flat roof
3 = part sloped, part flat roof
inner_surface_area
float
square meter surface area
house_type
integer
1 = vrijstaande woning
2 = 2-onder-1-kapwoning
3 = hoekwoning
4 = tussenwoning
cooling
integer
Is there a cooling system present?
1 = No cooling
2 = Air conditioning unit, direct air cooling
Default
1
electric_cooking
integer
What is used for cooking?
1 = Gas stove
2 = Electric stove
2 if Installation in [6,7],
Else 1
inhabitants
integer
number of people living in the house
gas_usage
float
overwrites estimated yearly gas consumption in m3
heat_usage
float
overwrites specified yearly heat consumption in GJ.
electricity_usage
float
overwrites specified yearly electricity consumption in KWh
electricity_generation
float
total yearly electricity yield of solar panels in kWh.
Net usage = consumption - yield
minimum_solar_panels
integer
The minimum number of new panels to be placed
search_criteria
integer
1 = lowest investment costs
2 = lowest energy costs
3 = highest return on investment
4 = lowest beng2 (highest label)
3
target_label
string
desired target energy label - default is energy label A or D
max_investment
integer
maximum investment, use 0 for unlimited
natural_gas
integer
1 = no filter 2 = natural gas mandatory 3 = natural gas free
heat_pump_allowed
boolean
0 = not allowed
1 = allowed
0
district_heating_allowed
boolean
0 = not allowed
1 = allowed
0
heatpump_insulation_req
integer
1 = no minimum requirement
2 = envelope, including glass min 2
3 = house meets “standaard”
3
lock_measures
array
lock measures excluded from calculation
exclude_measure
array
NOT YET
excluda_vat
boolean
Prices are with or without VAT included.
0 = VAT included
1 = VAT excluded
0
cost_indicators
see
fetch_definitive_label
integer
activate fetching of definitive label from EP-online with 1
0
eco_delta
boolean
disable fetching of ecovalue with 0
1
replace_windowframes
activate extra costs for glass related codes with 1, see PDF cost table NOT YET
0
{
"address": {
"postcode": "2771DS",
"housenumber": 87,
"houseaddition": null,
"street": "Zuidkade",
"city": "Boskoop",
"location": {
"lat": 52.06839381665532,
"lon": 4.6580852694533394
}
},
"building": {
"build_year": 1961,
"inner_surface": 131.0,
"floor_surface": 97.0,
"flat_roof_surface": 0,
"pitched_roof_surface": 124.4,
"wall_surface": 150.7,
"glass_living_room_surface": 24.9,
"glass_bedrooms_surface": 6.9,
"type": "vrijstaand"
},
"label": {
"current": "G",
"potential": "A++++"
},
"provided_label": {
"temporary": "F",
"definitive": "C",
"definitive_type": null,
"definitive_validity": null
},
"BENG1": {
"current": 165,
"potential": 139
},
"BENG2": {
"current": 422,
"potential": -1
},
"meta": null,
"energyindex": {
"current": null,
"potential": null
},
"ELG": {
"current": null,
"potential": null
},
"comfortscore": {
"current": 1,
"potential": 3
},
"CO2": {
"current": 10632,
"potential": 2564
},
"financial": {
"total_investment": 67638.64,
"total_saving": 8119.28,
"months_to_pay_off": 99,
"eco_value": null,
"savings_monthly": 677,
"energy_cost_monthly": 681,
"loan": {
"monthly_payment": 280.0
}
},
"usage": {
"gas": 6059,
"energy": 4077,
"city_heating": 0
},
"usage_potential": {
"gas": 0,
"energy": 903,
"city_heating": 0
},
"energy_prices": {
"variable_gas_price": 1.144,
"variable_electricity_price": 0.293,
"solarpanel_watt_peak_per_m2": 212
},
"measures": {
"wall_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 2
},
"after": {
"desc": "Geen",
"value": 0,
"points": 2
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"floor_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 0
},
"after": {
"desc": "Goed",
"value": 2,
"points": 7
},
"investment": 2865.38,
"saving": 1426,
"co2_reduce": 2223,
"BENG2": "20.8%",
"gas_savings": 1205,
"electricity_savings": 161
},
"roof_insulation": {
"before": {
"desc": "Geen",
"value": 0,
"points": 0
},
"after": {
"desc": "Goed",
"value": 2,
"points": 3
},
"investment": 12441.24,
"saving": 1928,
"co2_reduce": 3005,
"BENG2": "28.1%",
"gas_savings": 1629,
"electricity_savings": 218
},
"living_room_windows": {
"before": {
"desc": "Dubbel glas",
"value": 1,
"points": 1
},
"after": {
"desc": "Dubbel glas",
"value": 1,
"points": 1
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"bedroom_windows": {
"before": {
"desc": "Dubbel glas",
"value": 1,
"points": null
},
"after": {
"desc": "Dubbel glas",
"value": 1,
"points": null
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"ventilation": {
"before": {
"desc": "Natuurlijk",
"value": 0,
"points": 0
},
"after": {
"desc": "Natuurlijk",
"value": 0,
"points": 0
},
"investment": 0.0,
"saving": 0,
"co2_reduce": 0,
"BENG2": "0%",
"gas_savings": 0,
"electricity_savings": 0
},
"solar_panels": {
"before": {
"desc": "0",
"value": 0,
"points": null
},
"after": {
"desc": "59",
"value": 59,
"points": null
},
"investment": 21849.7,
"saving": 3279,
"co2_reduce": 3705,
"BENG2": "19%",
"gas_savings": 0,
"electricity_savings": 11192
},
"instalation": {
"before": {
"desc": "HR-combi",
"value": 4,
"points": 15
},
"after": {
"desc": "WP bodem combi",
"value": 7,
"points": 20
},
"investment": 29686.14,
"saving": 2665,
"co2_reduce": 4254,
"BENG2": "64.0%",
"gas_savings": 6059,
"electricity_savings": -15438
},
"shower": {
"before": {
"desc": "Geen Douche WTW",
"value": 0,
"points": null
},
"after": {
"desc": "Douche WTW",
"value": 1,
"points": null
},
"investment": 796.18,
"saving": 93,
"co2_reduce": 146,
"BENG2": "0.4%",
"gas_savings": 82,
"electricity_savings": 0
}
},
"response_meta": null
}Request body
Example requests
{
"post_code": "2771DS",
"house_number": "87",
"target_label": "A++++",
"eco_delta": 0
}{
"bag_id": "0637010000264937",
"target_label": "A++++",
"eco_delta": 0
}Last updated