Authenticatie, invoer en resultaat
Vraag een duurzaamheidsadvies op basis van het adres op.
POST https://api.altum.ai/v2/sustainability/apartments
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
applicatie/json
x-api-key*
string
Unieke API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai)
Request Body
postcode*
string
Zes-cijferige postcode formaat bijv. 1234AB
housenumber*
integer
Huisnummer van het object bijv. 1
houseaddition
string
Huisnummertoevoeging bijv. A
position
integer
1 = Hoekappartement begane grond 2 = Tussenappartement begane grond 3 = Hoekappartement middenverdieping 4 = Tussenappartement middenverdieping 5 = Hoekappartement bovenste verdieping 6 = Tussenappartement bovenste verdieping 7 = Volledige bovenste verdieping
3
floors
integer
Heeft de woning één of meerdere verdiepingen?
1 = Enkel 2 = Meerdere
1
back_facade
boolean
Heeft de woning een achtergevel?
false = nee true = ja
false
build_year
integer
Bouwjaar van het object
inner_surface_area
float
Oppervlakte (m²)
apartment_type
integer
1 = 'Galerijflat' 2 = 'Portiekflat' 3 = 'Corridorflat' 4 = 'Maisonnette' 5 = 'Benedenwoning' 6 = 'Bovenwoning' 7 = 'Portiekwoning
cooling
integer
Is er een koelsysteem aanwezig?
1 = Geen koeling 2 = Airconditioning (directe luchtkoeling) Standaardwaarde
1
electric_cooking
integer
Wat wordt gebruikt om te koken?
1 = Gaskookplaat 2 = Elektrische kookplaat
2 als installation in [6,7] staat, anders 1
inhabitants
integer
Aantal bewoners
gas_usage
float
Overschrijft geschat jaarlijks gasverbruik in m³
heat_usage
float
Overschrijft opgegeven jaarlijks warmteverbruik in GJ
electricity_usage
float
Overschrijft opgegeven jaarlijks elektriciteitsverbruik in kWh
electricity_generation
float
Totale jaarlijkse elektriciteitsopwekking van zonnepanelen in kWh
Nettoverbruik = verbruik − opwekking
minimum_solar_panels
integer
Minimum aantal nieuw te plaatsen zonnepanelen
search_criteria
integer
1 = laagste investeringskosten 2 = laagste energiekosten
3 = hoogste rendement op investering
4 = laagste BENG2 (hoogste energielabel)
3
max_investment
integer
Maximale investering, gebruik 0 voor onbeperkt
target_label
string
Gewenst doel-energielabel (standaard is energielabel A of D)
energylabel_strict
integer
Strikte zoekmodus binnen target_label activeren met 1
0
fetch_definitive_label
integer
Ophalen van definitief energielabel via EP-online activeren met 1
0
natural_gas
integer
1 = geen filter
2 = aardgas verplicht 3 = aardgasvrij
heat_pump_allowed
boolean
false = niet toegestaan
true = toegestaan
false
district_heating_allowed
boolean
false = niet toegestaan
true = toegestaan
false
heatpump_insulation_req
integer
1 = geen minimale eis
2 = schil, inclusief glas minimaal 2
3 = woning voldoet aan “standaard”
3
exclude_vat
boolean
Prijzen inclusief of exclusief btw
false = btw inbegrepen
true = btw exclusief
false
eco_delta
boolean
Ecovalue-berekening uitschakelen met 0
1
***Het is aan te raden zowel de positie als het aantal verdiepingen van het appartement op te geven voor optimale resultaten.***
``` { "tip": null, "warnings": [ { "code": "11", "description": "Current building with energy label C already meets default target_label A." } ], "address": { "housenumber": 227, "postcode": "3024XL", "houseaddition": "B", "street": "Willem Buytewechstraat", "city": "Rotterdam", "location": { "lat": 51.90761152288453, "lon": 4.451398538183942 } }, "building": { "build_year": 1927, "inner_surface": 74, "floor_surface": 0, "roof_surface": 0, "wall_surface": 50.2, "glass_living_room_surface": 13.4, "number_of_doors": 5, "floors": "Single", "main_type": "Appartement", "sub_type": null }, "label": { "current": "C", "potential": "B" }, "provided_label": { "temporary": "G", "definitive": null, "definitive_type": null, "definitive_validity": null }, "BENG2": { "current": 245, "potential": 181 }, "meta": null, "CO2": { "current": 2357, "potential": 2141 }, "financial": { "total_investment": 2309, "total_saving": 164, "months_to_pay_off": 168, "eco_value": 0, "savings_monthly": 14, "energy_cost_monthly": { "current": 175, "potential": 161 }, "energy_cost_yearly": { "current": 2096, "potential": 1932 }, "return_on_investment": "0.52%", "loan": { "monthly_payment": 10 } }, "gas_usage": { "current": 888, "potential": 769 }, "electricity_usage": { "current": 2262, "potential": 2255 }, "city_heating_usage": { "current": 0, "potential": 0 }, "solar_panel_yield": { "current": 0, "potential": 0 }, "energy_prices": { "variable_gas_price": 1.359, "variable_electricity_price": 0.27, "solarpanel_watt_peak_per_m2": 250 }, "solar_panels": { "current": null, "potential": null }, "measures": { "wall_insulation": { "before": { "desc": "Geen", "value": 1, "points": 2 }, "after": { "desc": "Goed", "value": 3, "points": 5 }, "investment": 2309, "savings": 164, "co2_reduce": 215, "BENG2": "100", "gas_savings": 119, "electricity_savings": 7 }, "floor_insulation": { "before": { "desc": "Geen", "value": 1, "points": 0 }, "after": { "desc": "Geen", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "roof_insulation": { "before": { "desc": "Geen", "value": 1, "points": 0 }, "after": { "desc": "Geen", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "living_room_windows": { "before": { "desc": "Enkel glas", "value": 1, "points": 0 }, "after": { "desc": "Enkel glas", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "installation": { "before": { "desc": "HR combi ketel", "value": 4, "points": 15 }, "after": { "desc": "HR combi ketel", "value": 4, "points": 15 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "shower": { "before": { "desc": "Geen Douche WTW", "value": 1, "points": null }, "after": { "desc": "Geen Douche WTW", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "cooling": { "before": { "desc": "No cooling", "value": 1, "points": null }, "after": { "desc": "No cooling", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "ventilation": { "before": { "desc": "Natuurlijke ventilatie", "value": 1, "points": 0 }, "after": { "desc": "Natuurlijke ventilatie", "value": 1, "points": 0 }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "solar_panels": { "before": { "desc": "0", "value": 0, "points": null }, "after": { "desc": "0", "value": 0, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "electricity_savings": 0 }, "electric_cooking": { "before": { "desc": "Gas stove", "value": 1, "points": null }, "after": { "desc": "Gas stove", "value": 1, "points": null }, "investment": 0, "savings": 0, "co2_reduce": 0, "BENG2": "0", "gas_savings": 0, "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 house." }
{ "postcode": "3024XL", "housenumber":227, "houseaddition": "B", "position": 3, "floors": 1 }
{ "bag_id": "0599010000202307", "position": 3, "floors": 1 }
Last updated