StartPlatformMonitorAltum AIContact

Changelog

Changelog of the deploy of the Sustainability API in format iteration (1.01) and (expected) release date (year, month and day).

4.6- 2024-12-11

  • Added a correction for the calculated yearly gas comsumption "gas_usage", based on statistical averages of houses in the Netherlands.

4.5- 2024-12-05

  • Two new 400 error responses have been added when the user does not provide the required parameters of a custom cost or an improvement cost.

    • "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."

  • Added BENG1 current and potential outputs

4.4- 2024-11-06

  • The "target_label" input has been removed from the criteria for applying additional measure information.

4.3- 2024-10-02

  • Added "points" output per measure. These points are being used to calculate the "comfortscore". See Comfortscore page.

4.2- 2024-09-16

  • EPOnline version update from V3 to V4.

4.1 - 2024-8-23

  • The calculation of the current measures has been updated to incorporate additional measure information for better accuracy, if there is no measure input from the user.

3.25 - 2024-8-16

  • Changes in "exclude_measure" input. Values [1001, 1002, 2001, 2002] are now available, value [8009] is removed.

3.24 - 2024-7-30

  • User value for solar panel input is now correctly included in the calculation of the results per measure

  • The calculation of the generated electricity from PV panels in the results per measure has been adjusted

  • A bug in the calculation of the gas costs has been resolved

  • HRe/CHP boiler has been removed as an option for installation measure

3.23 - 2024-06-21

  • Custom value for gas use now also applies to output results per measure in case of a hybrid heatpump

3.22 - 2024-06-18

  • Fixed bug in handling custom input WP solar panels causing incorrect results.

  • Adjusted the calculation factor to calculate energy output of solar panels on BENG2. Lowered from 4.756 to 4.21 to better match local solar input/m2.

3.21 - 2024-06-14

  • Fixed a bug where correction for gas consumption based on delivered value was not applied in the case of a hybrid heat pump.

3.20 - 2024-04-19

  • New optional parameter "replace_windowframes"- used to add extra improvement costs per glass related codes 50002, 50003, 50103, 50203 when replacing glass and window frames. The costs can be seen in the PDF at cost table. Activate with "replace_windowframes" : 1

3.19 - 2024-03-14

  • Fixed issue with occasional inconsistent results caused by inconsistent processing of the new cost table.

3.18 - 2024-01-10

  • The costs of the measures have changed since January 1, 2024. See link

3.17 -2023-12-13

  • Addition "city_heating" current and potential consumption outputs, the annual heat consumption in GJ.

3.16 - 2023-12-01

  • Added "floor_surface", "flat_roof_surface", "pitched_roof_surface", "wall_surface", "glass_living_room_surface", "glass_bedrooms_surface" outputs

3.15 - 2023-11-27

  • Fixed an issue with "custom_costs" not being processed properly

3.14 - 2023-11-7

  • Added electricity_savings output. This output displays the yearly savings in electricity usage in kWh for the specific measure.

  • Added gas_savings output. This output displays the yearly savings in gas usage in m^3 for the specific measure.

3.13 - 2023-10-9

  • Error codes updates to reflect API for 400 No measures (formerly 311) and 400 Address not found (formerly 301)

  • Added watt_panels input to interpret solar_panels input as watt peak capacity solar panels. Example input: "solar_panels": 15000, "watt_panels": 0

3.12 - 2023-8-29

  • Added /bag endpoint for requesting sustainability advice based on BAG ID (VBO)

3.11 - 2023-8-8

  • Housenumber letter additions are now searched in both upper case (A) and lower case (a)

3.10 - 2023-7-16

  • Adding current electricity usage is now possible via the feature: "electricity_usage". Together with the input "gas_usage" you are now able to enter the total current energy usage.

3.09 - 2023-4-25

  • Fixed issue where the custom "gas_usage" input was not properly accounted for the "saving" results per measure.

3.08 - 2023-2-22

  • Optimized general performance of the API call to 2 seconds on average

  • Added optional boolean "eco_delta: 0" input to deactivate fetching of the Ecovalue output. Which will then display "null" for this value. This results in a ~ 1 second performance improvement per API call

3.07 - 2022-10-19

  • Added feature to overwrite solar panel watt peak per square meter with "solarpanel_watt_peak"

  • Added default watt peak output solar panels to 212

  • API output now showing gas and energy prices used as well as the solarpanel watt peak performance per square meter:

    "energy_prices": {
	"variable_gas_price": 0.774,
	"variable_electricity_price": 0.223,
	"solarpanel_watt_peak_per_m2": 250
},

