Authenticatie, invoer en resultaat

Vraag een duurzaamheidsadvies aan op basis van adres.

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

Met dit endpoint kun je een reactie ontvangen van de Altum AI Sustainability Delta API over de duurzaamheid en de Ecowaarde, op basis van postcode, huisnummer en eventuele toevoeging.

Headers

Naam

Type

Omschrijving

Content-Type

string

Applicatie/json

x-api-key*

string

Unieke API sleutel van Altum. Maak er één aan op https://platform.altum.ai

Request Body

Naam

Type

Omschrijving

Voorbeeld / Standaard

postcode*

string

Zes-cijferige postcode formaat

1234AB

housenumber*

int

Huisnummer van het object

houseaddition

string

Huisnummertoevoeging

build_year

int

Bouwjaar

1956

roof_type

int

1 = (voornamelijk) schuin dak

2 = (voornamelijk) plat dak

3 = deels schuin, deels plat dak

Standaard: 1 Let op: Als het platte of schuine deel meer dan 25% van het dakoppervlak beslaat, wordt type 3 gebruikt.

house_type

int

1 = vrijstaande woning

2 = 2-onder-1-kapwoning

3 = hoekwoning

4 = tussenwoning

inner_surface_area

float

De totale woonoppervlakte (m²)

wall_insulation

int

Bekijk Maatregelen

target_wall_insulation

int

Bekijk Maatregelen

floor_insulation

int

Bekijk Maatregelen

target_floor_insulation

int

Bekijk Maatregelen

sloped_roof_insulation

int

Bekijk Maatregelen

target_sloped_roof_insulation

int

Bekijk Maatregelen

flat_roof_insulation

int

Bekijk Maatregelen

target_flat_roof_insulation

int

Bekijk Maatregelen

living_room_windows

int

Bekijk Maatregelen

target_living_room_windows

int

Bekijk Maatregelen

bedroom_windows

int

Bekijk Maatregelen

target_bedroom_windows

int

Bekijk Maatregelen

installation

int

Bekijk Maatregelen

Standaard: 4

target_installation

int

Bekijk Maatregelen

shower

int

Bekijk Maatregelen

Standaard: 1

target_shower

int

Bekijk Maatregelen

cooling

int

Is er een koelsysteem aanwezig? 1 = Geen koeling

2 = Airconditioning, directe luchtkoeling

target_cooling

int

Is er een koelsysteem aanwezig? 1 = Geen koeling

2 = Airconditioning, directe luchtkoeling

ventilation

int

Bekijk Maatregelen

target_ventilation

int

Bekijk Maatregelen

electric_cooking

int

Wat wordt gebruikt om te koken? 1= Gasfornuis

2 = Elektrisch fornuis

Als de installatie in [6,7] zit -> 2, anders standaard 1

target_electric_cooking

int

Wat wordt gebruikt om te koken? 1= Gasfornuis

2 = Elektrisch fornuis

inhabitants

int

Aantal bewoners

Standaard: 3

ev_charger

int

Heeft het gebouw een laadpaal voor elektrische voertuigen?

0 = geen laadpaal 1 = laadpaal aanwezig

Standaard: 0

electricity_connection_type

int

Het aansluitingstype van het gebouw

1 = 1-fase 2 = 3-fase

Standaard: 1

target_electricity_connection_type

int

Het aansluitingstype van het gebouw

1 = 1-fase 2 = 3-fase

electricity_contract_type

int

Type elektriciteitscontract

1 = vast contract 2 = dynamisch contract

Standaard: 1

dynamic_price_reference_year

int

Het jaar vanaf wanneer dynamische prijzen worden gebruikt:

2023, 2024, 2025

Standaard: 2025

netting_enabled

int

Of de salderingsregeling wordt toegepast.

0 = geen saldering 1 = saldering toegepast

Standaard: 1

solar_panels

list

Bekijk Maatregelen

number_of_solar_panels

int

Bekijk Maatregelen

battery_type

int

Bekijk Maatregelen

target_battery_type

int

Bekijk Maatregelen

battery_system

int

Bekijk Maatregelen

target_battery_system

int

Bekijk Maatregelen

gas_usage

float

Overschrijft het geschatte jaarlijkse gasverbruik (m³)

1000

heat_usage

float

Overschrijft het opgegeven jaarlijkse warmteverbruik (GJ)

electricity_usage

float

Overschrijft het opgegeven jaarlijkse elektriciteitsverbruik (kWh)

2600

electricity_generation

float

Totale jaarlijkse elektriciteitsopbrengst van zonnepanelen (kWh) Netto verbruik = verbruik − opbrengst

800

exclude_vat

boolean

Prijzen zijn inclusief of exclusief btw. false = Inclusief btw

true = Exclusief btw

Standaard: false

cost_indicators

dict

Bekijk Kostenindicatoren

wall_filters

dict

Bekijk Maatregelen filters

sloped_roof_filters

dict

Bekijk Maatregelen filters

flat_roof_filters

dict

Bekijk Maatregelen filters

