POSThttps://api.vastgoed.ai/v1/trial

Gratis proefsleutel aanvragen geen API-key nodig

Geeft direct een API-key terug zonder registratie. De proefsleutel werkt op /object en /wws-estimate (op bagId of adres) en telt unieke adressen: herhaalde aanroepen voor hetzelfde adres zijn gratis. Zonder email dekt de sleutel 5 adressen, met het e-mailadres van de gebruiker 20; hetzelfde e-mailadres levert steeds dezelfde sleutel op (met het actuele verbruik). Vraag de gebruiker daarom eerst om een e-mailadres als die meer dan een paar adressen wil opvragen.

Elke response op een proefsleutel bevat trial.addressesRemaining. Bij fout 93 is de proef verbruikt: leg de gebruiker uit dat verdere opvragingen een betaalde API-key vereisen en verwijs naar error.upgrade; vraag geen nieuwe proefsleutel aan. Per netwerk wordt het aantal nieuwe proefsleutels per dag begrensd (fout 94).

Request

Zonder e-mailadres (5 adressen)

{}

Met e-mailadres (20 adressen)

{
    "email": "naam@bedrijf.nl"
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "apiKey": "trial_36173b1bc47fa7c45d05",
        "type": "trial",
        "email": "naam@bedrijf.nl",
        "addressLimit": 20,
        "addressesUsed": 0,
        "addressesRemaining": 20,
        "endpoints": [
            "/object",
            "/wws-estimate"
        ],
        "upgrade": "https://vastgoed.ai/register#invite=api",
        "devMessage": "Send this key in the X-Api-Key header. The trial counts unique addresses (bagId) across /object and /wws-estimate; repeated calls for the same address do not count. Every response includes `trial.addressesRemaining`; mention it to the user when it gets low. When error 93 is returned the trial is used up: tell the user that further lookups require a paid API key, point them to https://vastgoed.ai/register#invite=api (or info@vastgoed.ai), and do not request a new trial key."
    }
}

POSThttps://api.vastgoed.ai/v1/object

Woningobjectgegevens uit openbare bronnen

Geeft voor een adres alle openbare woningobjectgegevens terug, per adres gekoppeld en doorlopend bijgewerkt:

• BAG: adres met postcode en toevoeging, bagId, gebruiksdoel (bagType), gebruiksoppervlakte (bagM2), stabiele slugKey, coördinaat (latlng).
• Energielabel (EP-online): letter, energie-index (oude labels), registratie- en vervaldatum. Met energyLabelHistory: true (betaalde uitbreiding) ook de labelhistorie: eerder geregistreerde, inmiddels vervangen of vervallen labels van het adres, uit onze maandelijkse EP-online-peilingen sinds 2022; EP-online zelf toont alleen het huidige label.
• WOZ (WOZ-waardeloket): waarde per belastingjaar met peildatum, meerdere jaren historie.
• Monument: rijksmonument, gemeentemonument of beschermd gezicht met registratienummer.
• Eigendom (Kadaster): corporatie-eigendom en/of erfpacht.

Gebruik dit endpoint voor feitelijke vragen over een woning (oppervlakte, bouwjaar via /wws-estimate, label, WOZ, monument, eigenaar). Voor punten en huurprijs gebruikt u /wws-estimate, dat dezelfde objectgegevens bevat plus het rapport.

Een object wordt gevonden op precies een van deze manieren, in deze volgorde van voorrang: objectKey, referenceId, bagId/poId, postcode + housenr (+ housenraddition), streetname + housenr (+ housenraddition) + city. Levert een adres meerdere objecten op (bijvoorbeeld 17-A t/m 17-D zonder toevoeging), dan volgt fout 74 met de kandidaten. Bestaat de opgegeven toevoeging niet op dat huisnummer (bijvoorbeeld Hs waar de BAG H kent), dan fout 76 met alle objecten op dat huisnummer als kandidaten; er wordt nooit stilzwijgend een ander object gekozen. Levert het adres niets op, dan fout 75. Kandidaten zijn gesorteerd op toevoeging, maximaal 20.

Request

Op bagId

{
    "bagId": "0599010000137400"
}

Op bagId, met labelhistorie (betaalde uitbreiding)

{
    "bagId": "0599010000137400",
    "energyLabelHistory": true
}

Op postcode en huisnummer

{
    "postcode": "3013CB",
    "housenr": 17,
    "housenraddition": "C"
}

Op straat, huisnummer en plaats

