Authentication, input and response

Request a sustainability advice based on address.

POST https://api.altum.ai/v2/sustainability/delta

This endpoint allows you to receive response from the Altum AI Sustainability Delta API regarding sustainability and the Ecovalue, using the post code, house number and house addition.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	Unique API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Request Body

Name	Type	Description	Example
postcode*	string	Six-character postcode format	1234AB
housenumber*	int	House number of the object	5
houseaddition	string	Addition to the house number	C
build_year	int	Year the object was built	1956
roof_type	int	The type of the roof	1 = (mostly) sloped roof 2 = (mostly) flat roof 3 = part sloped, part flat roof
inner_surface_area	float	The total living surface area (m2)	90
house_type	int	The type of the house	1 = vrijstaande woning 2 = 2-onder-1-kapwoning 3 = hoekwoning 4 = tussenwoning
wall_insulation	int	see Measures	2
target_wall_insulation	int	see Measures	4
floor_insulation	int	see Measures	1
target_floor_insulation	int	see Measures	4
sloped_roof_insulation	int	see Measures	2
target_sloped_roof_insulation	int	see Measures	4
flat_roof_insulation	int	see Measures	2
target_flat_roof_insulation	int	see Measures	4
living_room_windows	int	see Measures	1
target_living_room_windows	int	see Measures	3
bedroom_windows	int	see Measures	1
target_bedroom_windows	int	see Measures	4
installation	int	see Measures	4
target_installation	int	see Measures	4
shower	int	see Measures	1
target_shower	int	see Measures	2
ventilation	int	see Measures	2
target_ventilation	int	see Measures	3
solar_panels	list	see Measures
cooling	int	Is there a cooling system present?	1 = No cooling 2 = Air conditioning unit, direct air cooling
target_cooling	int	Is there a cooling system present?	1 = No cooling 2 = Air conditioning unit, direct air cooling
electric_cooking	int	What is used for cooking?	1 = Gas stove 2 = Electric stove If installation in [6,7] -> 2 else 1
target_electric_cooking	int	What is used for cooking?	1 = Gas stove 2 = Electric stove If installation in [6,7] -> 2 else 1
inhabitants	int	The number of people living in the house	4
gas_usage	float	Overwrites the estimated yearly gas consumption (m3)	1000
heat_usage	float	Overwrites specified yearly heat consumption in (GJ)	45
electricity_usage	float	Overwrites specified yearly electricity consumption (KWh)	2600
electricity_generation	float	Total yearly electricity yield of solar panels (kWh) Net usage = consumption - yield	800
excluda_vat	boolean	Prices are with or without VAT included.	0 = VAT included 1 = VAT excluded Default: 0
lock_measures	array	Current parameters that are not allowed to be improved
exclude_measure	array	Specific measures to be excluded from the results	TBA
custom_costs	int	see Costs	TBA
improvement_costs	array	see Costs	TBA
cost_indicators	dict	see Costs
wall_filters	dict	see Measure filters
sloped_roof_filters	dict	see Measure filters
flat_roof_filters	dict	see Measure filters
floor_filters	dict	see Measure filters
fetch_definitive_label	int	Fetching of definitive label from EP-online	0 = Disable 1 = Enable Default: 0
eco_delta	boolean	Fetching ecovalue	0 = Disable 1 = Enable Default: 1

200: OK Successful response

