Changes from previous version

1. Request body

Embed input has changed.

From:

{
    "data": {
    "post_code": "2771DS",
    "house_number": "87",
     "house_addition": "",
    "target_label": "A++++",
    "eco_delta": 0
	}
}

To

{
    "postcode": "2771DS",
    "housenumber": "87",
    "houseaddition": "",
    "target_label": "A++++",
    "eco_delta": 0
}

The feature names have also changed for consistency with other apis.

2. Inputs

a. Basic features

sloped_roof_insulation (changed from roof_insulation)

flat_roof_insulation (changed from roof_insulation)

electric_cooking (new)

cooling (new)

district_heating_allowed (new)

electricity_generation (new)

solar_panels (per solar panel) (changed from integer to list)

  • pv_total_watt_peak

  • pv_area (changed from separate solar_panels_surface)

  • specific_watt_peak

  • angle

  • orientation

  • free_roof_area

  • roof_type

b. Costs assumptions

cost_indicators (changed from codes to names)

  • fixed_gas_price

  • variable_gas_price

  • energy_tax_gas

  • fixed_electricity_price

  • variable_electricity_price

  • energy_tax_electricity

  • fixed_heat_price

  • energy_tax_heat

  • variable_heat_price

  • tax_credit

  • feed_in_compensation

  • feed_in_cost

  • fixed_solar_panel_costs

  • netting_percentage

  • gas_yearly_price_increase

  • electricity_yearly_price_increase

  • external_heating_yearly_price_increase

  • term

  • discount_rate

  • tax_rate

  • custom_costs (TBA)

3. Outputs

number _of_doors

solar_panel_yield

energy_cost_monthly

energy_cost_yonthly

return_on_investment

sloped_roof_insulation (changed from roof_insulation)

flat_roof_insulation (changed from roof_insulation)

cooling (new)

electric_cooking (new)

solar_panels (per solar panel)

  • roof_surface

  • roof_type

  • original_watt_peak_capacity

  • total_watt_peak_capacity

  • added_watt_peak_capacity

  • added_panels

  • inclination_angle

  • orientation

4. Output modifications

from:

"usage": {
	"gas": 1630,
	"energy": 2286,
	"city_heating": 0
},
"usage_potential": {
	"gas": 1362,
	"energy": 75,
	"city_heating": 0
}

to:

"gas_usage": {
	"current": 1630,
	"potential": 1362
},
"electricity_usage": {
	"current": 2286,
	"potential": 75
},
"city_heating_usage": {
	"current": 0,
	"potential": 0
}

energy becomes electricity

5. Feature modifications

The value of some features now go from 1 to 4 instead of 0 to 3. Like:

wall_inulation, floor_insulation, living_room_windows, bedroom_windows and the new flat_roof_insulation, sloped_roof_insulation

For example: “mediocre” wall_insulation was 1 and now it has the number 2

See documentation for more info.

Last updated