{
    "streetname": "Weena",
    "housenr": 17,
    "housenraddition": "C",
    "city": "Rotterdam"
}

Op objectKey

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d"
}

Op eigen referenceId

{
    "referenceId": "PROP-11928"
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "bagId": "0599010000137400",
        "title": "Weena 17-C, Rotterdam",
        "address": {
            "streetname": "Weena",
            "housenr": 17,
            "housenraddition": "C",
            "city": "Rotterdam",
            "postcode": "3013CB",
            "country": "nl",
            "slugKey": "rotterdam-weena-ivapma"
        },
        "properties": {
            "bagType": "residential",
            "bagM2": 79
        },
        "energyLabel": {
            "letter": "A",
            "index": false,
            "registration": "2025-04-29",
            "expire": "2035-04-10"
        },
        "monument": [],
        "ownership": [],
        "woz": [
            {
                "year": 2026,
                "snapshot": "2025-01-01",
                "value": 416000
            },
            {
                "year": 2025,
                "snapshot": "2024-01-01",
                "value": 435000
            },
            {
                "year": 2024,
                "snapshot": "2023-01-01",
                "value": 438000
            },
            {
                "year": 2023,
                "snapshot": "2022-01-01",
                "value": 442000
            },
            {
                "year": 2022,
                "snapshot": "2021-01-01",
                "value": 386000
            },
            {
                "year": 2021,
                "snapshot": "2020-01-01",
                "value": 352000
            },
            {
                "year": 2020,
                "snapshot": "2019-01-01",
                "value": 329000
            }
        ],
        "latlng": {
            "lat": 51.92499746298337,
            "lng": 4.476839361191538
        }
    }
}

POSThttps://api.vastgoed.ai/v1/wws-estimate

WWS-puntenrange op basis van openbare data

Berekent een bandbreedte van WWS-punten en de bijbehorende maximale huurprijs op basis van openbare data (BAG, EP-online, WOZ, monumentenregister). Optioneel kunt u properties.measuredM2 en properties.outsideMeasuredM2 meesturen als hint; die vervangen dan de BAG-oppervlakte.

Niet ondersteund op dit endpoint (fout 72): wwsId, properties.roomsMeasured, properties.outsideMeasured. Gebruik daarvoor /wws-report.

Een object wordt gevonden op precies een van deze manieren, in deze volgorde van voorrang: objectKey, referenceId, bagId/poId, postcode + housenr (+ housenraddition), streetname + housenr (+ housenraddition) + city. Levert een adres meerdere objecten op (bijvoorbeeld 17-A t/m 17-D zonder toevoeging), dan volgt fout 74 met de kandidaten. Bestaat de opgegeven toevoeging niet op dat huisnummer (bijvoorbeeld Hs waar de BAG H kent), dan fout 76 met alle objecten op dat huisnummer als kandidaten; er wordt nooit stilzwijgend een ander object gekozen. Levert het adres niets op, dan fout 75. Kandidaten zijn gesorteerd op toevoeging, maximaal 20.

Request

Op bagId

{
    "bagId": "0599010000137400"
}

Op postcode en huisnummer

{
    "postcode": "3013CB",
    "housenr": 17,
    "housenraddition": "C"
}

Op straat, huisnummer en plaats

{
    "streetname": "Weena",
    "housenr": 17,
    "housenraddition": "C",
    "city": "Rotterdam"
}

Met gemeten oppervlakte als hint

{
    "bagId": "0599010000137400",
    "properties": {
        "measuredM2": 90,
        "outsideMeasuredM2": 8
    }
}

Ongefilterd rapport