{
  "warnings": [],
  "address": {
    "housenumber": 87,
    "postcode": "2771DS",
    "houseaddition": null,
    "street": "Zuidkade",
    "city": "Boskoop",
    "location": {
      "lat": 52.06839381665532,
      "lon": 4.65808526945334
    }
  },
  "building": {
    "build_year": 1961,
    "inner_surface": 131,
    "floor_surface": 80.8,
    "flat_roof_surface": 5.2,
    "pitched_roof_surface": 98.9,
    "wall_surface": 126.1,
    "glass_living_room_surface": 11.1,
    "glass_bedrooms_surface": 16.6,
    "number_of_doors": 6,
    "type": "vrijstaand"
  },
  "label": {
    "current": "D",
    "potential": "D"
  },
  "provided_label": {
    "temporary": "F",
    "definitive": "C",
    "definitive_type": null,
    "definitive_validity": null
  },
  "BENG1": {
    "current": null,
    "potential": null
  },
  "BENG2": {
    "current": 265,
    "potential": 251
  },
  "meta": null,
  "energyindex": {
    "current": null,
    "potential": null
  },
  "ELG": {
    "current": null,
    "potential": null
  },
  "comfortscore": {
    "current": null,
    "potential": null
  },
  "CO2": {
    "current": 2633,
    "potential": 2179
  },
  "financial": {
    "total_investment": 1554,
    "total_saving": 69,
    "months_to_pay_off": 270,
    "eco_value": 0,
    "savings_monthly": 6,
    "energy_cost_monthly": {
      "current": 232,
      "potential": 227
    },
    "energy_cost_yearly": {
      "current": 2789,
      "potential": 2720
    },
    "return_on_investment": "-0.14%",
    "loan": {
      "monthly_payment": 6
    }
  },
  "gas_usage": {
    "current": 1697,
    "potential": 1697
  },
  "electricity_usage": {
    "current": 3262,
    "potential": 3262
  },
  "city_heating_usage": {
    "current": 0,
    "potential": 0
  },
  "solar_panel_yield": {
    "current": 4445,
    "potential": 5778
  },
  "energy_prices": {
    "variable_gas_price": null,
    "variable_electricity_price": null,
    "solarpanel_watt_peak_per_m2": null
  },
  "solar_panels": {
    "current": [
      {
        "roof_surface": 0,
        "roof_type": null,
        "original_watt_peak_capacity": null,
        "total_watt_peak_capacity": 2000,
        "current_specific_watt_peak": 250,
        "added_watt_peak_capacity": null,
        "specific_watt_peak_of_added_panels": null,
        "added_panels": null,
        "inclination_angle": 45,
        "orientation": 180
      },
      {
        "roof_surface": 1,
        "roof_type": null,
        "original_watt_peak_capacity": null,
        "total_watt_peak_capacity": 3000,
        "current_specific_watt_peak": 150,
        "added_watt_peak_capacity": null,
        "specific_watt_peak_of_added_panels": null,
        "added_panels": null,
        "inclination_angle": 45,
        "orientation": 180
      }
    ],
    "potential": [
      {
        "roof_surface": 0,
        "roof_type": null,
        "original_watt_peak_capacity": null,
        "total_watt_peak_capacity": 2500,
        "current_specific_watt_peak": null,
        "added_watt_peak_capacity": null,
        "specific_watt_peak_of_added_panels": 250,
        "added_panels": 1,
        "inclination_angle": 45,
        "orientation": 180
      },
      {
        "roof_surface": 1,
        "roof_type": null,
        "original_watt_peak_capacity": null,
        "total_watt_peak_capacity": 4000,
        "current_specific_watt_peak": null,
        "added_watt_peak_capacity": null,
        "specific_watt_peak_of_added_panels": 200,
        "added_panels": 3,
        "inclination_angle": 45,
        "orientation": 180
      }
    ]
  },
  "measures": {
    "wall_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 2
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "floor_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "sloped_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "flat_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "living_room_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "bedroom_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": null
      },
      "after": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": null
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "installation": {
      "before": {
        "desc": "HR-combi ketel",
        "value": 4,
        "points": 15
      },
      "after": {
        "desc": "HR-combi ketel",
        "value": 4,
        "points": 15
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "shower": {
      "before": {
        "desc": "Geen Douche WTW",
        "value": 1,
        "points": null
      },
      "after": {
        "desc": "Geen Douche WTW",
        "value": 1,
        "points": null
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "cooling": {
      "before": {
        "desc": "No cooling",
        "value": 1,
        "points": null
      },
      "after": {
        "desc": "No cooling",
        "value": 1,
        "points": null
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "ventilation": {
      "before": {
        "desc": "Natuurlijk",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Natuurlijk",
        "value": 1,
        "points": 0
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "solar_panels": {
      "before": {
        "desc": "5000",
        "value": 5000,
        "points": null
      },
      "after": {
        "desc": "6500",
        "value": 6500,
        "points": null
      },
      "investment": 1554,
      "savings": 69,
      "co2_reduce": 453,
      "BENG2": "99",
      "gas_savings": 0,
      "electricity_savings": 1334
    },
    "electric_cooking": {
      "before": {
        "desc": "Gas stove",
        "value": 1,
        "points": null
      },
      "after": {
        "desc": "Gas stove",
        "value": 1,
        "points": null
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    }
  },
  "response_meta": null
}

400: Bad Request Unsuccessful response

{
  "detail": "There was an error parsing the body"
}

{
  "detail": "Address not found in database, combination of zip code and house number"
}

{
  "detail": "There are no measures to suggest for this combination of input."
}

{
  "detail": "No housing variant with the selected installation options found with which the goal can be reached within the investment limit. Try again with different inputs and/or different search criteria."
}
{
  "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."
}

401: Unauthorized No access

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

422: Unprocessable Entity Wrong input format

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

301: Moved Permanently Apartment error

{
    "detail": "Unable to check apartment."
}

303: See Other house type error

{ 
  "detail": "House type not found in database. Use house_type parameter instead." 
}

Request a sustainability advice based on BagID. TBA