Authentication, input and response
Get suggestions of real estate objects addresses from Altum AI.
GET https://api.altum.ai/autosuggest/v2?search={string}
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. Default(5)
offset
int
Integer used for pagination that shows number of items to skip from the start of the intended response.
For example, an offset of 10 means “ignore the first 10 records and return everything after that.”
Headers
Content-Type
string
application/json
x-api-key*
string
Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)
[
{
"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"
}
]Request query
Example request
Spaces need to be inputted as %20
Last updated