Example API calls

A collection of example API calls to the service.

Minimal Input

{
    "postcode": "2771DS",
    "housenumber": 87,
    "houseaddition": ""
}

Adding Building Parameters

{
    "postcode": "2771DS",
    "housenumber": 87,
    "houseaddition": "",
    "build_year" : 1961,
    "house_type": 1,
    "roof_type": 1,
    "inner_surface_area": 131
}

Adding Current Measures

{
    "postcode": "2771DS",
    "housenumber": 87,
    "houseaddition": "",
    "wall_insulation": 1,
    "floor_insulation": 1,
    "sloped_roof_insulation": 1,
    "flat_roof_insulation": 1,
    "living_room_windows": 1,
    "bedroom_windows": 1,
    "shower": 1,
    "cooling": 1,
    "electric_cooking": 1,
    "ventilation": 1,
    "installation": 4
}

If no target measures are applied, the target situation is the same as the current situation!

e.g. "target_wall_insulation" = "wall_insulation"

Adding Target Measures

{
    "postcode": "2771DS",
    "housenumber": 87,
    "houseaddition": "",
    "wall_insulation": 1,
    "floor_insulation": 1,
    "sloped_roof_insulation": 1,
    "flat_roof_insulation": 1,
    "living_room_windows": 1,
    "bedroom_windows": 1,
    "shower": 1,
    "cooling": 1,
    "electric_cooking": 1,
    "ventilation": 1,
    "installation": 4,
    "target_wall_insulation": 3,
    "target_floor_insulation": 4,
    "target_sloped_roof_insulation": 3,
    "target_flat_roof_insulation": 3,
    "target_living_room_windows": 3,
    "target_bedroom_windows":3,
    "target_shower": 1,
    "target_cooling": 2,
    "target_electric_cooking": 2,
    "target_ventilation": 3,
    "target_installation": 5   
}

Adding Solar Panels

{
 "postcode": "2771DS",
 "housenumber": 87,
 "houseaddition": "",
 "solar_panels": [{"pv_total_watt_peak":2000,
                   "target_pv_total_watt_peak":2500,
                   "angle":45,
                   "orientation":180,
                   "roof_type": 1},
                  {"pv_area": 20,     
                   "target_pv_area": 20,
                   "specific_watt_peak": 150,
                   "target_specific_watt_peak": 200,
                   "angle":45,
                   "orientation":180,
                   "roof_type": 1}]        
}

Adding Battery

{
   "postcode": "2771DS",
   "housenumber": 87,
   "houseaddition": "",
   "battery_type":3,
   "battery_system": {"capacity": 10, "power":5},
   "target_battery_type":3,
   "target_battery_system": {"capacity": 12, "power":6}
}

Adding Usage Data

{
  "postcode": "2771DS",
  "housenumber":87,
  "houseaddition": "",
  "heat_usage": 25,
  "electricity_usage": 4500,
  "gas_usage": 750
}

Adding Filters

{
  "postcode": "2771DS",
  "housenumber": 87,
  "houseaddition": "",
  "wall_filters": {"biobased": true, "cavity": true, "material":[4]},
  "sloped_roof_filters": {"biobased": false, "insulation_side": 2, "replace_roof": true, "material":[1]},
  "flat_roof_filters": {"biobased": false, "insulation_side": 2, "replace_roof": true, "material":[1]},
  "floor_filters": {"floor_type": 1, "crawl_space": true, "material":[2]}
}

Adding More Features

{
    "postcode": "2771DS",
    "housenumber": 87,
    "houseaddition": "",
    "inhabitants":4,
    "electricity_generation": 100,
    "exclude_vat":false,
    "cost_indicators":{"fixed_gas_price":100,
                     "custom_measure_costs": {"10002": 41,
                                              "80408": 11151,
                                              "70000": 182
                                              }}
}