Authentication, input and response
Request a sustainability advice based on address.
POST
https://api.altum.ai/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
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
x-api-key* | string | API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai) |
Request Body
Name | Type | Description |
---|---|---|
post_code* | string | zip code in six character format e.g. 1234AB |
house_number* | integer | house number of the object e.g. 1 |
house_addition | string | addition to the house number e.g. A |
inner_surface_area | integer | square meter surface area |
build_year | integer | build year of the property |
target_label | string | desired target energy label - default is energy label A |
installation | integer | current installation - see measures |
ventilation | integer | current ventilation - see measures |
shower | integer | current shower WTW - see measures |
solar_panels | integer | current solar panels in m2 (default) or total watt-peak capacitity in W (see watt_panels) - see measures |
house_type | integer | current house-type: 1:semi-detached, 2:corner house, 3:terraced house, 4:detached house and 5:apartment* (*service doesn't return measures for an apartment.) |
lock_measures | array | lock measures excluded from calculation |
watt_panels | integer | assume solar_panels input is in W (0) or m2 (1). Default = 1 |
max_investment | integer | maximum investment, use 0 for unlimited |
electricity_usage | integer | input current electricity usage |
heat_usage | integer | input current heat usage |
gas_usage | integer | if used overwrites estimated gas usage |
search_criteria | integer | 0 = Lowest investment costs, 1 = Lowest energy costs, 2 = highest financial return on investment, 3 = highest BARe |
heat_pump_allowed | boolean | allowed or not allowed to advice to implement a heat pump |
replace_boiler | boolean | allowed or not allowed to replace the boiler installation |
inhabitants | integer | number of people living in the house |
natural_gas | integer | 0 = Natural gas allowed, 1 = Natural gas required, 2 = Natural gas not allowed |
solar_panels_surface | integer | 0 = No panels, 1 = Maximum half of the available space, 2 = Fully covered |
heatpump_insulation_req | integer | 0 till 3 defined the minium insulation requirement for advice of a heat pump |
fetch_definitive_label | integer | activate fetching of definitive label at EP-online with 1, default is 0 |
energylabel_strict | integer | enable strict search of results within target_label with 1, default is 0 |
improvement_costs | array | input improvement costs - see cost table |
eco_delta | boolean | disable fetching of ecovalue with 0, default is 1 |
roof_insulation | integer | current roof insulation - see measures |
wall_insulation | integer | current wall insulation - see measures |
floor_insulation | integer | current floor insulation - see measures |
living_room_windows | integer | current living room windows - see measures |
bedroom_windows | integer | current bedroom windows - see measures |
exclude_measure | array | exclude specific measures - see measures exclusion |
minimum_solar_panels | integer | minimum number of solar panels to be included in advice when adviced |
solarpanel_watt_peak | integer | watt peak performance of solar panels per sq m2 |
custom_costs | array | input custom costs - see cost table |
replace_windowframes | integer | activate extra costs for glass related codes with 1, see PDF cost table |
Request a sustainability advice based on BagID.
POST
https://api.altum.ai/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
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
x-api-key* | string | API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai) |
Request Body
Name | Type | Description |
---|---|---|
bag_id* | string | 16 digits BAG_ID |
inner_surface_area | integer | square meter surface area |
build_year | integer | build year of the property |
target_label | string | desired target energy label - default is energy label A |
installation | integer | current installation - see measures |
ventilatiom | integer | current ventilation - see measures |
shower | integer | current shower WTW - see measures |
solar_panels | integer | current solar panels in m2 (default) or total watt-peak capacitity in W (see watt_panels) - see measures |
house_type | integer | current house-type: 1:semi-detached, 2:corner house, 3:terraced house, 4:detached house and 5:apartment* (*service doesn't return measures for an apartment.) |
lock_measures | array | lock measures excluded from calculation |
watt_panels | integer | assume solar_panels input is in W (0) or m2 (1). Default = 1 |
max_investment | integer | maximum investment, use 0 for unlimited |
electricity_usage | integer | input current electricity usage |
heat_usage | integer | input current heat usage |
gas_usage | integer | if used overwrites estimated gas usage |
search_criteria | integer | 0 = Lowest investment costs, 1 = Lowest energy costs, 2 = highest financial return on investment, 3 = highest BARe |
heat_pump_allowed | boolean | allowed or not allowed to advice to implement a heat pump |
replace_boiler | boolean | allowed or not allowed to replace the boiler installation |
inhabitants | integer | number of people living in the house |
natural_gas | integer | 0 = Natural gas allowed, 1 = Natural gas required, 2 = Natural gas not allowed |
solar_panels_surface | integer | 0 = No panels, 1 = Maximum half of the available space, 2 = Fully covered |
heatpump_insulation_req | integer | 0 till 3 defined the minium insulation requirement for advice of a heat pump |
fetch_definitive_label | integer | activate fetching of definitive label at EP-online with 1, default is 0 |
energylabel_strict | integer | enable strict search of results within target_label with 1, default is 0 |
improvement_costs | array | input improvement costs - see cost table |
eco_delta | boolean | disable fetching of ecovalue with 0, default is 1 |
roof_insulation | integer | current roof insulation - see measures |
wall_insulation | integer | current wall insulation - see measures |
floor_insulation | integer | current floor insulation - see measures |
living_room_windows | integer | current living room windows - see measures |
bedroom_windows | integer | current bedroom windows - see measures |
exclude_measure | array | 0 till 3 defined the minium insulation requirement for advice of a heat pump - see measures exclusion |
minimum_solar_panels | integer | minimum number of solar panels to be included in advice when adviced |
solarpanel_watt_peak | integer | watt peak performance of solar panels per sq m2 |
custom_costs | array | input custom costs - see cost table |
replace_windowframes | integer | activate extra costs for glass related codes with 1, see PDF cost table |
Request body
Example requests
Last updated