Example API calls

A collection of example API calls to the service.

Simple call

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

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1
}

Adding building parameters

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "build_year" : 1961,
  "inner_surface_area": 90
}

Adding current measures

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "build_year" : 1961,
  "inner_surface_area": 90,
  "wall_insulation": 1,
  "floor_insulation": 1,
  "roof_insulation": 1,
  "living_room_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": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "build_year" : 1961,
  "inner_surface_area": 90,
  "wall_insulation": 1,
  "floor_insulation": 1,
  "roof_insulation": 1,
  "living_room_windows": 1,
  "shower": 1,
  "cooling": 1,
  "electric_cooking": 1,
  "ventilation": 1,
  "installation": 4,
  "target_wall_insulation": 3,
  "target_floor_insulation": 3,
  "target_roof_insulation": 3,
  "target_living_room_windows": 4,
  "target_shower": 2,
  "target_cooling": 2,
  "target_electric_cooking": 2,
  "target_ventilation": 1,
  "target_installation": 4
}

Adding solar panels

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "solar_panels": [{"pv_total_watt_peak":2000,
                    "target_pv_total_watt_peak":2500,
                    "angle":45,
                    "orientation":180
                    },
                    {"pv_area": 20,     
                    "target_pv_area": 20,
                    "specific_watt_peak": 150,
                    "target_specific_watt_peak": 200,
                    "angle":45,
                    "orientation":180
                    }]        
}

Adding usage data

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "heat_usage": 25,
  "electricity_usage": 4500,
  "gas_usage": 750
}

Adding more features

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "inhabitants":4,
  "electricity_generation": 100,
  "exclude_vat":false,
  "fetch_definitive_label": 1,
  "cost_indicators":{"fixed_gas_price":100},
  "wall_filters": {"biobased": true, "cavity": true, "material":[4]},
  "roof_filters": {"biobased": false, "insulation_side": 2, "replace_roof": true, "material":[1]},
  "floor_filters": {"floor_type": 1, "crawl_space": true, "material":[2]}
}