Authentication, input and response
Fetch the latest status on the object in regard to the real estate listing
POST
https://api.altum.ai/movedata
Fetch the latest status of the real estate listing.
Headers
Content-Type
string
application/json
x-api-key
string
Unique API Key from Altum. Create one via Mopsus (https://mopsus.altum.ai)
Request Body
postcode*
string
Zipcode of the object
housenumber*
number
House number of the object
addition
string
House number addition
Get 5 objects which are for rent/rented within a zipcode
GET
https://api.altum.ai/movedata/rent?search=
The 'search' query parameter takes PC4, PC5 or PC6 Zipcodes. This will display 5 objects in terms of relevance.
Query Parameters
search*
string
This parameter takes the zipcode to be queried
Headers
Content-Type
string
application/json
x-api-key*
string
API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Get 5 objects which are for sale/sold within a zipcode
GET
https://api.altum.ai/movedata/sale?search=
The 'search' query parameter takes PC4, PC5 or PC6 zipcodes. This will display 5 objects in terms of relevance.
Query Parameters
search*
string
This parameter takes the zipcode to be queried
Headers
Content-Type
string
application/json
x-api-key*
string
API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Get the total count and details of objects which are for sale/sold and for rent/rented within a zipcode
GET
https://api.altum.ai/movedata/count?search=
Query Parameters
search*
string
This parameter takes the zipcode to be queried
Headers
Content-Type
string
application/json
x-api-key*
string
API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Request body
Example request
Post
Get
Get suggestions of objects which are for sale/sold with a search query
GET
https://api.altum.ai/movedata/autosearch?search=
Query Parameters
search*
string
This parameter takes the zipcode to be queried
sort
string
Either sort by "date" or "relevance". Default is date
limit
int
Max number of objects in response
Headers
Content-Type
string
application/json
x-api-key*
string
API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Response
The output of the search is a list of objects containing the following fields:
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'
Request body
Last updated