Authentication, input and response

Assess the full potential of the AutoSearch API by understanding the key parameters and response.

GET https://api.altum.ai/autosearch?search=

The endpoint allows you to interact with the Autosearch API by sending specific queries, such as postal codes, sorting options, and result limits, to retrieve detailed real estate data. You can find the full endpoint above.

Query Parameters

Name	Type	Description
search*	string	This parameter specifies the postal code to be queried.
sort	string	Sort results by "date" or "relevance." The default is "date."
limit	int	The maximum number of items to be returned in the response.

Headers

Name	Type	Description
Content-Type	string	application/json
x-api-key*	string	API key from Altum. Obtain one via Mopsus.

Response

The output of the Autosearch API is a list of objects containing the following fields:

Name	Type	Description
postcode	string	The postal code of the location.
housenumber	int	The house number of the location.
houseaddition	string	Any addition to the house number (e.g., "Hs+1").
city	string	The city or village of the location.
street	string	The street name of the location.
province	string	The province where the location is situated.
asking_price	int	The asking price of the property.
date_listed	string	The date the property was listed (dd/mm/yy).
image	string	The URL to the image of the property (if available).

Example Output

Jason

[
    {
        "postcode": "1053BM",
        "housenumber": 26,
        "houseaddition": "Hs+1",
        "city": "Amsterdam Bellamybuurt-Zuid",
        "street": "Bellamystraat",
        "province": "Noord-Holland",
        "asking_price": 925000,
        "date_listed": "18/04/24",
        "image": "https://altum-ai.s3.amazonaws.com/image-16258e96-e073-4d61-aec5-555f38c33ca7.png"
    },
    {
        "postcode": "1053BP",
        "housenumber": 72,
        "houseaddition": null,
        "city": "Amsterdam Bellamybuurt-Zuid",
        "street": "Bellamystraat",
        "province": "Noord-Holland",
        "asking_price": 1150000,
        "date_listed": "30/03/24",
        "image": "https://altum-ai.s3.amazonaws.com/image-cbfa1bb7-ae54-4852-87f4-f69574f27155.png"
    }
]

.