# Koopsom API

## GET /mx-transaction-finder

> Returns a list of reference objects and their transaction prices.

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"servers":[{"url":"https://api.matrixian.com/v1","description":"Matrixian API"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"{{API_KEY}}"}},"schemas":{"TransactionFinderResponse":{"properties":{"postalCode":{"type":"string","title":"Postalcode","description":"Zipcode"},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumberExt":{"title":"Housenumberext","description":"House number extention","type":"string","nullable":true},"saleDate":{"title":"Saledate","description":"Sale date","type":"string","format":"date","nullable":true},"transportDate":{"type":"string","format":"date","title":"Transportdate","description":"Transport date"},"transactionDate":{"type":"string","format":"date","title":"Transactiondate","description":"Transaction date"},"transactionPrice":{"type":"integer","title":"Transactionprice","description":"Transaction price"},"transactionPriceIndexed":{"type":"integer","title":"Transactionpriceindexed","description":"The price of the transaction, indexed to the valuation date."},"transactionPriceIndexedDateTransport":{"type":"integer","title":"Transactionpriceindexeddatetransport","description":"The price of the transaction, indexed to the transport date."},"transactionPriceIndexedDateSale":{"title":"Transactionpriceindexeddatesale","description":"The price of the transaction, indexed to the sale date.","type":"integer","nullable":true},"valuationDate":{"type":"string","format":"date","title":"Valuationdate","description":"Valuation date"}},"type":"object","required":["postalCode","houseNumber","saleDate","transportDate","transactionDate","transactionPrice","transactionPriceIndexed","transactionPriceIndexedDateTransport","transactionPriceIndexedDateSale","valuationDate"],"title":"TransactionFinderResponse"},"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":{"/mx-transaction-finder":{"get":{"description":"Returns a list of reference objects and their transaction prices.","operationId":"transactionFinder","parameters":[{"description":"Zipcode","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 extention","required":false,"style":"form","explode":true,"schema":{"type":"string"},"name":"houseNumberExt","in":"query"},{"description":"Valuation date","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","default":"2025-11-10"},"name":"valuationDate","in":"query"},{"description":"The acceptance date is the date on which you, as a buyer, become the owner of the house.","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date"},"name":"dateTransport","in":"query"}],"responses":{"200":{"description":"TransactionFinderResponse","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"data":{"$ref":"#/components/schemas/TransactionFinderResponse"},"error":{"additionalProperties":{"type":"string"},"type":"object"},"meta":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"status":{"type":"string"}},"type":"object","required":["data","status"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"400":{"description":"HTTP 400","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"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"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"401":{"description":"HTTP 401","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"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"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"403":{"description":"HTTP 403","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"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"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"404":{"description":"HTTP 404","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"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"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}},"500":{"description":"HTTP 500","content":{"application/json":{"schema":{"properties":{"statusCode":{"type":"integer"},"headers":{"additionalProperties":{"type":"string"},"type":"object","description":"HTTP headers returned by Lambda/API Gateway."},"isBase64Encoded":{"type":"boolean"},"body":{"properties":{"id":{"type":"string","nullable":true},"params":{"additionalProperties":{"type":"string"},"type":"object","nullable":true},"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"]}},"type":"object","required":["statusCode","headers","isBase64Encoded","body"]}}}}}}}}}
```

## The TransactionFinderResponse object

```json
{"openapi":"3.0.3","info":{"title":"Matrixian API","version":"0.0.1"},"components":{"schemas":{"TransactionFinderResponse":{"properties":{"postalCode":{"type":"string","title":"Postalcode","description":"Zipcode"},"houseNumber":{"type":"integer","title":"Housenumber","description":"House number"},"houseLetter":{"title":"Houseletter","description":"House letter","type":"string","nullable":true},"houseNumberExt":{"title":"Housenumberext","description":"House number extention","type":"string","nullable":true},"saleDate":{"title":"Saledate","description":"Sale date","type":"string","format":"date","nullable":true},"transportDate":{"type":"string","format":"date","title":"Transportdate","description":"Transport date"},"transactionDate":{"type":"string","format":"date","title":"Transactiondate","description":"Transaction date"},"transactionPrice":{"type":"integer","title":"Transactionprice","description":"Transaction price"},"transactionPriceIndexed":{"type":"integer","title":"Transactionpriceindexed","description":"The price of the transaction, indexed to the valuation date."},"transactionPriceIndexedDateTransport":{"type":"integer","title":"Transactionpriceindexeddatetransport","description":"The price of the transaction, indexed to the transport date."},"transactionPriceIndexedDateSale":{"title":"Transactionpriceindexeddatesale","description":"The price of the transaction, indexed to the sale date.","type":"integer","nullable":true},"valuationDate":{"type":"string","format":"date","title":"Valuationdate","description":"Valuation date"}},"type":"object","required":["postalCode","houseNumber","saleDate","transportDate","transactionDate","transactionPrice","transactionPriceIndexed","transactionPriceIndexedDateTransport","transactionPriceIndexedDateSale","valuationDate"],"title":"TransactionFinderResponse"}}}}
```