🇬🇧
Altum AI
StartPlatformMonitorAltum AIContact
English
English
  • Altum AI API documentation
  • Platform
    • Monthly subscriptions
    • Yearly subscriptions
    • Unlimited usage subscriptions
    • Kadaster Transaction API subscription
    • Changelog
  • Updates
  • Developers
    • Perform your first API call
    • Credit API
    • Sandbox
    • OpenAPI specifications
    • GET API status
  • Altum AI website
  • Pricing
  • Property AI
    • Authentication, Input, and Response
    • Output Interpretation
    • FAQs
  • API's
    • AVM API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Accuracy Indicator
      • House numbers & additions
      • House types
      • Variables
      • Output interpretation
      • Frequently Asked Questions (FAQ)
    • AVM+ API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Energylabel and Inner and Outer Surface Area
      • Output interpretation
    • Listing Price API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House numbers, letters & additions
      • Inner and Outer Surface Area
      • Output interpretation
    • Sustainability API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Energylabel
      • Improving the advice
      • Example API calls
      • Output interpretation
      • Increasing energy costs
      • Exclude measures
      • Search criteria
      • Measures
      • Insulation values
      • Comfort score
      • CO2
      • Coverage
      • Cost table input
      • Frequently Asked Questions (FAQ)
    • NTA 8800 Energylabel API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • EPC API
      • Changelog
      • API Key Information
      • Authentication, input and response
      • Output Interpretation
    • Energylabel insights API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WOZ API
      • Changelog
      • Frequently Asked Questions (FAQ)
      • Authentication, input and response
      • API Key Information
      • Output interpretation
      • PC6 average WOZ value
    • Interactive Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Visual similarity search
      • House types
      • Comparable functions
      • Output interpretation
    • Kadaster Transaction API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Housing features API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Contents Value API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Building geometry API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Energy & climate API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Condition score API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Photo Labelling API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Autosearch API
      • Authentication, input and response
      • API Key Information
    • Autosuggest API
      • Authentication, input and response
      • API Key Information
      • Fuzzy Search Support
      • Output interpretation
    • Move data API
      • ChangeLog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Location Data API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • House types
      • Output interpretation
    • Rental Reference API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Rebuild Value API
      • Changelog
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • Solar panel roof scan API
      • Authentication, input and response
      • API Key Information
      • Output interpretation
    • WWS Points API
      • Authentication, input and response
      • API Key Information
      • Specifications for independent home version 01-01-2024
      • Specifications for non-independent home version 01-01-2024
      • Specifications for independent home version 01-07-2024
      • Specifications for non-independent home version 01-07-2024
      • Input explanation for version 01-07-2024
      • Output interpretation
  • API error codes
    • 429
    • 422
    • 403
Powered by GitBook
On this page
  • Using all input features
  • Adding current object and usage data
  • Adding current status of measures
  • Adding requirements from the customer and/or supplier
  • Using advanced functions
  1. API's
  2. Sustainability API

Example API calls

A collection of example API calls to the service.

Using all input features

{"data": {
    "lock_measures": {
      "lock": [
        "wall_insulation"
      ]
    },
    "max_investment": 60000,
    "gas_usage": 3000,
    "post_code": "2771DS",
    "house_number": "87",
    "house_addition": "",
    "target_label": "A",
    "inner_surface_area": 130,
    "inhabitants": 3,
    "replace_boiler": true,
    "heat_pump_allowed": true,
    "search_criteria": 1,
    "house_type": null,
    "natural_gas": 0,
    "solar_panels_surface": 1,
    "watt_panels": true,
    "wall_insulation": 2,
    "roof_insulation": 2,
    "floor_insulation": 2,
    "living_room_windows": 2,
    "exclude_measure": [8004, 8005, 8006, 8007, 8008, 8009, 8029],
    "minimum_solar_panels": 3,
    "heatpump_insulation_req": 2, 
    "bedroom_windows": 1,
    "installation": 4,
    "build_year": 2000,
    "heat_usage": null,
    "energylabel_strict": 1,
    "shower": 0,
    "ventilation": 1,
    "fetch_definitive_label": 1,
    "electricity_usage": 4500,
    "solar_panels": 10,
    "eco_delta": 1,
    "solarpanel_watt_peak": 250,
    "custom_costs":[{"code":2,"value":1.79808},{"code":3,"value":2.31534},{"code":4,"value":0.45455},{"code":5,"value":0.56027}],
    "improvement_costs":[{"code":70000,"material":159,"work":187,"saving_material":128,"saving_work": 153}]
}}

Adding current object and usage data

{"data": {
  "post_code": "2771DS",
  "house_number": "87",
  "house_addition": "",
  "build_year": 2000,
  "inner_surface_area": 130,
  "house_type": null,
  "heat_usage": null,
  "electricity_usage": 4500,
  "gas_usage": 750
}}

Adding current status of measures

{"data": {
  "post_code": "2771DS",
  "house_number": "87",
  "house_addition": "",
  "wall_insulation": 2,
  "roof_insulation": 2,
  "floor_insulation": 2,
  "living_room_windows": 2,
  "bedroom_windows": 1,
  "installation": 4,
  "shower": 0,
  "ventilation": 1,
  "solar_panels": 10,
  "watt_panels": false
}}

Adding requirements from the customer and/or supplier

{"data": {
  "post_code": "2771DS",
  "house_number": "87",
  "house_addition": "",
  "target_label": "A",
  "lock_measures": {
      "lock": [
        "wall_insulation"
      ]
    },
  "exclude_measure": [8004, 8005],
  "minimum_solar_panels": 3,
  "heatpump_insulation_req": 2, 
  "replace_boiler": true,
  "heat_pump_allowed": true,
  "natural_gas": 0,
  "solar_panels_surface": 1,
  "solarpanel_watt_peak": 250,
  "custom_costs":[{"code":2,"value":1.79808},{"code":3,"value":2.31534},{"code":4,"value":0.45455},{"code":5,"value":0.56027}],
  "improvement_costs":[{"code":70000,"material":159,"work":187,"saving_material":128,"saving_work": 153}]
}}

Using advanced functions

{"data": {
  "post_code": "2771DS",
  "house_number": "87",
  "house_addition": "",
  "eco_delta": 1,
  "fetch_definitive_label": 1,
  "search_criteria": 1,
  "energylabel_strict": 1
}}

PreviousImproving the adviceNextOutput interpretation

Last updated 3 months ago