For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authenticatie, invoer en resultaat

Endpoint

POST https://api.altum.ai/subsidy

Request headers

Header
Verplicht
Waarde

x-api-key

Ja

Je Altum AI API-sleutel

Content-Type

Ja

application/json

De snelste manier om de API werkend te zien, is door één veld te sturen, postcode, en het antwoord te bekijken.

De snelste manier om de API werkend te zien, is door één veld te sturen, postcode, en het antwoord te bekijken.

curl -X POST https://api.altum.ai/subsidy \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "postcode": "3511 AA"
  }'

Dit geeft alle beschikbare subsidies voor de postcode terug (gemeentelijk, provinciaal en landelijk), met Loans.eligible_programs leeg en zonder isde_2026-blok.

Vanaf hier zijn er drie gebruiksflows die het verzoek uitbreiden:

Flow
Toevoegen aan verzoek
Geeft terug

Subsidies ophalen

level, limit, tags

Alleen gefilterde subsidies

Leningseligibiliteit controleren

applicant-object

Passende leningsprogramma's met berekeningen

ISDE-subsidie schatten

isde-object

isde_2026-berekeningsblok

Je kunt alle drie combineren in één verzoek.

Geeft subsidies, leningseligibiliteit en ISDE 2026-schattingen terug voor een opgegeven postcode. De objecten applicant en isde zijn optioneel. Het antwoord heeft altijd dezelfde structuur op het hoogste niveau; secties die je niet hebt opgevraagd worden teruggegeven als lege arrays of weggelaten.

Request body - hoogste niveau

Veld
Type
Verplicht
Beschrijving

postcode

string

Ja

Nederlandse postcode in het formaat 1234 AB (met spatie).

level

array van strings

Nee

Filter subsidies op niveau. Eén of meer van municipality, province, national. Standaard alle drie.

limit

integer

Nee

Maximaal aantal subsidies per niveau.

tags

array van strings

Nee

Filter subsidies op onderwerp. Zie Tags-referentie.

object

Nee

Persoonlijke en financiële gegevens voor leningseligibiliteit. Zie Applicant-object.

isde

object

Nee

Projectgegevens voor de ISDE 2026-berekening. Zie ISDE-object.

Volledig verzoekvoorbeeld

Gebruiksflows

Flow 1 - Alleen subsidies ophalen

Stuur postcode met optioneel level, limit en tags. Het antwoord geeft subsidies terug, gegroepeerd per niveau. Loans.eligible_programs is leeg en het isde_2026-blok ontbreekt.

Request

Response (ingekort)

Velden van een subsidie-item

Veld
Type
Beschrijving

location_name

string

Naam van gemeente, provincie of land.

name

string

Naam van het programma (Nederlands).

description

string

Beschrijving van het programma (Nederlands).

eligibility

string | null

Voorwaarden gescheiden door puntkomma's (Nederlands).

application_deadlines

string | null

Deadlinestring. Formaten: until:<datum> of from:<datum> to:<datum>. Datums in het Nederlands (bv. 31 december 2026).

subsidy_amounts

string | null

Bedragenrange als string. Formaat: min:€<bedrag> max:€<bedrag>.

budget_ceilings

string | null

Totaal budgetplafond voor het programma, indien opgegeven.

application_process

string | null

Hoe aan te vragen (Nederlands).

url

string

Officiële programmapagina.

contact_info

string | null

Contactgegevens van de uitgevende instantie.

level

string

Eén van municipality, province, national.

Flow 2 - Leningseligibiliteit

Voeg het applicant-object toe aan het verzoek. Het antwoord geeft passende leningsprogramma's terug met berekeningen toegespitst op de aanvrager (rentepercentage, maandlast, totale kosten).

Request

Response

Velden van een passend programma

Veld
Type
Beschrijving

program_name

string

Naam van het leningsproduct.

description

string

Korte samenvatting van het leningsproduct.

min_max_loan_amount

array [min, max]

Toegestane leningrange in euro.

max_loan_period_years

integer

Maximale looptijd in jaren.

interest_type

string

Tekstuele beschrijving van hoe de rente wordt bepaald.

repayment

string

Tekstuele beschrijving van de aflossingsvoorwaarden.

key_features

array van strings

Bullets met kenmerken van het programma.

loan_amount

number

Bedrag dat is gebruikt in deze berekening (echo van applicant.requested_amount).

loan_period_years

integer

Looptijd die is gebruikt in deze berekening (echo van applicant.desired_loan_period_years).

applied_interest_rate_percent

number

Rentepercentage dat voor deze specifieke aanvrager is toegepast.

total_interest

number

Totale rente over de looptijd (€).

total_cost

number

Hoofdsom + totale rente (€).

monthly_payment

number

Maandelijkse annuïteit (€), afgerond op twee decimalen.

Flow 3 - ISDE 2026-berekening

