Authentication, input and response

Request a sustainability advice based on address.

POST https://api.altum.ai/v2/sustainability/apartments/delta

This endpoint allows you to receive response from the Altum AI Sustainability Delta 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

Unique API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Request Body

Name

Type

Description

Example/Default

postcode*

string

Six-character postcode format

1234AB

housenumber*

integer

House number of the object

5

houseaddition

string

Addition to the house number

C

position

integer

1 = 'Corner ground floor' 2 = 'In between ground floor' 3 = 'Corner mid floor' 4 = 'In between mid floor' 5 = 'Corner top floor' 6 = 'In between top floor' 7 = 'Entire top floor'

Default: 1

floors

integer

Does the unit has one or more floors?

1 = 'Single'

2 = 'Multiple'

Default: 1

back_facade

boolean

Does the unit has as back facade?

false = no

true = yes

Default: false

build_year

integer

Year the object was built

1956

inner_surface_area

float

The total living surface area (m2)

90

apartment_type

integer

1 = 'Galerijflat' 2 = 'Portiekflat' 3 = 'Maisonnette' 4 = 'Benedenwoning' 5 = 'Bovenwoning' 6 = 'Portiekwoning'

2

wall_insulation

integer

2

target_wall_insulation

integer

4

floor_insulation

integer

1

target_floor_insulation

integer

4

roof_insulation

integer

2

target_roof_insulation

integer

4

living_room_windows

integer

1

target_living_room_windows

integer

3

installation

integer

Default: 4

target_installation

integer

Default: 4

shower

integer

Default: 1

target_shower

integer

Default: 1

ventilation

integer

2

target_ventilation

integer

3

solar_panels

list

cooling

integer

Is there a cooling system present?

1 = No cooling

2 = Air conditioning unit, direct air cooling

Default: 1

target_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

Default: 2 if Installation in [6,7],

Else 1

target_electric_cooking

integer

What is used for cooking?

1 = Gas stove

2 = Electric stove

Default: 2 if Installation in [6,7],

Else 1

inhabitants

integer

The number of people living in the house

4

gas_usage

float

Overwrites the estimated yearly gas consumption (m3)

1000

heat_usage

float

Overwrites specified yearly heat consumption in (GJ)

45

electricity_usage

float

Overwrites specified yearly electricity consumption (KWh)

2600

electricity_generation

float

Total yearly electricity yield of solar panels (kWh)

Net usage = consumption - yield

800

exclude_vat

boolean

Prices are with or without VAT included.

false = VAT included

true = VAT excluded

Default: false

cost_indicators

dict

see Cost indicators

wall_filters

dict

see Measure filters

roof_filters

dict

see Measure filters

floor_filters

dict

see Measure filters

eco_delta

boolean

Fetching ecovalue

0 = Disable

1 = Enable

Default: 1

Specifying both the position and the floors of the apartment is recommended for optimal results.

VorigeChangelog VolgendeAPI Key Information

Laatst bijgewerkt 17 uur geleden

{
  "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."
}