Authentication, input and response
Headers
Content-Type
string
application/json
x-api-key*
string
Unique API key from Altum. Obtain one via Mopsus (https://mopsus.altum.ai)
This is the main endpoint of the API. It retrieves a list of subsidies based on a user's postcode and, if provided, their personal and financial details for loan eligibility checking.
GET:
Request body
Market Trend Request Model
Field
Type
Description
postcode*
string
Required. The Dutch postcode (e.g., "3511 AA").
Example Complete Input
A valid GET Request body would look like this:
{"postcode": "5258BA"}Upon a successful POST request, the API returns a 200 OK status with a JSON object containing the results.
Market Trend API Response Model
Field
Type
Description
postcode
String
The normalized Dutch postcode (e.g., "1011AB") used for the query.
city
String
The city name derived from the master address database.
neighbourhood
String
The specific neighborhood name (if available in Dataland source).
municipality
String
The administrative municipality governing the area.
averagePriceSingleFamilyHomes
Float
The average transaction price for single-family properties (detached, semi-detached, terraced).
averagePriceMultiFamilyHomes
Float
The average transaction price for multi-family properties (apartments/flats).
pricePerSquareMeterSingleFamily
Float
The average price per square meter (€/m²) for single-family homes.
pricePerSquareMeterMultiFamily
Float
The average price per square meter (€/m²) for apartments.
annualPriceChange
Float
The annualized percentage growth (CAGR) of property values compared to the previous recorded year.
fiveYearPriceChange
Float
The projected percentage change in value over a 5-year period based on historical growth trends.
totalSalesLast12Months
Integer
The total count of property transactions recorded in this postcode over the last 365 days.
priceDistribution
Object
A dictionary serving as a histogram, mapping price ranges (e.g., "250-500k") to the number of properties sold in that bracket.
pricePerSquareMeterDistribution
Object
A dictionary serving as a histogram, mapping price-per-m² ranges (e.g., "3000-3500") to the frequency of sales in that bracket.
Output
Upon a successful GET request, the API returns a 200 OK status with a JSON object containing the results.
Example Complete Output
The postcode format was incorrect (e.g., "12345").
Last updated