Voeg het isde-object toe aan het verzoek. Het antwoord geeft een isde_2026-blok terug met de totale subsidieschatting, een uitsplitsing per categorie en eventuele waarschuwingen.

Request

Response

Velden op het hoogste niveau van isde_2026

Veld
Type
Beschrijving

total_subsidy_euro

number

Som van alle categoriebedragen (€).

category_count

integer

Aantal categorieën dat een bedrag > 0 oplevert.

eligibility

object

Booleaanse map van eligibiliteitschecks per categoriegroep.

prior_isde_warning

string

Waarschuwing over eerdere ISDE-aanvragen, in het Nederlands. Lege string als er geen is.

skip_primary_heat_pump

boolean

Geeft aan of de primaire warmtepomp is overgeslagen (bv. omdat een extra warmtepomp de plek heeft ingenomen).

breakdown

object

Uitsplitsing per categorie. Zie hieronder.

Velden per categorie binnen breakdown

Elke categorie (insulation, glazing, ventilation, heat_pump_primary, heat_pump_extra, solar_boiler, district_heating, electric_cooking) heeft dezelfde structuur:

Veld
Type
Beschrijving

amount

number

Berekende subsidie voor deze categorie (€).

warning

string

Nederlandse waarschuwingstekst, of een lege string.

details

object

Categorie-specifieke berekeningsdetails. Leeg object voor eenvoudige categorieën.

Flow 4 - Gecombineerd

Stuur postcode, applicant en isde in één verzoek om subsidies, leningen en de ISDE-berekening tegelijk in één antwoord te ontvangen. De structuur op het hoogste niveau van het antwoord is dezelfde als in het volledige verzoekvoorbeeld.

Schema-referentie voor verzoeken

LoanApplicantProfile-object

Alle velden zijn verplicht wanneer applicant is opgegeven, tenzij anders aangegeven.

Veld
Type
Beschrijving

age

integer

Leeftijd van de aanvrager in jaren. Sommige programma's (bv. NWF 1) hanteren een leeftijdsgrens.

is_homeowner

boolean

Of de aanvrager eigenaar is van de woning.

is_occupant

boolean

Of de aanvrager in de woning woont.

residence_country

string

Land van verblijf. De meeste programma's vereisen Netherlands.

property_use_residential_percent

integer

Percentage van de woning dat residentieel wordt gebruikt (0-100).

credit_approved

boolean

Of de aanvrager een kredietcheck heeft doorstaan.

previously_rejected_nwf1

boolean

Of de aanvrager eerder is afgewezen voor een NWF 1-lening.

rejection_reason

string | null

Reden van eerdere afwijzing, indien van toepassing.

requested_amount

number

Gevraagd leningbedrag in euro.

existing_nwf_loan_balance

number

Huidige openstaande saldo op bestaande NWF-leningen (€).

specific_target_group

boolean

Of de aanvrager tot een specifieke doelgroep behoort die in aanmerking komt voor bijzondere voorwaarden.

collective_neighborhood

boolean

Of de aanvraag onderdeel is van een collectief buurtproject.

has_mortgage_security

boolean

Of er een hypothecaire zekerheid is.

business_part_connected

boolean | null

Geeft een verbinding aan met een zakelijk deel van het pand.

gross_household_income

number

Bruto jaarinkomen van het huishouden in euro. Wordt gebruikt voor inkomensafhankelijke renteklassen.

desired_loan_period_years

integer

Gewenste looptijd in jaren.

ISDE-object

Het isde-object schakelt de ISDE 2026-subsidieberekening in. Alle subvelden zijn optioneel - vul alleen de maatregelen in die van toepassing zijn.

Velden op het hoogste niveau

Veld
Type
Beschrijving

prior_isde

string

Aantal eerdere ISDE-aanvragen.

prior_heat_pump

string

Status van een eerdere warmtepomp.

insulation

object

Isolatiemaatregelen. Zie hieronder.

glazing

object

Beglazingmaatregelen. Zie hieronder.

ventilation

object

Mechanische ventilatie. Zie hieronder.

heat_pump_primary

object

Primaire warmtepomp. Zie hieronder.

heat_pump_extra

object | null

Extra warmtepomp, indien aanwezig.

solar_boiler

object

Zonneboiler.

district_heating

object

Aansluiting op warmtenet.

electric_cooking

object

Elektrische kookvoorziening.

Mogelijke waarden voor prior_isde en prior_heat_pump

prior_isde: "1" = nooit, "2" = ja, langer dan 24 maanden geleden, "3" = ja, binnen de laatste 24 maanden

prior_heat_pump: "none" / "1" = geen eerdere warmtepompsubsidie, "2" = LW warmtepomp 1-70 kW, met bonus, "3" = LW warmtepomp 1-70 kW, zonder bonus, "4" = LW warmtepomp 71-400 kW

Insulation

Een dictionary van isolatiemaatregelen. Ondersteunde sleutels: roof, attic, facade, cavity, floor, bottom. Elk item heeft de volgende structuur:

