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

Naam

Type

Omschrijving

Content-Type

string

applicatie/json

x-api-key*

string

Unieke API-sleutel van Altum. Maak er een op https://platform.altum.ai

Request Body

Naam

Type

Omschrijving

Standaard

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

floors

integer

Heeft de woning één of meerdere verdiepingen?

1 = Enkel 2 = Meerdere

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 = 'Maisonnette' 4 = 'Benedenwoning' 5 = 'Bovenwoning' 6 = 'Portiekwoning

wall_insulation

integer

Bekijk Maatregelen

floor_insulation

integer

Bekijk Maatregelen

roof_insulation

integer

Bekijk Maatregelen

living_room_windows

integer

Bekijk Maatregelen

installation

integer

Bekijk Maatregelen

shower

integer

Bekijk Maatregelen

ventilation

integer

Bekijk Maatregelen

solar_panels

list

Bekijk Maatregelen

number_of_solar_panels

integer

Bekijk Maatregelen

cooling

integer

Is er een koelsysteem aanwezig?

1 = Geen koeling 2 = Airconditioning (directe luchtkoeling) Standaardwaarde

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)

target_label

string

Gewenst doel-energielabel (standaard is energielabel A of D)

A+

max_investment

integer

Maximale investering, gebruik 0 voor onbeperkt

energylabel_strict

integer

Strikte zoekmodus binnen target_label activeren met 1

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

Minimale isolatie-eis voordat een warmtepomp is toegestaan. 1 = geen minimale eis

2 = schil, inclusief glas minimaal 2

3 = woning voldoet aan “standaard”

exclude_vat

boolean

Prijzen inclusief of exclusief btw

false = btw inbegrepen

true = btw exclusief

false

cost_indicators

dict

Bekijk Kostenindicatoren

wall_filters

dict

Bekijk Maatregelen filters

roof_filters

dict

Bekijk Maatregelen filters

floor_filters

dict

Bekijk Maatregelen filters

eco_delta

boolean

Ecowaarde-berekening

0 = uitschakelen

1 = inschakelen

lock_measures

list

Bekijk Maatregelen vergrendelen

exclude_measures

list

Bekijk Maatregelen uitsluiten

***Het is aan te raden zowel de positie als het aantal verdiepingen van het appartement op te geven voor optimale resultaten.***

{
  "warnings": [],
  "address": {
    "housenumber": 227,
    "postcode": "3024XL",
    "houseaddition": "B",
    "street": "Willem Buytewechstraat",
    "city": "Rotterdam",
    "location": {
      "lat": 51.9076115229,
      "lon": 4.4513985382
    }
  },
  "building": {
    "build_year": 1927,
    "inner_surface": 74,
    "floor_surface": 74,
    "flat_roof_surface": null,
    "pitched_roof_surface": null,
    "wall_surface": 50.2,
    "glass_living_room_surface": 13.4,
    "glass_bedrooms_surface": null,
    "number_of_doors": 5,
    "apartment_type": "Portiekwoning"
  },
  "label": {
    "current": "C",
    "potential": "A+"
  },
  "accuracy_indicator": 3,
  "provided_label": {
    "temporary": "G",
    "definitive": null,
    "definitive_type": null,
    "definitive_validity": null,
    "definitive_beng2": null
  },
  "BENG2": {
    "current": 191,
    "potential": 87
  },
  "meta": null,
  "CO2": {
    "current": 2095,
    "potential": 2022
  },
  "financial": {
    "total_investment": 17400,
    "total_saving": 32,
    "months_to_pay_off": 6516,
    "eco_value": 39246,
    "savings_monthly": 3,
    "energy_cost_monthly": {
      "current": 158,
      "potential": 155
    },
    "energy_cost_yearly": {
      "current": 1896,
      "potential": 1864
    },
    "return_on_investment": "-0.89%",
    "loan": {
      "monthly_payment": 72
    }
  },
  "gas_usage": {
    "current": 741,
    "potential": 321
  },
  "electricity_usage": {
    "current": 2262,
    "potential": 4262
  },
  "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": "Goed",
        "value": 3,
        "points": 5
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 5
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "floor_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 7
      },
      "investment": 2553,
      "savings": 51,
      "co2_reduce": 67,
      "BENG2": "17",
      "gas_savings": 37,
      "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": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "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": "Hybride WP",
        "value": 8,
        "points": 20
      },
      "investment": 6621,
      "savings": -38,
      "co2_reduce": -20,
      "BENG2": "80",
      "gas_savings": 368,
      "electricity_savings": -2000
    },
    "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": "Decentrale balansventilatie",
        "value": 4,
        "points": 5
      },
      "investment": 8226,
      "savings": 116,
      "co2_reduce": 152,
      "BENG2": "34",
      "gas_savings": 85,
      "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."
}

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
	"message": "Internal server error"
}

{
	"message": "Missing Authentication Token"
}

{
    "detail": "Unable to check house."
}

Request body

Voorbeeld request

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1
}

PreviousChangelog NextAPI sleutel informatie

Last updated 3 days ago