Authenticatie, invoer en resultaat
Vraag een duurzaamheidsadvies op basis van het adres op.
POST https://api.altum.ai/v2/sustainability
Dit endpoint stelt je in staat om een response van de Altum AI Verduurzaming API te ontvangen over verduurzamingsmaatregelen en de Ecowaarde, op basis van postcode, huisnummer en eventuele huisletter/toevoeging.
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
Zes-cijferige postcode formaat bijv. 1234AB
housenumber*
integer
Huisnummer van het object
houseaddition
string
Huisnummertoevoeging
build_year
integer
Bouwjaar
roof_type
integer
1 = (voornamelijk) schuin dak
2 = (voornamelijk) plat dak
3 = deels schuin, deels plat dak
Standaard wordt een schuin dak aangenomen als geen daktype is opgegeven of bekend is.
inner_surface_area
float
De totale woonoppervlakte (m²)
house_type
integer
1 = vrijstaande woning
2 = 2-onder-1-kapwoning
3 = hoekwoning
4 = tussenwoning
wall_insulation
integer
Bekijk maatregelen
floor_insulation
integer
Bekijk maatregelen
sloped_roof_insulation
integer
Bekijk maatregelen
flat_roof_insulation
integer
Bekijk maatregelen
living_room_windows
integer
Bekijk maatregelen
bedroom_windows
integer
Bekijk maatregelen
installation
integer
Bekijk maatregelen
shower
integer
Bekijk maatregelen
ventilation
integer
Bekijk maatregelen
solar_panels
list
Bekijk maatregelen
cooling
integer
Is er een koelsysteem aanwezig?
1 = Geen koeling
2 = Airconditioning, directe luchtkoeling
1
electric_cooking
integer
Wat wordt gebruikt om te koken?
1 = Gasfornuis
2 = Elektrisch fornuis
2 Als de installatie in [6,7] zit.
Anders 1
inhabitants
integer
Aantal bewoners
gas_usage
float
Overschrijft het geschatte jaarlijkse gasverbruik (m³)
heat_usage
float
Overschrijft het opgegeven jaarlijkse warmteverbruik (GJ)
electricity_usage
float
Overschrijft het opgegeven jaarlijkse elektriciteitsverbruik (kWh)
electricity_generation
float
Totale jaarlijkse elektriciteitsopbrengst van zonnepanelen (kWh) Netto verbruik = verbruik − opbrengst
minimum_solar_panels
integer
Het minimale aantal nieuwe zonnepanelen dat geplaatst moet worden
search_criteria
integer
1 = laagste investeringskosten
2 = laagste energiekosten
3 = hoogste rendement op investering
4 = laagste BENG2 (hoogste energielabel)
3
target_label
string
Gewenst doel energy label - standaard is energielabel A of D
max_investment
integer
maximale investering, gebruik 0 voor onbeperkt
natural_gas
integer
1 = geen filter 2 = aardgas verplicht 3 = aardgasvrij
district_heating_allowed
boolean
0 = niet toegestaan
1 = toegestaan
0
heatpump_insulation_req
integer
1 = geen minimum vereist
2 = schil, inclusief glas minimaal 2
3 = woning voldoet aan “standaard”
3
exclude_vat
boolean
Prijzen zijn inclusief of exclusief btw.
0 = inclusief btw
1 = exclusief btw
0
cost_indicators
dict
Bekijk Cost indicators
fetch_definitive_label
integer
Ophalen van het definitieve energielabel uit EP-online
0
energylabel_strict
integer
enable strict search of results within target_label with 1
0
eco_delta
boolean
Ophalen van de Ecowaarde
1
lock_measures
list
Bekijk Lock measures
exclude_measures
list
Bekijk Exclude measures
``` { "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 } ```
``` { "detail": "There was an error parsing the body" }
{ "detail": "Address not found in database, combination of zip code and house number" }
{ "detail": "There are no measures to suggest for this combination of input." }
{ "detail": "No housing variant with the selected installation options found with which the goal can be reached within the investment limit. Try again with different inputs and/or different search criteria." } { "detail": "For a given custom cost make sure the parameter 'value' is provided." } { "detail": "For a given improvement cost make sure all four parameters: 'material', 'work', 'saving_material' and 'saving _work' are provided." } </div><div data-gb-custom-block data-tag="tab" data-title='401: Unauthorized No access'> { 'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.' } </div><div data-gb-custom-block data-tag="tab" data-title='422: Unprocessable Entity Wrong input format'> { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } </div><div data-gb-custom-block data-tag="tab" data-title='500: Internal Server Error Service is not available and/or down'> { "message": "Internal server error" } </div><div data-gb-custom-block data-tag="tab" data-title='403: Forbidden Forbidden'> { "message": "Missing Authentication Token" } </div><div data-gb-custom-block data-tag="tab" data-title='301: Moved Permanently Apartment error'> { "detail": "Unable to check apartment." } </div><div data-gb-custom-block data-tag="tab" data-title='303: See Other house type error'> { "detail": "House type not found in database. Use house_type parameter instead." } </div></div><div data-gb-custom-block data-tag="tabs"><div data-gb-custom-block data-tag="tab" data-title='400: Bad Request Unsuccessful response'> { "detail": "There was an error parsing the body" }
{ "detail": "Address not found in database, combination of zip code and house number" }
{ "detail": "There are no measures to suggest for this combination of input." }
{ "detail": "No housing variant with the selected installation options found with which the goal can be reached within the investment limit. Try again with different inputs and/or different search criteria." } </div><div data-gb-custom-block data-tag="tab" data-title='401: Unauthorized No access'> { 'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.' } </div><div data-gb-custom-block data-tag="tab" data-title='422: Unprocessable Entity Wrong input format'> { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } </div><div data-gb-custom-block data-tag="tab" data-title='500: Internal Server Error Service is not available and/or down'> { "message": "Internal server error" } </div><div data-gb-custom-block data-tag="tab" data-title='403: Forbidden Forbidden'> { "message": "Missing Authentication Token" } </div><div data-gb-custom-block data-tag="tab" data-title='301: Moved Permanently Apartment error'> { "detail": "Unable to check apartment." } </div><div data-gb-custom-block data-tag="tab" data-title='303: See Other house type error'> { "detail": "House type not found in database. Use house_type parameter instead." }
{ "post_code": "2771DS", "house_number": "87", "target_label": "A++++", "eco_delta": 0 }
Last updated