Authentication, input and response

Request a sustainability advice based on address.

POST https://api.altum.ai/v2/sustainability/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 on https://platform.altum.ai

Request Body

Filed

Type

Description

Example/Default

postcode*

string

Six-character postcode format

1234AB

housenumber*

integer

House number of the object

houseaddition

string

Addition to the house number

build_year

integer

Year the object was built

1956

roof_type

integer

1 = (mostly) sloped roof

2 = (mostly) flat roof

3 = part sloped, part flat roof

If either flat or sloped is > 25% it is type 3

Default: 1

house_type

integer

1 = Vrijstaand

2 = 2 onder 1 kap

3 = Hoekwoning

4 = Tussenwoning

inner_surface_area

float

inner surface area (m2)

wall_insulation

integer

see Measures

target_wall_insulation

integer

see Measures

floor_insulation

integer

see Measures

target_floor_insulation

integer

see Measures

sloped_roof_insulation

integer

see Measures

target_sloped_roof_insulation

integer

see Measures

flat_roof_insulation

integer

see Measures

target_flat_roof_insulation

integer

see Measures

living_room_windows

integer

see Measures

target_living_room_windows

integer

see Measures

bedroom_windows

integer

see Measures

target_bedroom_windows

integer

see Measures

installation

integer

see Measures

Default: 4

target_installation

integer

see Measures

shower

integer

see Measures

Default: 1

target_shower

integer

see Measures

cooling

integer

Is there a cooling system present?

1 = No cooling

2 = Air conditioning unit, direct air cooling

target_cooling

integer

Is there a cooling system present?

1 = No cooling

2 = Air conditioning unit, direct air cooling

ventilation

integer

see Measures

target_ventilation

integer

see Measures

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

inhabitants

integer

The number of people living in the house

Default: 3

ev_charger

integer

Does the building have a EV charger?

0 = no charger

1 = EV charger

Default: 0

electricity_connection_type

integer

The connection type of the building

1 = 1-phase

2 = 3-phase

Default: 1

target_electricity_connection_type

integer

The connection type of the building

1 = 1-phase

2 = 3-phase

electricity_contract_type

integer

Electricity contract type

1 = fixed contract

2 = dynamic contract

Default: 1

dynamic_price_reference_year

integer

The year from where the dynamic prices are used:

2023, 2024, 2025

Default: 2025

netting_enabled

integer

Whether the netting ruling (salderingsregeling) is applied

0 = No netting

1 = Netting applied

Default: 1

solar_panels

list

see Measures

number_of_solar_panels

integer

see Measures

battery_type

integer

see Measures

target_battery_type

integer

see Measures

battery_system

integer

see Measures

target_battery_system

integer

see Measures

gas_usage

float

Overwrites the estimated yearly gas consumption (m3)

1000

heat_usage

float

Overwrites specified yearly heat consumption in (GJ)

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

sloped_roof_filters

dict

see Measure filters

flat_roof_filters

dict

see Measure filters

floor_filters

dict

see Measure filters

eco_delta

boolean

Fetching ecovalue

0 = Disable

1 = Enable

Default: 1

{
  "warnings": [],
  "address": {
    "housenumber": 87,
    "postcode": "2771DS",
    "houseaddition": null,
    "street": "Zuidkade",
    "city": "Boskoop",
    "location": {
      "lat": 52.0683938167,
      "lon": 4.6580852695
    }
  },
  "building": {
    "build_year": 1961,
    "inner_surface": 131,
    "floor_surface": 80.8,
    "flat_roof_surface": 5.2,
    "pitched_roof_surface": 98.9,
    "wall_surface": 126.1,
    "glass_living_room_surface": 11.1,
    "glass_bedrooms_surface": 16.6,
    "number_of_doors": 6,
    "type": "Vrijstaand"
  },
  "label": {
    "current": "E",
    "potential": "D"
  },
  "provided_label": {
    "temporary": "F",
    "definitive": "A+++",
    "definitive_type": "NTA 8800:2024 (basisopname woningbouw)",
    "definitive_validity": "2036-1",
    "definitive_beng2": 49
  },
  "BENG2": {
    "current": 315,
    "potential": 260
  },
  "meta": null,
  "CO2": {
    "current": 4086,
    "potential": 3847
  },
  "grid_import": {
    "current": 3259,
    "potential": 3259
  },
  "grid_feed": {
    "current": 0,
    "potential": 0
  },
  "electricity_need": {
    "current": 3259,
    "potential": 3259
  },
  "financial": {
    "total_investment": 22439,
    "total_saving": 182,
    "months_to_pay_off": 1479,
    "eco_value": 22461,
    "savings_monthly": 15,
    "energy_cost_monthly": {
      "current": 285,
      "potential": 270
    },
    "energy_cost_yearly": {
      "current": 3422,
      "potential": 3240
    },
    "electricity_cost_yearly": {
      "current": 1455,
      "potential": 1455
    },
    "return_on_investment": "-0.83%",
    "loan": {
      "monthly_payment": 93
    }
  },
  "gas_usage": {
    "current": 1666,
    "potential": 1532
  },
  "electricity_usage": {
    "current": 3263,
    "potential": 3263
  },
  "city_heating_usage": {
    "current": 0,
    "potential": 0
  },
  "energy_prices": {
    "variable_gas_price": 1.359,
    "variable_electricity_price": 0.27,
    "solarpanel_watt_peak_per_m2": null
  },
  "solar_panels": {
    "summary": {
      "current": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      },
      "potential": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      }
    },
    "systems": {
      "current": null,
      "potential": null
    }
  },
  "battery": {
    "current": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ],
    "potential": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ]
  },
  "measures": {
    "wall_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "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": "Zeer goed",
        "value": 4,
        "points": 7
      },
      "investment": 3903,
      "savings": 35,
      "co2_reduce": 46,
      "BENG2": "22",
      "gas_savings": 26,
      "electricity_savings": 0
    },
    "sloped_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Zeer goed",
        "value": 4,
        "points": 3
      },
      "investment": 11260,
      "savings": 105,
      "co2_reduce": 138,
      "BENG2": "62",
      "gas_savings": 77,
      "electricity_savings": 0
    },
    "flat_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 3
      },
      "investment": 484,
      "savings": 3,
      "co2_reduce": 4,
      "BENG2": "2",
      "gas_savings": 2,
      "electricity_savings": 0
    },
    "living_room_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Drievoudig glas",
        "value": 4,
        "points": 3
      },
      "investment": 3089,
      "savings": 6,
      "co2_reduce": 8,
      "BENG2": "5",
      "gas_savings": 4,
      "electricity_savings": 0
    },
    "bedroom_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": null
      },
      "after": {
        "desc": "HR++ glas",
        "value": 3,
        "points": null
      },
      "investment": 3703,
      "savings": 10,
      "co2_reduce": 13,
      "BENG2": "7",
      "gas_savings": 7,
      "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."
}

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

{ 
  "detail": "House type not found in database. Use house_type parameter instead." 
}

VorigeChangelog VolgendeAPI Key Information

Laatst bijgewerkt 3 dagen geleden