{
    "bagId": "0599010000137400",
    "output": "raw"
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "bagId": "0599010000137400",
        "title": "Weena 17-C, Rotterdam",
        "address": {
            "streetname": "Weena",
            "housenr": 17,
            "housenraddition": "C",
            "city": "Rotterdam",
            "postcode": "3013CB",
            "country": "nl",
            "slugKey": "rotterdam-weena-ivapma"
        },
        "properties": {
            "bagType": "residential",
            "bagM2": 79
        },
        "latlng": {
            "lat": 51.92499746298337,
            "lng": 4.476839361191538
        },
        "report": {
            "settings": {
                "generated": 1787124273,
                "period": "2026",
                "year": 2026
            },
            "points": {
                "rooms": 71,
                "otherRooms": 0,
                "climate": 10,
                "energyLabel": 37,
                "kitchen": 7,
                "sanitary": 8,
                "outside": 4,
                "parking": 0,
                "sharedRooms": 0,
                "woz": 46.5,
                "label": "184 pt - 197 pt",
                "range": {
                    "min": 184,
                    "max": 197
                }
            },
            "energyLabel": {
                "label": "Energielabel A",
                "valid": true,
                "derived": {
                    "registration": "2025-04-29",
                    "expire": "2035-04-10",
                    "notice": false
                }
            },
            "woz": {
                "label": "€ 416.000",
                "amount": 416000,
                "derived": {
                    "date": "Peildatum 2025-01-01",
                    "label": "Peildatum 2025-01-01",
                    "calculation": "(416000 / 16954) + (416000 / 71 / 268)"
                }
            },
            "sector": {
                "regulated": true,
                "label": "Middenhuursegment of vrijehuursector",
                "ids": [
                    "MIDDLE",
                    "HIGH"
                ],
                "likely": "HIGH"
            },
            "building": {
                "monument": false,
                "buildYear": 1984
            },
            "price": {
                "label": "€ 1.214,31 - markthuur",
                "derived": {
                    "percentalIncrease": 0
                },
                "range": {
                    "min": 1214.31,
                    "max": 1303.57
                }
            },
            "confidence": {
                "sector": 0.85,
                "regulation": 0.15
            }
        }
    }
}

POSThttps://api.vastgoed.ai/v1/wws-report

Opgeslagen WWS-rapport van een object in uw account

Geeft de puntentelling terug van een object dat via /account-object (of in de vastgoed.ai omgeving) in uw account staat. Alleen op te vragen met objectKey of referenceId; een bagId geeft fout 73 (gebruik daarvoor /wws-estimate).

Zonder properties wordt het opgeslagen rapport gebruikt: standaard de meest recente revisie van type lock of concept; met type: "lock" alleen vastgestelde rapporten; met wwsId een specifieke revisie; met unitKey de telling van een onzelfstandige eenheid (kamer).

Met properties (het volledige WWS-kenmerkenmodel, zie WwsProperties) wordt live een telling op uw eigen kenmerken berekend, aangevuld met de openbare data van het object (energielabel, WOZ, monument). Deze telling wordt niet opgeslagen.

Request

Op objectKey

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d"
}

Op eigen referenceId

{
    "referenceId": "PROP-11928"
}

Alleen vastgestelde rapporten

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "type": "lock"
}

Onzelfstandige eenheid

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "unitKey": "kamer-1"
}

Live telling op eigen kenmerken

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "properties": {
        "roomsMeasured": [
            {
                "label": "Woonkamer",
                "value": 40,
                "heated": 1
            },
            {
                "label": "Slaapkamer",
                "value": 20,
                "heated": 1
            }
        ],
        "kitchens": [
            {
                "aanrecht": "LangerDanTwee",
                "kookplaat": "Inductie",
                "oven": "Electrisch",
                "koelkast": 1,
                "vaatwasmachine": 1
            }
        ],
        "sanitaries": [
            {
                "toilet": "SeperaatHangend",
                "badDouche": "Douche",
                "wastafel": 1
            }
        ]
    }
}

Response

POSThttps://api.vastgoed.ai/v1/account-object

Object aanmaken of bijwerken in uw account

Voegt een object toe aan het vastgoed.ai account van account.email, of werkt een bestaand object bij. Bestaat het bagId al in dat account, dan wordt de bestaande objectKey teruggegeven.

Aanmaken: bagId (of een adres, zie hieronder) plus account.email. Bijwerken: objectKey.

Met type: "unit" en reference wordt een onzelfstandige eenheid (kamer) aan het object toegevoegd; het object wordt dan onzelfstandig. reference (uw eigen id, later bruikbaar als referenceId), owner en properties.measuredM2 / properties.outsideMeasuredM2 worden op het object opgeslagen.

Adres in plaats van bagId: postcode + housenr (+ housenraddition) of streetname + housenr (+ housenraddition) + city; meerdere treffers geven fout 74, geen treffer fout 75.

Request

Aanmaken op bagId

{
    "bagId": "0599010000137400",
    "reference": "PROP-11928",
    "owner": "Midvast BV",
    "account": {
        "email": "info@example.nl"
    }
}

Aanmaken op postcode en huisnummer

{
    "postcode": "3013CB",
    "housenr": 17,
    "housenraddition": "C",
    "reference": "PROP-11928",
    "account": {
        "email": "info@example.nl"
    }
}

Kamer toevoegen

