Authenticatie, invoer en resultaat
Huur Referentie API
POST https://api.altum.ai/rental-reference
Post het adres en optionele parameters
Headers
| Name | Type | Description |
|---|---|---|
x-api-key* | String | API-sleutel van Altum. Maak er een via Mopsus(https://mopsus.altum.ai) |
Content-Type | String | application/json |
Request Body
| Name | Type | Description |
|---|---|---|
postcode* | String | 1234AB |
housenumber* | Number | 1 |
houseaddition | String | A |
innersurfacearea | Number | Elk getal groter dan nul |
reference_number | Number | Van 10 tot 30 |
date_limit | Number | Tussen 6 en 60 maanden zoekgeschiedenis van transacties |
window_limit | Boolean | 1 als u de referenties alleen uit het doelvenster wilt halen |
furnished | Boolean | 1 als u wilt dat de referenties hetzelfde hebben als het doel (indien aanwezig) |
Garden | Boolean | 1 als u wilt dat de referenties de waarde hebben voor tuin met het doel (indien aanwezig) |
{
"GivenHouse": {
"PostCode": "6942HE",
"HouseNumber": 56,
"HouseAddition": null,
"ValuationDate": 20231125,
"InnerSurfaceArea": 140,
"OuterSurfaceArea": 360,
"HouseType": "Vrijstaande woning",
"BuildYear": 1960,
"EnergyLabel": {
"DefinitiveEnergyLabel": "E",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2030-10"
},
"Image": "https://cloud.funda.nl/valentina_media/165/982/890_720x480.jpg"
},
"Inputs": {
"StrictStreet": 0,
"StrictBuurt": 0,
"StrictWijk": 0,
"StrictEnergyLabel": 0,
"ComparableHouseType": 0,
"ComparableInnerSurfaceArea": 0,
"ComparableBuildYear": 0,
"ComparableDistance": 0,
"DateLimit": 60
},
"ReferenceData": {
"ReferencePriceMean": "350000-375000",
"ReferenceHouses": [
{
"PostCode": "6566XN",
"HouseNumber": 2,
"HouseAddition": null,
"Street": "Burgemeester Reijmersstraat",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Geschakelde woning",
"BuildYear": 1955,
"InnerSurfaceArea": 171,
"OuterSurfaceArea": 305,
"Volume": 598.0,
"DefinitiveEnergyLabel": "A",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2027-09",
"Longitude": 6.051181765879782,
"Latitude": 51.861647149194276,
"Transactiondate": 201909,
"TimeForSaleDays": null,
"Image": "https://cloud.funda.nl/valentina_media/085/383/417_1440.jpg",
"TransactionPrice": "275000-300000",
"IndexedTransactionPrice": "400000-450000",
"PriceIndex": 128.5,
"Distance": 10616,
"VisualSimilarityScore": 84.178,
"Weight": 1.0
},
{
"PostCode": "6566AA",
"HouseNumber": 9,
"HouseAddition": null,
"Street": "Burgemeester Hermsenstraat",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Hoekwoning",
"BuildYear": 1971,
"InnerSurfaceArea": 110,
"OuterSurfaceArea": 269,
"Volume": 385.0,
"DefinitiveEnergyLabel": null,
"DefinitiveType": null,
"DefinitiveValidity": null,
"Longitude": 6.05011576095955,
"Latitude": 51.86221046589032,
"Transactiondate": 202007,
"TimeForSaleDays": null,
"Image": "https://cloud.funda.nl/valentina_media/127/400/732_1440x960.jpg",
"TransactionPrice": "225000-250000",
"IndexedTransactionPrice": "275000-300000",
"PriceIndex": 139.2,
"Distance": 10616,
"VisualSimilarityScore": 82.376,
"Weight": 0.978
},
{
"PostCode": "6566ZT",
"HouseNumber": 7,
"HouseAddition": null,
"Street": "Dennenstraat",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Hoekwoning",
"BuildYear": 1979,
"InnerSurfaceArea": 84,
"OuterSurfaceArea": 203,
"Volume": 294.0,
"DefinitiveEnergyLabel": "C",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2028-11",
"Longitude": 6.0548413275038975,
"Latitude": 51.859765755682105,
"Transactiondate": 201903,
"TimeForSaleDays": null,
"Image": "https://cloud.funda.nl/valentina_media/086/290/288_1440x960.jpg",
"TransactionPrice": "150000-175000",
"IndexedTransactionPrice": "250000-275000",
"PriceIndex": 124.9,
"Distance": 10615,
"VisualSimilarityScore": 75.15,
"Weight": 0.891
},
{
"PostCode": "6942HS",
"HouseNumber": 16,
"HouseAddition": null,
"Street": "Liemersweg",
"BuurtCode": "BU19550203",
"WijkCode": "WK195502",
"City": "Didam",
"HouseType": "2 onder 1 kap woning",
"BuildYear": 1957,
"InnerSurfaceArea": 119,
"OuterSurfaceArea": 540,
"Volume": 409.0,
"DefinitiveEnergyLabel": "D",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2030-11",
"Longitude": 6.152381715356643,
"Latitude": 51.933182786208704,
"Transactiondate": 202104,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "250000-275000",
"IndexedTransactionPrice": "300000-325000",
"PriceIndex": 155.4,
"Distance": 84,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "6566AA",
"HouseNumber": 5,
"HouseAddition": null,
"Street": "Burgemeester Hermsenstraat",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Tussenwoning",
"BuildYear": 1971,
"InnerSurfaceArea": 103,
"OuterSurfaceArea": 149,
"Volume": 363.0,
"DefinitiveEnergyLabel": null,
"DefinitiveType": null,
"DefinitiveValidity": null,
"Longitude": 6.050000952095453,
"Latitude": 51.862300999960034,
"Transactiondate": 201910,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "125000-150000",
"IndexedTransactionPrice": "200000-225000",
"PriceIndex": 130.3,
"Distance": 10614,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "6566XD",
"HouseNumber": 17,
"HouseAddition": null,
"Street": "Wethouder Koenenstraat",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "2 onder 1 kap woning",
"BuildYear": 1948,
"InnerSurfaceArea": 182,
"OuterSurfaceArea": 427,
"Volume": null,
"DefinitiveEnergyLabel": null,
"DefinitiveType": null,
"DefinitiveValidity": null,
"Longitude": 6.050890939815937,
"Latitude": 51.86180598611541,
"Transactiondate": 201906,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "175000-200000",
"IndexedTransactionPrice": "250000-275000",
"PriceIndex": 126.4,
"Distance": 10615,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "7009CR",
"HouseNumber": 30,
"HouseAddition": null,
"Street": "Bloemersstraat",
"BuurtCode": "BU02220904",
"WijkCode": "WK022209",
"City": "Doetinchem",
"HouseType": "Hoekwoning",
"BuildYear": 1950,
"InnerSurfaceArea": 128,
"OuterSurfaceArea": 395,
"Volume": 448.0,
"DefinitiveEnergyLabel": "C",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2030-02",
"Longitude": 6.2905459609860666,
"Latitude": 51.97695144905982,
"Transactiondate": 202008,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "300000-325000",
"IndexedTransactionPrice": "400000-450000",
"PriceIndex": 139.2,
"Distance": 10616,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "6566EV",
"HouseNumber": 140,
"HouseAddition": null,
"Street": "Heerbaan",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Vrijstaande woning",
"BuildYear": 1976,
"InnerSurfaceArea": 250,
"OuterSurfaceArea": 843,
"Volume": null,
"DefinitiveEnergyLabel": "B",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2032-07",
"Longitude": 6.04799884793402,
"Latitude": 51.86338192770656,
"Transactiondate": 202306,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "600000-650000",
"IndexedTransactionPrice": "600000-650000",
"PriceIndex": 182.3,
"Distance": 10616,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "6566XA",
"HouseNumber": 3,
"HouseAddition": null,
"Street": "Acaciahof",
"BuurtCode": "BU19450900",
"WijkCode": "WK194509",
"City": "Millingen aan de Rijn",
"HouseType": "Tussenwoning",
"BuildYear": 1979,
"InnerSurfaceArea": 106,
"OuterSurfaceArea": 165,
"Volume": 362.0,
"DefinitiveEnergyLabel": "D",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2028-11",
"Longitude": 6.055114592952519,
"Latitude": 51.85959341801129,
"Transactiondate": 201811,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "150000-175000",
"IndexedTransactionPrice": "225000-250000",
"PriceIndex": 123.1,
"Distance": 10618,
"VisualSimilarityScore": null,
"Weight": 0.0
},
{
"PostCode": "7009CC",
"HouseNumber": 52,
"HouseAddition": null,
"Street": "Zandstraat",
"BuurtCode": "BU02220903",
"WijkCode": "WK022209",
"City": "Doetinchem",
"HouseType": "Tussenwoning",
"BuildYear": 1960,
"InnerSurfaceArea": 112,
"OuterSurfaceArea": 182,
"Volume": 352.0,
"DefinitiveEnergyLabel": "E",
"DefinitiveType": "NEN7120",
"DefinitiveValidity": "2030-10",
"Longitude": 6.285970438505862,
"Latitude": 51.98227174501624,
"Transactiondate": 202012,
"TimeForSaleDays": null,
"Image": null,
"TransactionPrice": "175000-200000",
"IndexedTransactionPrice": "225000-250000",
"PriceIndex": 142.7,
"Distance": 10623,
"VisualSimilarityScore": null,
"Weight": 0.0
}
]
}
}{
"detail": [
{
"loc": [
"body",
43
],
"msg": "Expecting value: line 3 column 18 (char 43)",
"type": "value_error.jsondecode",
"ctx": {
"msg": "Expecting value",
"doc": "{\n \"postcode\": \"2201PZ\",\n \"housenumber\": a,\n \"valuationdate\": \"20121001\"\n}",
"pos": 43,
"lineno": 3,
"colno": 18
}
}
]
}{
'Output': 'The given house type is unsupported or unknown.'
}
{
'Output': 'The energy label of the given house is unknown. Please fill the energylabel input.'
}
{
'Output': 'We do not have an image for the given house. Please fill the url input.'
}
{
'Output': 'The given house address not found in database, the combination of Post Code, House Number and House Addition does not exist.'
}{
'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}{
"message": "Missing Authentication Token"
}{
"message": "Internal server error"
}Request body
Voorbeeld verzoek
{
"postcode": "1444AJ",
"housenumber": 13,
"houseaddition": "A",
"innersurfacearea": 110,
"reference_number": 10,
"date_limit": 6,
"window_limit": 0,
"furnished": 0,
"garden": 0
}Last updated