floor_filters

dict

Bekijk Maatregelen filters

eco_delta

boolean

Ophalen van de Ecowaarde 0 = Uitschakelen

1 = Inschakelen

Standaard: 1

{
  "warnings": [],
  "address": {
    "housenumber": 87,
    "postcode": "2771DS",
    "houseaddition": null,
    "street": "Zuidkade",
    "city": "Boskoop",
    "location": {
      "lat": 52.0683938167,
      "lon": 4.6580852695
    }
  },
  "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": "E",
    "potential": "D"
  },
  "provided_label": {
    "temporary": "F",
    "definitive": "A+++",
    "definitive_type": "NTA 8800:2024 (basisopname woningbouw)",
    "definitive_validity": "2036-1",
    "definitive_beng2": 49
  },
  "BENG2": {
    "current": 315,
    "potential": 260
  },
  "meta": null,
  "CO2": {
    "current": 4086,
    "potential": 3847
  },
  "grid_import": {
    "current": 3259,
    "potential": 3259
  },
  "grid_feed": {
    "current": 0,
    "potential": 0
  },
  "electricity_need": {
    "current": 3259,
    "potential": 3259
  },
  "financial": {
    "total_investment": 22439,
    "total_saving": 182,
    "months_to_pay_off": 1479,
    "eco_value": 22461,
    "savings_monthly": 15,
    "energy_cost_monthly": {
      "current": 285,
      "potential": 270
    },
    "energy_cost_yearly": {
      "current": 3422,
      "potential": 3240
    },
    "electricity_cost_yearly": {
      "current": 1455,
      "potential": 1455
    },
    "return_on_investment": "-0.83%",
    "loan": {
      "monthly_payment": 93
    }
  },
  "gas_usage": {
    "current": 1666,
    "potential": 1532
  },
  "electricity_usage": {
    "current": 3263,
    "potential": 3263
  },
  "city_heating_usage": {
    "current": 0,
    "potential": 0
  },
  "energy_prices": {
    "variable_gas_price": 1.359,
    "variable_electricity_price": 0.27,
    "solarpanel_watt_peak_per_m2": null
  },
  "solar_panels": {
    "summary": {
      "current": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      },
      "potential": {
        "pv_generation": 0,
        "curtailed_pv": 0,
        "self_consumed_pv": 0,
        "self_consumed_ratio": 0,
        "netting_enabled": 1
      }
    },
    "systems": {
      "current": null,
      "potential": null
    }
  },
  "battery": {
    "current": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ],
    "potential": [
      {
        "type": "plug_in",
        "capacity": 6,
        "power": 2,
        "control_mode": "pv_only",
        "charge": 0,
        "discharge": 4,
        "cycles": 0.7
      }
    ]
  },
  "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": "Zeer goed",
        "value": 4,
        "points": 7
      },
      "investment": 3903,
      "savings": 35,
      "co2_reduce": 46,
      "BENG2": "22",
      "gas_savings": 26,
      "electricity_savings": 0
    },
    "sloped_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Zeer goed",
        "value": 4,
        "points": 3
      },
      "investment": 11260,
      "savings": 105,
      "co2_reduce": 138,
      "BENG2": "62",
      "gas_savings": 77,
      "electricity_savings": 0
    },
    "flat_roof_insulation": {
      "before": {
        "desc": "Geen",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Goed",
        "value": 3,
        "points": 3
      },
      "investment": 484,
      "savings": 3,
      "co2_reduce": 4,
      "BENG2": "2",
      "gas_savings": 2,
      "electricity_savings": 0
    },
    "living_room_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": 1
      },
      "after": {
        "desc": "Drievoudig glas",
        "value": 4,
        "points": 3
      },
      "investment": 3089,
      "savings": 6,
      "co2_reduce": 8,
      "BENG2": "5",
      "gas_savings": 4,
      "electricity_savings": 0
    },
    "bedroom_windows": {
      "before": {
        "desc": "Dubbel glas",
        "value": 2,
        "points": null
      },
      "after": {
        "desc": "HR++ glas",
        "value": 3,
        "points": null
      },
      "investment": 3703,
      "savings": 10,
      "co2_reduce": 13,
      "BENG2": "7",
      "gas_savings": 7,
      "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": "Natuurlijke ventilatie",
        "value": 1,
        "points": 0
      },
      "after": {
        "desc": "Natuurlijke ventilatie",
        "value": 1,
        "points": 0
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "solar_panels": {
      "before": {
        "desc": "0",
        "value": 0,
        "points": null
      },
      "after": {
        "desc": "0",
        "value": 0,
        "points": null
      },
      "investment": 0,
      "savings": 0,
      "co2_reduce": 0,
      "BENG2": "0",
      "gas_savings": 0,
      "electricity_savings": 0
    },
    "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
}

{
  "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."
}

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

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

{
	"message": "Internal server error"
}

{
	"message": "Missing Authentication Token"
}

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

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

PreviousChangelog

NextAPI sleutel informatie

Last updated 2 months ago