Veld
Type
Beschrijving

area_m2

number

Geïsoleerd oppervlak in m².

date_bucket

string

Installatieperiode.

biobased

boolean

Of er biobased materialen zijn gebruikt. Triggert de MKI-bonus wanneer true.

Glazing

Een dictionary van beglazingmaatregelen. Ondersteunde sleutels: hrpp, triple, panel12, panel07, door15, door10. Elk item heeft de volgende structuur:

Veld
Type
Beschrijving

area_2024

number

Oppervlak in m² geplaatst in 2024.

area_2025_2026

number

Oppervlak in m² geplaatst in 2025 of 2026.

Ventilation

Veld
Type
Beschrijving

within_24_months_of_insulation

boolean

Of ventilatie binnen 24 maanden na een isolatiemaatregel is geplaatst. Vereist voor eligibiliteit.

install_year

integer

Jaar van installatie.

Heat pump (primary en extra)

heat_pump_primary en heat_pump_extra hebben dezelfde structuur:

Veld
Type
Beschrijving

pump_type

string

Categorie van de warmtepomp. Zie de enum hieronder.

energy_class

string

Energie-efficiëntieklasse (bv. A++, A+++).

power_kw

number

Nominaal thermisch vermogen in kW.

install_year

integer

Jaar van installatie.

purchase_year

integer

Jaar van aankoop.

role

string

primary of extra.

Ondersteunde pump_type-waarden:

  • Lucht-water ≥ 1 kW en ≤ 70 kW (meest voorkomend)

  • Grond-water ≥ 1 kW en < 10 kW

  • Water-water ≥ 1 kW en < 10 kW

  • Lucht-water ≥ 1 kW en < 13 kW (compact/split)

  • Lucht-lucht warmtepomp

Solar boiler

Veld
Type
Beschrijving

boiler_type

string

Type zonneboiler.

size_bucket

string

Maatcategorie.

install_year

integer

Jaar van installatie.

District heating

Veld
Type
Beschrijving

year_bucket

string

Installatieperiode.

Electric cooking

Veld
Type
Beschrijving

on_warmtenet

boolean

Of de woning is aangesloten op een warmtenet.

district_heating_subsidy_received

boolean

Of er al een warmtenetsubsidie is ontvangen.

gas_disconnected_and_within_24_months

boolean

Of de gasaansluiting binnen de laatste 24 maanden is verwijderd.

Tags-referentie

Het tags-veld filtert subsidies op onderwerp. Geef één of meer waarden op, exacte hoofdlettergevoelige overeenkomst, alleen in het Nederlands.

Duurzaamheid (algemeen) Duurzaamheid, Duurzaamheid en samenleving, Duurzaam ondernemen, Duurzaam bouwen en verbouwen, Duurzaam en slim rijden, Duurzaam financieren, Duurzaam produceren, Duurzaam voedsel, Verduurzamen

Klimaat en emissies Klimaatadaptatie, Klimaatakkoord, Klimaatbeleid, Klimaatneutraal, Klimaatverandering, CO2, CO2-neutraal, CO2-opslag, CO2-reductie, Emissiereductie, Emissie, Emissiehandel, Niet-CO2-broeikasgassen

Luchtkwaliteit Fijn stof, Luchtkwaliteit, NOx-beperkende technieken, Stikstof

Hernieuwbare energie Hernieuwbare energie, Duurzame energie, Duurzame energievoorziening, Duurzame elektriciteit, Zonnepanelen, Zon-PV-installaties, Zonneboilers, Wind, Wind op land, Wind op zee, Windmolens, Windturbines, Waterstof, Waterstofcellen, Biomassaketels, Groen gas, Aardgasvrij, Energie uit water, Bodemenergie

Energiebesparing en gebouwen Energiebesparing, Energieopslag, Opslag van elektriciteit, Netcongestie, Isolatie, Isoleren, Warmtepompen, Warmte Koude Opslag, Duurzame warmte en koude, Ledverlichting, Ventilatie en binnenmilieu, Gebouwde omgeving

Circulaire economie en materialen Circulair ondernemen, Biobased economy, Biobased materialen, Afval, Grondstoffen, Valorisatie

Natuur en milieu Natuur, Natuurbeheer, Natuurterreinen, Bodem, Oppervlaktewater, Grondwater, Verontreiniging, Lucht, Milieu, Milieuzorg, Eco-activiteiten

Mobiliteit en innovatie Duurzame mobiliteit, Duurzame ontwikkeling, Duurzame technologie, Duurzame innovatie, Elektrisch rijden, Mobiliteit en ruimte

SDG's van de VN SDG7 Betaalbare en duurzame energie, SDG11 Duurzame steden en gemeenschappen, SDG12 Verantwoorde consumptie en productie, SDG13 Klimaatactie, SDG14 Leven in het water, SDG15 Leven op het land

Last updated