Example API calls

A collection of example API calls to the service.

Simple call

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

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

Using building parameters

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

Using 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,
  "bedroom_windows": 1,
  "shower": 1,
  "cooling": 1,
  "electric_cooking": 1,
  "ventilation": 1,
  "installation": 4
}

Adding solar panels

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
  "solar_panels": [{"pv_total_watt_peak":2000,
                    "angle":45,
                    "orientation":180,
                    "free_roof_area": 20.0},
                   {"pv_area": 20,     
                    "specific_watt_peak": 150,
                    "angle":45,
                    "orientation":180}]        
}

Using strict target energy label

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

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
}

Using more features

{
  "postcode": "3024XL",
  "housenumber":227,
  "houseaddition": "B",
  "position": 3,
  "floors": 1,
  "back_facade": true,
	"search_criteria": 3,
  "max_investment":20000,
  "inhabitants":4,
  "electricity_generation": 100,
  "minimum_solar_panels": 3,
  "heatpump_insulation_req": 3,
  "natural_gas":1,
  "exclude_vat":false,
  "heat_pump_allowed":true,
  "district_heating_allowed":false,
  "fetch_definitive_label": 1,
  "cost_indicators":{"fixed_gas_price":100},
	"lock_measures": {
                    "lock": ["floor_insulation"]
                    },
  "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]}
}