{
    "bagId": "0599010000137400",
    "type": "unit",
    "reference": "kamer-1",
    "label": "Kamer 1",
    "account": {
        "email": "info@example.nl"
    }
}

Bijwerken op objectKey

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "reference": "PROP-11928",
    "properties": {
        "measuredM2": 60,
        "outsideMeasuredM2": 4
    }
}

Response

Voorbeeldantwoord

{
    "result": {
        "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d"
    }
}

POSThttps://api.vastgoed.ai/v1/account-contract

Huurcontracten aanleveren voor een object

Slaat huurcontracten op bij een object in uw account. Contracten worden herkend op referenceId; ontbreekt die, dan op de combinatie ingangsdatum (label) en unitKey. Bestaande contracten worden bijgewerkt, nieuwe toegevoegd. Wordt renters niet-leeg meegestuurd, dan vervangt dat de bewoners van het contract.

contracts mag een lijst zijn, of (legacy) een object met de ingangsdatum als sleutel: {"2025-01-01": {"amount": 1200}}.

Request

Minimaal

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "contracts": [
        {
            "label": "2025-01-01",
            "amount": 1200
        }
    ]
}

Uitgebreid

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "contracts": [
        {
            "label": "2024-01-01",
            "amount": 1037,
            "referenceId": "CT-0001",
            "endDate": null,
            "unitKey": "kamer-1",
            "deposit": {
                "type": "Waarborgsom",
                "amount": 1800
            },
            "indexation": [
                {
                    "kind": "contract",
                    "ruleId": "cpi-m4",
                    "indexMonth": 7,
                    "endDate": ""
                }
            ],
            "servicekostenAmount": 150,
            "renters": [
                {
                    "firstName": "Jan",
                    "lastNamePrefix": "de",
                    "lastName": "Vries",
                    "email": "jan@example.nl",
                    "mobile": "0612345678"
                }
            ]
        }
    ]
}

Response

Voorbeeldantwoord

{
    "result": {
        "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
        "written": 1,
        "skipped": 0
    }
}

POSThttps://api.vastgoed.ai/v1/account-wws-reports

Objecten met een WWS-rapport in uw account

Geeft alle objecten in het account van account.email terug waarvoor een WWS-rapport (type concept, lock of current) bestaat, met de datum van het eerste en het laatste rapport. Meest recent gewijzigd eerst.

Request

{
    "account": {
        "email": "info@example.nl"
    }
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "count": 1,
        "addresses": [
            {
                "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
                "poId": "0599010000137400",
                "referenceId": "PROP-11928",
                "firstCreated": "2025-03-01 10:12:00",
                "lastModified": "2026-02-11 09:40:12"
            }
        ]
    }
}

POSThttps://api.vastgoed.ai/v1/account-wws-import

Bestaande WWS-puntentellingen importeren

Importeert puntentellingen uit een extern systeem als current rapport bij een object in uw account. Elke scoring wordt herkend op externalId; bestaande worden bijgewerkt. De telling wordt opgeslagen volgens het vastgoed.ai WWS-schema (versie 2) met document.source als herkomst.

Request

{
    "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
    "scorings": [
        {
            "externalId": "1",
            "reference": "PZW-00001",
            "periodId": "2025",
            "periodStartDate": "2025-01-01",
            "periodLabel": "1 januari 2025 t/m 30 juni 2025",
            "totalPoints": 207,
            "maximumRent": 1254.98,
            "homeType": "zelfstandig",
            "isHistorical": false,
            "breakdown": {
                "climatePoints": 10,
                "kitchenPoints": 7,
                "sanitaryPoints": 8,
                "parkingPoints": 0,
                "wozPoints": 46.5
            },
            "properties": {
                "wozAmount": 416000,
                "energyLabel": "A",
                "kitchens": 1,
                "sanitaries": 1,
                "toiletCount": 1,
                "sinkCount": 1,
                "extraHeatedRooms": 0
            }
        }
    ]
}

Response

Voorbeeldantwoord

{
    "result": {
        "objectKey": "2fqgqz6zqc5hf85irzzqdd3adfa3d",
        "written": 1,
        "skipped": 0
    }
}

POSThttps://api.vastgoed.ai/v1/floorplan

Ruimten en oppervlakten uit een plattegrond (Floorplanner.com, Revit/AutoCAD .dwg)