3.06 - 2022-6-28

  • Exclude specific measures instead or next to a category of measures with the function exclude_measure.

  • Set a minimum number of solar panels to be adviced when provided as measure via the function: minimum_solar_panels Warning: in some cases this might result into NOT suggesting solar panels as measure at all

3.05 - 2022-5-24

  • Added function to set a minimum requirement for insulation when suggest a (hybrid) heatpump via the input feature "heatpump_insulation_req": 0, 1, 2 or 3. Default is 0. This feature can be used to ensure a heatpump (Installation 7 or 8, 30, 31) is only returned as a measure when all insulation levels (wall, floor, roof) satisfy the 'heatpump_insulation_req' input. In other words: when 'heatpump_insulation_req' is 2, a heatpump is only considered as a resulting measure when Wall insulation, Floor insulation and Roof insulation all have at least a value of 2 (=good).

3.04 - 2022-4-1

  • New optional parameter build_year (from 1000 and to 2030) to parse as input. With an accompanying error 303 message: "Build year not found in database. Use build_year parameter."

  • New optional parameter inner_surface_area (greater than 0). New response for 303 error: "Inner surface area not found in database. Use inner_surface_area parameter instead."

  • New optional parameter fetch_definitive_label - used as flag to fetch the label, its validity and norm type from EP-online. Default is 0.

  • More robust handling of possible Ecovalue delta model downtime.

  • Mitigation of non-uniform build years, incl. an option to specify year in input.

3.03 - 2021-10-13

  • Input a budget "max_investment" with no target energylabel "target_label" will assume utilizing max budget with search criteria the lowest annual yearly energy costs "search_criteria: 1"

  • Issue resolved with input of an adjusted cost table

  • Added a function for creating a strict search function for the target energy label. This function is called "energylabel_strict" and has a boolean syntax, where 0=yes and 1=no. When given energy label A as target and strict search is yes, the advice will search up to the lower bound of the A label

  • Added the ability to input search criteria where the target is lowest BENG2 value which relates to the energy label. Example: "search_criteria: 4"

3.02 - 2021-10-11

  • Added BENG2 current and potential

  • Added BENG2 percentual impact per measure

  • Fixed an issue with input cost table

  • Optimized performance

  • Add parameter input of heat usage for which Stadsverwarming is assumed as Installation when heat usage is added to a request

Added input

"heat_usage": 100,

Added output

"BENG2": {
        "current": 405,
        "potential": 154
    }
---
"floor_insulation": {
            "before": {
                "desc": "Geen",
                "value": 0
            },
            "after": {
                "desc": "Zeer goed",
                "value": 3
            },
            "investment": 3892.71,
            "saving": 1393,
            "co2_reduce": 3196,
            "BENG2": "23.8%"
        }

3.01 - 2021-10-8

  • Added gas- and electricity usage of potential situation to the output

  "usage_potential": {
    "gas": 422,
    "energy": 74
  },

3.0 - 2021-10-1

  • Change API to NTA 8800 norm and altum.ai/sustainability as endpoint

  • Added Ventilation as output measure

  • Target label is now a minimum instead of maximum

  • Definitive Energy label output is now fetched live from EP-online

  • Added GET function to fetch based on BAG /sustainability?bagid=

2.11 - 2021-7-27

  • Added error code 303: "detail": "House type not found in database. Use house_type parameter instead."

2.10 - 2021-2-25

  • Fixed a bug regarding cost table input

2.09 - 2021-1-8

  • Fixed a bug in a module which caused the service to generate an error

2.08 - 2020-11-30

{"data": 
   {"post_code": "2771DS",
    "house_number":"87",
    "solar_panels":"10",
    "output_variant":"medium",
    "watt_panels":"true",
    "max_investment":"800",
    "target_label": "A",
    "improvement_costs": [{"code":10001,"material":4,"work":4}]
}}

2.07 - 2020-11-09

Fixed

  • Small bug fixed in regard to suggesting wall insulation for objects built before 1930.

Changed

  • It is possible to insert the house-type and overwrite the default. The new parameter is optional and if not present in the input, the house-type from the database will be used.

2.06 - 2020-10-12

Added

  • A more accurate source is used for the default housing type, which will improve the quality of the advice

Fixed

  • The specified inner surface area as input is also given as output from the API, in addition to being used for the calculations

  • There is a fix for an issue with house numbers as input where these are entered as eg "12a" which caused an error in the application

PreviousSustainability APINextAuthentication, input and response

Last updated