> For the complete documentation index, see [llms.txt](https://docs.matrixian.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.matrixian.com/waarderen-en-taxeren/woningwaarde-api.md).

# Woningwaarde API

Bent u geïnteresseerd in de exacte, actuele waarde van een woning op dit moment zonder verdere poespas? Dan is dit de oplossing die u zoekt. Dit endpoint geeft de waarde terug van elk (woon)object in Nederland zoals bepaald door ons AVM model. Dit Machine Learning model bepaalt aan de hand van tientallen pand- en omgevingseigenschappen zeer nauwkeurig de marktwaarde van de woning

### Voor wie is het?

* U bent op zoek naar een accurate woningwaarde maar hebt geen interesse in verdere metadata
* Ideaal voor bijvoorbeeld lead generation op uw website vanwege de lage kosten en beperkte benodigde bandbreedte.

### Wat moet ik weten?

* Het Matrixian AVM is gerenommeerd en wordt gebruikt door verschillende brancheorganisaties in de taxatie- en makelaarswereld
* Het model wordt continu beoordeeld en verbeterd zodat we nooit achterlopen op de markt en u zeker bent van betrouwbare informatie
* Locatie, locatie, locatie! Prijstrends, referentieverkopen en gebiedskenmerken worden allemaal meegenomen in het model

## GET /homevalue/value

> Returns the market value prediction.

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"1.0.0"},"servers":[{"url":"https://api.matrixian.com/v1","description":"Matrixian API"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"{{API_KEY}}"}},"schemas":{"HomeValueInput":{"properties":{"postalCode":{"type":"string","title":"Postalcode","description":"Postal code"},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumberExt":{"title":"Housenumberext","description":"House number extension","type":"string","nullable":true},"buildType":{"description":"Type of dwelling","allOf":[{"$ref":"#/components/schemas/HouseType"}]},"buildYear":{"type":"integer","title":"Buildyear","description":"Indication of the year in which the building will originally be delivered in, or is architecturally ready. Also known as construction year."},"useSurface":{"type":"integer","title":"Usesurface","description":"The usable surface area of a property object in m2."},"parcelSurface":{"title":"Parcelsurface","description":"The lot/parcel surface in m2.","type":"integer","nullable":true},"volume":{"title":"Volume","description":"Volume in m3.","type":"integer","nullable":true},"numberOfRooms":{"title":"Numberofrooms","description":"Number of rooms.","type":"integer","nullable":true},"energyLabel":{"description":"A label indicating how well the property object is insulated.","$ref":"#/components/schemas/EnergyLabel","nullable":true},"monument":{"title":"Monument","description":"Boolean indicating whether the house is a monument.","default":false,"type":"boolean","nullable":true},"valuationDate":{"type":"string","format":"date","title":"Valuationdate","description":"Valuation date","default":"2026-08-21"}},"type":"object","required":["postalCode","houseNumber","buildType","buildYear","useSurface"],"title":"HomeValueInput"},"HouseType":{"enum":["Appartement","Galerijflat","Maisonnette","Portiekwoning","Portiekflat","Corridorflat","Bovenwoning","Benedenwoning","Tussenwoning","Geschakelde woning","Eindwoning","Hoekwoning","2-onder-1-kapwoning","Geschakelde 2-onder-1-kapwoning","Halfvrijstaande woning","Vrijstaande woning"],"title":"HouseType","type":"string"},"EnergyLabel":{"enum":["A+++++","A++++","A+++","A++","A+","A","B","C","D","E","F","G"],"title":"EnergyLabel","type":"string"},"HomevalueValueResponse":{"properties":{"weightedValue":{"type":"integer","title":"Weightedvalue","description":"Automated valuation model (AVM) estimate of the property value OR indexed transaction price or WOZ value when that's a better estimate."},"confidenceClass":{"title":"Confidenceclass","description":"Confidence class of the valuation (5 = highest confidence, 0 = lowest confidence).","type":"integer","nullable":true}},"type":"object","required":["weightedValue"],"title":"HomevalueValueResponse"},"ErrorObject":{"properties":{"code":{"type":"integer","title":"Code"},"message":{"type":"string","title":"Message"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array","title":"Errors"}},"type":"object","required":["code","message","errors"],"title":"ErrorObject"},"ErrorDetail":{"properties":{"reason":{"type":"string","title":"Reason"},"message":{"type":"string","title":"Message"}},"type":"object","required":["reason","message"],"title":"ErrorDetail"}}},"paths":{"/homevalue/value":{"get":{"description":"Returns the market value prediction.","operationId":"homevalueValue","parameters":[{"description":"Postal code","required":true,"style":"form","explode":true,"schema":{"type":"string"},"name":"postalCode","in":"query"},{"description":"House number","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"houseNumber","in":"query"},{"description":"House letter","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseLetter","in":"query"},{"description":"House number extension","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseNumberExt","in":"query"},{"description":"Type of dwelling","required":true,"style":"form","explode":true,"schema":{"type":"string","enum":["Appartement","Galerijflat","Maisonnette","Portiekwoning","Portiekflat","Corridorflat","Bovenwoning","Benedenwoning","Tussenwoning","Geschakelde woning","Eindwoning","Hoekwoning","2-onder-1-kapwoning","Geschakelde 2-onder-1-kapwoning","Halfvrijstaande woning","Vrijstaande woning"]},"name":"buildType","in":"query"},{"description":"Indication of the year in which the building will originally be delivered in, or is architecturally ready. Also known as construction year.","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"buildYear","in":"query"},{"description":"The usable surface area of a property object in m2.","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"useSurface","in":"query"},{"description":"The lot/parcel surface in m2.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"parcelSurface","in":"query"},{"description":"Volume in m3.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"volume","in":"query"},{"description":"Number of rooms.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"numberOfRooms","in":"query"},{"description":"A label indicating how well the property object is insulated.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["A+++++","A++++","A+++","A++","A+","A","B","C","D","E","F","G"]},"name":"energyLabel","in":"query"},{"description":"Boolean indicating whether the house is a monument.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false},"name":"monument","in":"query"},{"description":"Valuation date","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","default":"2026-08-21"},"name":"valuationDate","in":"query"}],"responses":{"200":{"description":"HomevalueValueResponse","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"$ref":"#/components/schemas/HomevalueValueResponse"},"error":{"additionalProperties":{"type":"string"},"type":"object"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["data","status"]}}}},"400":{"description":"HTTP 400","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"401":{"description":"HTTP 401","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"403":{"description":"HTTP 403","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object","required":["message"]}}}},"404":{"description":"HTTP 404","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"500":{"description":"HTTP 500","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}}}}}}}
```

## The HomevalueValueResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"1.0.0"},"components":{"schemas":{"HomevalueValueResponse":{"properties":{"weightedValue":{"type":"integer","title":"Weightedvalue","description":"Automated valuation model (AVM) estimate of the property value OR indexed transaction price or WOZ value when that's a better estimate."},"confidenceClass":{"title":"Confidenceclass","description":"Confidence class of the valuation (5 = highest confidence, 0 = lowest confidence).","type":"integer","nullable":true}},"type":"object","required":["weightedValue"],"title":"HomevalueValueResponse"}}}}
```

## GET /homevalue/available

> Check if home value data is available for a specific object. This can be used to check availability before making a call to the Homevalue API's.

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"1.0.0"},"servers":[{"url":"https://api.matrixian.com/v1","description":"Matrixian API"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"{{API_KEY}}"}},"schemas":{"HomeValueInput":{"properties":{"postalCode":{"type":"string","title":"Postalcode","description":"Postal code"},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumberExt":{"title":"Housenumberext","description":"House number extension","type":"string","nullable":true},"buildType":{"description":"Type of dwelling","allOf":[{"$ref":"#/components/schemas/HouseType"}]},"buildYear":{"type":"integer","title":"Buildyear","description":"Indication of the year in which the building will originally be delivered in, or is architecturally ready. Also known as construction year."},"useSurface":{"type":"integer","title":"Usesurface","description":"The usable surface area of a property object in m2."},"parcelSurface":{"title":"Parcelsurface","description":"The lot/parcel surface in m2.","type":"integer","nullable":true},"volume":{"title":"Volume","description":"Volume in m3.","type":"integer","nullable":true},"numberOfRooms":{"title":"Numberofrooms","description":"Number of rooms.","type":"integer","nullable":true},"energyLabel":{"description":"A label indicating how well the property object is insulated.","$ref":"#/components/schemas/EnergyLabel","nullable":true},"monument":{"title":"Monument","description":"Boolean indicating whether the house is a monument.","default":false,"type":"boolean","nullable":true},"valuationDate":{"type":"string","format":"date","title":"Valuationdate","description":"Valuation date","default":"2026-08-21"}},"type":"object","required":["postalCode","houseNumber","buildType","buildYear","useSurface"],"title":"HomeValueInput"},"HouseType":{"enum":["Appartement","Galerijflat","Maisonnette","Portiekwoning","Portiekflat","Corridorflat","Bovenwoning","Benedenwoning","Tussenwoning","Geschakelde woning","Eindwoning","Hoekwoning","2-onder-1-kapwoning","Geschakelde 2-onder-1-kapwoning","Halfvrijstaande woning","Vrijstaande woning"],"title":"HouseType","type":"string"},"EnergyLabel":{"enum":["A+++++","A++++","A+++","A++","A+","A","B","C","D","E","F","G"],"title":"EnergyLabel","type":"string"},"HomevalueAvailableResponse":{"properties":{"available":{"type":"boolean","title":"Available","description":"Boolean indicating whether a home value estimate is available for this property."}},"type":"object","required":["available"],"title":"HomevalueAvailableResponse"},"ErrorObject":{"properties":{"code":{"type":"integer","title":"Code"},"message":{"type":"string","title":"Message"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array","title":"Errors"}},"type":"object","required":["code","message","errors"],"title":"ErrorObject"},"ErrorDetail":{"properties":{"reason":{"type":"string","title":"Reason"},"message":{"type":"string","title":"Message"}},"type":"object","required":["reason","message"],"title":"ErrorDetail"}}},"paths":{"/homevalue/available":{"get":{"description":"Check if home value data is available for a specific object. This can be used to check availability before making a call to the Homevalue API's.","operationId":"homevalueAvailable","parameters":[{"description":"Postal code","required":true,"style":"form","explode":true,"schema":{"type":"string"},"name":"postalCode","in":"query"},{"description":"House number","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"houseNumber","in":"query"},{"description":"House letter","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseLetter","in":"query"},{"description":"House number extension","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseNumberExt","in":"query"},{"description":"Type of dwelling","required":true,"style":"form","explode":true,"schema":{"type":"string","enum":["Appartement","Galerijflat","Maisonnette","Portiekwoning","Portiekflat","Corridorflat","Bovenwoning","Benedenwoning","Tussenwoning","Geschakelde woning","Eindwoning","Hoekwoning","2-onder-1-kapwoning","Geschakelde 2-onder-1-kapwoning","Halfvrijstaande woning","Vrijstaande woning"]},"name":"buildType","in":"query"},{"description":"Indication of the year in which the building will originally be delivered in, or is architecturally ready. Also known as construction year.","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"buildYear","in":"query"},{"description":"The usable surface area of a property object in m2.","required":true,"style":"form","explode":true,"schema":{"type":"integer"},"name":"useSurface","in":"query"},{"description":"The lot/parcel surface in m2.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"parcelSurface","in":"query"},{"description":"Volume in m3.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"volume","in":"query"},{"description":"Number of rooms.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"numberOfRooms","in":"query"},{"description":"A label indicating how well the property object is insulated.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["A+++++","A++++","A+++","A++","A+","A","B","C","D","E","F","G"]},"name":"energyLabel","in":"query"},{"description":"Boolean indicating whether the house is a monument.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false},"name":"monument","in":"query"},{"description":"Valuation date","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","default":"2026-08-21"},"name":"valuationDate","in":"query"}],"responses":{"200":{"description":"HomevalueAvailableResponse","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"$ref":"#/components/schemas/HomevalueAvailableResponse"},"error":{"additionalProperties":{"type":"string"},"type":"object"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["data","status"]}}}},"400":{"description":"HTTP 400","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"401":{"description":"HTTP 401","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"403":{"description":"HTTP 403","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object","required":["message"]}}}},"404":{"description":"HTTP 404","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}},"500":{"description":"HTTP 500","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/HomeValueInput"},"data":{"additionalProperties":{"type":"string"},"type":"object"},"error":{"$ref":"#/components/schemas/ErrorObject"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["error","status"]}}}}}}}}}
```

## The HomevalueAvailableResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"1.0.0"},"components":{"schemas":{"HomevalueAvailableResponse":{"properties":{"available":{"type":"boolean","title":"Available","description":"Boolean indicating whether a home value estimate is available for this property."}},"type":"object","required":["available"],"title":"HomevalueAvailableResponse"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.matrixian.com/waarderen-en-taxeren/woningwaarde-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