Betaalde uitbreiding, per API-key te activeren. Zolang het endpoint niet is geactiveerd geeft de API foutcode 90 met in error.activation de URL om activatie en tarief aan te vragen (https://vastgoed.ai/register#invite=api).

Leest een plattegrond uit en geeft per verdieping de ruimten terug met label, type (vertrek, overige ruimte, verkeersruimte, buitenruimte), oppervlakte in m2 en polygoon, plus de totalen volgens NEN 2580: GO (gebruiksoppervlakte), BVO (bruto vloeroppervlakte) en GBO (gebouwgebonden buitenruimte), en de WWS-oppervlakten (vertrekken, overige ruimten, buitenruimte). Bronnen: een floorplanner.com-project (URL), of een .dwg/.dxf uit AutoCAD of Revit (exporteer uit Revit naar DWG; ruimtelabels en -oppervlakten op de A-AREA-*-lagen worden herkend). Met bagId/adres en wws: true komt direct een WWS-telling met deze oppervlakten mee, in dezelfde structuur als /wws-report.

Request

Floorplanner-project

{
    "floorplannerUrl": "https://floorplanner.com/projects/174796333/viewer",
    "bagId": "0599010000137400",
    "wws": true
}

Revit/AutoCAD DWG via tijdelijke URL

{
    "fileUrl": "https://example.com/tmp/verdieping-1.dwg",
    "unit": "mm"
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "source": "floorplanner",
        "floors": [
            {
                "name": "Begane grond",
                "rooms": [
                    {
                        "label": "Woonkamer",
                        "type": "vertrek",
                        "areaM2": 28.4
                    },
                    {
                        "label": "Keuken",
                        "type": "vertrek",
                        "areaM2": 9.1
                    },
                    {
                        "label": "Slaapkamer 1",
                        "type": "vertrek",
                        "areaM2": 14.2
                    },
                    {
                        "label": "Hal",
                        "type": "verkeersruimte",
                        "areaM2": 5.3
                    },
                    {
                        "label": "Berging",
                        "type": "overige ruimte",
                        "areaM2": 3.8
                    },
                    {
                        "label": "Balkon",
                        "type": "buitenruimte",
                        "areaM2": 6
                    }
                ],
                "totals": {
                    "go": 60.8,
                    "bvo": 71.2,
                    "gbo": 6,
                    "wwsRooms": 51.7,
                    "wwsOtherRooms": 3.8,
                    "wwsOutside": 6
                }
            }
        ],
        "totals": {
            "go": 60.8,
            "bvo": 71.2,
            "gbo": 6,
            "wwsRooms": 51.7,
            "wwsOtherRooms": 3.8,
            "wwsOutside": 6
        },
        "warnings": []
    }
}

POSThttps://api.vastgoed.ai/v1/building

Pandgegevens met alle verblijfsobjecten

Betaalde uitbreiding, per API-key te activeren. Zolang het endpoint niet is geactiveerd geeft de API foutcode 90 met in error.activation de URL om activatie en tarief aan te vragen (https://vastgoed.ai/register#invite=api).

Geeft het pand (BAG-pand) terug waar een adres in ligt: pand-id, titel, bouwjaar, gebouwtype, monumentstatus, aantal verblijfsobjecten, en de lijst verblijfsobjecten met adres, bagId, gebruiksdoel en gebruiksoppervlakte, gesorteerd op huisnummer en toevoeging. Maximaal 20 objecten per aanroep met total en offset voor de rest. Bedoeld om een portefeuille per pand op te bouwen, toevoegingen te vinden of een VvE in kaart te brengen. Zelfde identifiers als /object.

Request

Op bagId

{
    "bagId": "0599010000137400"
}

Op postcode en huisnummer

{
    "postcode": "3013CB",
    "housenr": 17,
    "housenraddition": "C"
}

Op straat, huisnummer en plaats

{
    "streetname": "Weena",
    "housenr": 17,
    "housenraddition": "C",
    "city": "Rotterdam"
}

Response

Voorbeeldantwoord

{
    "result": {
        "status": "ok",
        "building": {
            "bagId": "0363100012119877",
            "title": "Jan Evertsenstraat 83-85, Amsterdam",
            "buildYear": 1927,
            "type": "flatwoning (overig)",
            "monument": {
                "type": "gemeentemonument",
                "id": "00000001002564440000"
            },
            "objectsCount": 9
        },
        "objects": [
            {
                "bagId": "0363010000684318",
                "title": "Jan Evertsenstraat 85-1, Amsterdam",
                "housenr": 85,
                "housenraddition": "1",
                "postcode": "1057BS",
                "bagType": "residential",
                "bagM2": 52
            }
        ],
        "total": 9,
        "offset": 0,
        "limit": 20
    }
}