Authentication, input and response
Last updated
Last updated
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.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
The output of the Autosearch API is a list of objects containing the following fields:
| 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.
Content-Type
string
application/json
x-api-key*
string
API key from Altum. Obtain one via Mopsus.
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).
market_status
string
The current market status of the property and its possible values: 'Available', 'Sold subject to conditions', 'Under offer', 'Optioned', 'Sold', 'Only for a good offer', 'For sale at a later date'