Authentication, input and response
Get suggestions of real estate objects addresses from Altum AI.
GET
https://api.altum.ai/autosuggest?search={string}&fuzzy={true or 1 or yes}
This endpoint allows you to get five (5) suggestions based on your query parameters. It needs at least one (1) character and responds with the best suggestions.
Query Parameters
fuzzy
boolean
Whether you need fuzzy results or not. This could be True, 1 or yes.
search*
string
Postcode, House Number, House Number Additions and Streetnames can be passed as queries, using the search parameter.
limit
int
Maximum number of suggestions in response
Headers
Content-Type
string
application/json
x-api-key*
string
Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)
{
"Output": {
"1": {
"BagID": "0352010000000398",
"House Address": "3961HM-200-",
"House Number": "200",
"Postcode": "3961HM",
"House Addition": null,
"Street Name": "Amstel",
"City": "Wijk bij Duurstede",
"Province": "Utrecht"
},
"2": {
"BagID": "0398010000000417",
"House Address": "1703NR-62-",
"House Number": "62",
"Postcode": "1703NR",
"House Addition": null,
"Street Name": "Amstel",
"City": "Heerhugowaard",
"Province": "Noord-Holland"
},
"3": {
"BagID": "0398010000000421",
"House Address": "1703NR-78-",
"House Number": "78",
"Postcode": "1703NR",
"House Addition": null,
"Street Name": "Amstel",
"City": "Heerhugowaard",
"Province": "Noord-Holland"
},
"4": {
"BagID": "0398010000000423",
"House Address": "1703NR-84-",
"House Number": "84",
"Postcode": "1703NR",
"House Addition": null,
"Street Name": "Amstel",
"City": "Heerhugowaard",
"Province": "Noord-Holland"
},
"5": {
"BagID": "0398010000024590",
"House Address": "1703NR-56-",
"House Number": "56",
"Postcode": "1703NR",
"House Addition": null,
"Street Name": "Amstel",
"City": "Heerhugowaard",
"Province": "Noord-Holland"
}
}
}
[
{
"bagid": "0114010000295134",
"houseaddress": "7887VD-11-",
"postcode": "7887VD",
"housenumber": "11",
"houseaddition": null,
"street": "Amsterdamscheveldlaan",
"city": "Erica",
"province": "Drenthe"
},
{
"bagid": "1708010000017631",
"houseaddress": "8338KC-6-",
"postcode": "8338KC",
"housenumber": "6",
"houseaddition": null,
"street": "Amsterdamselaan",
"city": "Willemsoord",
"province": "Overijssel"
},
{
"bagid": "0424010000000631",
"houseaddress": "1398BL-1-",
"postcode": "1398BL",
"housenumber": "1",
"houseaddition": null,
"street": "Amsterdamsepoort",
"city": "Muiden",
"province": "Noord-Holland"
},
{
"bagid": "0114010000386075",
"houseaddress": "7887VD-10-",
"postcode": "7887VD",
"housenumber": "10",
"houseaddition": null,
"street": "Amsterdamscheveldlaan",
"city": "Erica",
"province": "Drenthe"
},
{
"bagid": "1708010000015107",
"houseaddress": "8338KC-4-",
"postcode": "8338KC",
"housenumber": "4",
"houseaddition": null,
"street": "Amsterdamselaan",
"city": "Willemsoord",
"province": "Overijssel"
},
{
"bagid": "1708010000010998",
"houseaddress": "8338KC-2-",
"postcode": "8338KC",
"housenumber": "2",
"houseaddition": null,
"street": "Amsterdamselaan",
"city": "Willemsoord",
"province": "Overijssel"
},
{
"bagid": "0114010000385731",
"houseaddress": "7887VD-1-",
"postcode": "7887VD",
"housenumber": "1",
"houseaddition": null,
"street": "Amsterdamscheveldlaan",
"city": "Erica",
"province": "Drenthe"
},
{
"bagid": "0114010000302108",
"houseaddress": "7887VD-9-",
"postcode": "7887VD",
"housenumber": "9",
"houseaddition": null,
"street": "Amsterdamscheveldlaan",
"city": "Erica",
"province": "Drenthe"
},
{
"bagid": "0034010000089763",
"houseaddress": "1324RL-1-B",
"postcode": "1324RL",
"housenumber": "1",
"houseaddition": "B",
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000004792",
"houseaddress": "1324RR-46-",
"postcode": "1324RR",
"housenumber": "46",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000004820",
"houseaddress": "1324RS-64-",
"postcode": "1324RS",
"housenumber": "64",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000004823",
"houseaddress": "1324RS-58-",
"postcode": "1324RS",
"housenumber": "58",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000006470",
"houseaddress": "1324RP-6-",
"postcode": "1324RP",
"housenumber": "6",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000037639",
"houseaddress": "1324RL-11-",
"postcode": "1324RL",
"housenumber": "11",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
},
{
"bagid": "0034010000004818",
"houseaddress": "1324RS-68-",
"postcode": "1324RS",
"housenumber": "68",
"houseaddition": null,
"street": "Amsterdamweg",
"city": "Almere",
"province": "Flevoland"
}
]
{
"Output": "Could not find any object with your search query"
}
{
"errors": {
"postcode": "Unsupported postcode length, it should be six."
},
"message": "Input payload validation failed"
}
OR
{
"errors": {
"postcode": "Unsupported postcode format, it should consist of four numbers following by two letters."
},
"message": "Input payload validation failed"
}
{
"message": "Internal server error"
}
{
"message": "Missing Authentication Token"
}
{
'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}
Turn on fuzzy to support multi string queries. Learn more about fuzzy search support here.
Request query
Example request
https://api.altum.ai/autosuggest?search=1181TV
https://api.altum.ai/autosuggest?search=3947BA-1-b
https://api.altum.ai/autosuggest?search=bellefleurho5&fuzzy=1
https://api.altum.ai/autosuggest?search=bellefleurho%205&fuzzy=yes
https://api.altum.ai/autosuggest?search=bellefleurho%205&fuzzy=true&limit=5
Spaces need to be inputted as %20
Last updated