> 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/leadtool-api.md).

# Leadtool API

## GET /leadtool

> Offer a free home valuation report to website visitors.

```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":{"LeadToolInput":{"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},"type":{"description":"Type of dwelling","$ref":"#/components/schemas/HouseType","nullable":true},"buildYear":{"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.","type":"integer","nullable":true},"use_surface":{"title":"Use Surface","description":"The usable surface area of a property object in m2.","type":"integer","nullable":true},"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-06-08"}},"type":"object","required":["postalCode","houseNumber"],"title":"LeadToolInput"},"HouseType":{"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"],"title":"HouseType"},"EnergyLabel":{"type":"string","enum":["A+++++","A++++","A+++","A++","A+","A","B","C","D","E","F","G"],"title":"EnergyLabel"},"LeadtoolResponse":{"properties":{"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseNumberExt":{"title":"Housenumberext","description":"House number extension","type":"string","nullable":true},"postalCode":{"type":"string","title":"Postalcode","description":"Postal code"},"references":{"items":{"$ref":"#/components/schemas/LeadtoolReferenceModel"},"type":"array","maxItems":3,"title":"References","description":"List of reference objects."},"weightedValueRange":{"type":"string","title":"Weightedvaluerange","description":"Range for the automated valuation model (AVM) estimate of the property value"}},"type":"object","required":["houseNumber","postalCode","references","weightedValueRange"],"title":"LeadtoolResponse"},"LeadtoolReferenceModel":{"properties":{"city":{"description":"City","title":"City","type":"string"},"houseNumber":{"description":"House number","title":"Housenumber","type":"integer"},"houseNumberExt":{"default":null,"description":"House number extension","title":"Housenumberext","type":"string","nullable":true},"latitude":{"description":"Latitude","title":"Latitude","type":"number"},"longitude":{"description":"Longitude","title":"Longitude","type":"number"},"postalCode":{"description":"Postal code","title":"Postalcode","type":"string"},"street":{"description":"Street name","title":"Street","type":"string"}},"required":["city","houseNumber","latitude","longitude","postalCode","street"],"title":"LeadtoolReferenceModel","type":"object"},"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":{"/leadtool":{"get":{"description":"Offer a free home valuation report to website visitors.","operationId":"leadtool","parameters":[{"description":"Postal code","required":true,"style":"form","explode":true,"schema":{"type":"string"},"name":"postcode","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":false,"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":"type","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":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"buildYear","in":"query"},{"description":"The usable surface area of a property object in m2.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"name":"use_surface","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-06-08"},"name":"valuationDate","in":"query"}],"responses":{"200":{"description":"LeadtoolResponse","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","nullable":true},"params":{"$ref":"#/components/schemas/LeadToolInput"},"data":{"$ref":"#/components/schemas/LeadtoolResponse"},"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/LeadToolInput"},"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/LeadToolInput"},"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/LeadToolInput"},"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/LeadToolInput"},"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 LeadtoolResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"1.0.0"},"components":{"schemas":{"LeadtoolResponse":{"properties":{"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseNumberExt":{"title":"Housenumberext","description":"House number extension","type":"string","nullable":true},"postalCode":{"type":"string","title":"Postalcode","description":"Postal code"},"references":{"items":{"$ref":"#/components/schemas/LeadtoolReferenceModel"},"type":"array","maxItems":3,"title":"References","description":"List of reference objects."},"weightedValueRange":{"type":"string","title":"Weightedvaluerange","description":"Range for the automated valuation model (AVM) estimate of the property value"}},"type":"object","required":["houseNumber","postalCode","references","weightedValueRange"],"title":"LeadtoolResponse"},"LeadtoolReferenceModel":{"properties":{"city":{"description":"City","title":"City","type":"string"},"houseNumber":{"description":"House number","title":"Housenumber","type":"integer"},"houseNumberExt":{"default":null,"description":"House number extension","title":"Housenumberext","type":"string","nullable":true},"latitude":{"description":"Latitude","title":"Latitude","type":"number"},"longitude":{"description":"Longitude","title":"Longitude","type":"number"},"postalCode":{"description":"Postal code","title":"Postalcode","type":"string"},"street":{"description":"Street name","title":"Street","type":"string"}},"required":["city","houseNumber","latitude","longitude","postalCode","street"],"title":"LeadtoolReferenceModel","type":"object"}}}}
```


---

# 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:

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

The question should be specific, self-contained, and written in natural language.
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.