# Authenticatie, invoer en resultaat

### Headers

<table><thead><tr><th width="152">Name</th><th width="145">Type</th><th>Description</th></tr></thead><tbody><tr><td>Content-Type</td><td>string</td><td>application/json</td></tr><tr><td>x-api-key<mark style="color:red;">*</mark></td><td>string</td><td>Unieke API-sleutel van Altum. Verkrijg er een via Mopsus (https://mopsus.altum.ai)</td></tr></tbody></table>

Dit is de hoofdendpoint van de API. Deze haalt een lijst met subsidies op op basis van de postcode van een gebruiker en, indien opgegeven, hun persoonlijke en financiële gegevens voor leen-geschiktheid.

<mark style="color:green;">**`GET:`**</mark>  `https://api.altum.ai/market-trend?postcode=??`

### Request body

**Markettrend Request Model**

| **Veld**                                   | **Type** | **Beschrijving**                                         |
| ------------------------------------------ | -------- | -------------------------------------------------------- |
| postcode<mark style="color:red;">\*</mark> | string   | **Verplicht.** De Nederlandse postcode (bijv. "3511 AA") |

**Example Complete Input**

```
https://api.altum.ai/market-trend?postcode=5258BB
```

Bij een succesvolle  `GET` -aanvraag retourneert de API de status <mark style="color:green;">200 OK</mark> met een JSON-object dat de resultaten bevat.

### Market Trend API Response Model

| Veld                                | Type    | Beschrijving                                                                                                                                         |
| ----------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **postcode**                        | String  | De genormaliseerde Nederlandse postcode (bijv. "1011AB") die voor de query is gebruikt.                                                              |
| **city**                            | String  | De plaatsnaam afgeleid van de adresstamgegevens.                                                                                                     |
| **neighbourhood**                   | String  | De specifieke buurtnaam (indien beschikbaar in Dataland-bron).                                                                                       |
| **municipality**                    | String  | De administratieve gemeente waaronder het gebied valt.                                                                                               |
| **averagePriceSingleFamilyHomes**   | Float   | De gemiddelde transactieprijs voor eengezinswoningen (vrijstaand, twee-onder-een-kap, tussenwoningen).                                               |
| **averagePriceMultiFamilyHomes**    | Float   | De gemiddelde transactieprijs voor meergezinswoningen (appartementen/flats).                                                                         |
| **pricePerSquareMeterSingleFamily** | Float   | De gemiddelde prijs per vierkante meter (€/m²) voor eengezinswoningen.                                                                               |
| **pricePerSquareMeterMultiFamily**  | Float   | De gemiddelde prijs per vierkante meter (€/m²) voor appartementen.                                                                                   |
| **annualPriceChange**               | Float   | De jaarlijkse procentuele groei (CAGR) van vastgoedwaarden vergeleken met het voorgaande geregistreerde jaar.                                        |
| **fiveYearPriceChange**             | Float   | De geprojecteerde procentuele waardeverandering over een periode van 5 jaar op basis van historische groeitrends.                                    |
| **totalSalesLast12Months**          | Integer | Het totaal aantal vastgoedtransacties dat de afgelopen 365 dagen in deze postcode is geregistreerd.                                                  |
| **priceDistribution**               | Object  | Een dictionary die dient als histogram, waarbij prijsklassen (bijv. "250-500k") worden gekoppeld aan het aantal verkochte panden in die categorie.   |
| **pricePerSquareMeterDistribution** | Object  | Een dictionary die dient als histogram, waarbij prijs-per-m²-klassen (bijv. "3000-3500") worden gekoppeld aan de verkoopfrekwentie in die categorie. |

### Output <a href="#id-5.-output" id="id-5.-output"></a>

**Voorbeeld volledige output**

```
{
  "region": {
    "postcode": "5258BB",
    "city": "BERLICUM NB",
    "neighbourhood": "Berlicum",
    "municipality": "Sint-Michielsgestel"
  },
  "averagePriceSingleFamilyHomes": 681870.58,
  "averagePriceMultiFamilyHomes": null,
  "pricePerSquareMeterSingleFamily": 1035.61,
  "pricePerSquareMeterMultiFamily": null,
  "annualPriceChange": 6.67,
  "fiveYearPriceChange": 38.09,
  "transactionData": {
    "totalSalesLast12Months": 0
  },
  "priceDistribution": {
    "250-500k": 2,
    "500-750k": 4,
    "1M+": 2
  },
  "pricePerSquareMeterDistribution": {
    "0-2500": 8
  }
}
```

**Explanation**

🏘️ **Regio**

```
"region": {
  "postcode": "5258BB",
  "city": "BERLICUM NB",
  "neighbourhood": "Berlicum",
  "municipality": "Sint-Michielsgestel"
}
```

{% hint style="info" %}
Alle gegevens en KPI’s zijn berekend voor postcode 5258BB, met context op stad **BERLICUM NB**, wijk **Berlicum** en gemeente **Sint-Michielsgestel**.
{% endhint %}

💰 **Gemiddelde woningprijzen**

```
"averagePriceSingleFamilyHomes": 681870.58,
"averagePriceMultiFamilyHomes": null
```

{% hint style="info" %}

* Eengezinswoningen: gemiddeld €681.870
* Meergezinswoningen / appartementen: geen gegevens beschikbaar voor dit gebied

Dit laat zien dat huizen in deze postcode relatief duur zijn, en dat de markt voor appartementen klein of niet geregistreerd is.
{% endhint %}

📏 **Prijs per vierkante meter**

```
"pricePerSquareMeterSingleFamily": 1035.61,
"pricePerSquareMeterMultiFamily": null
```

{% hint style="info" %}

* Eengezinswoningen: €1.035 per m²
* Meergezinswoningen: geen gegevens beschikbaar

Dit geeft een manier om huizenprijzen eerlijk te vergelijken, zelfs als de woningen verschillen in grootte.
{% endhint %}

📈 **Prijsontwikkelingen**

```
"annualPriceChange": 6.67,
"fiveYearPriceChange": 38.09
```

{% hint style="info" %}

* Jaarlijkse prijsverandering: +6,7% → prijzen zijn het afgelopen jaar gestegen
* Vijfjarige prijsverandering: +38,1% → prijzen zijn de afgelopen 5 jaar aanzienlijk gestegen

Dit laat zien dat de huizenprijzen zowel op korte als lange termijn stijgen.
{% endhint %}

🏷️ **Transactie-activiteit**

```
"transactionData": {
  "totalSalesLast12Months": 0
}
```

{% hint style="info" %}

* Aantal verkopen in de laatste 12 maanden: 0

Er zijn het afgelopen jaar geen huizen verkocht in dit gebied, dus de markt is momenteel inactief.
{% endhint %}

💵 **Prijsverdeling**

```
  "priceDistribution": {
    "250-500k": 2,
    "500-750k": 4,
    "1M+": 2
  }
```

{% hint style="info" %}
Aantal huizen verkocht per prijsklasse (historisch, niet alleen de laatste 12 maanden):

* €250k–€500k → 2 huizen
* €500k–€750k → 4 huizen
* €1M+ → 2 huizen

De meeste verkochte huizen in deze postcode liggen in de €500k–€750k range, met enkele dure verkopen boven €1M.
{% endhint %}

🏠 **Verdeling prijs per vierkante meter**

```
"pricePerSquareMeterDistribution": {
  "0-2500": 8
}
```

{% hint style="info" %}
Alle 8 geregistreerde verkopen liggen in de 0–2.500 €/m² range.

Dit laat zien dat zelfs dure huizen relatief bescheiden geprijsd zijn per m² vergeleken met zeer luxe markten.
{% endhint %}

{% tabs %}
{% tab title="200: OK Standard response" %}

```
{
  "region": {
    "postcode": "5258BA",
    "city": "BERLICUM NB",
    "neighbourhood": "Berlicum",
    "municipality": "Sint-Michielsgestel"
  },
  "averagePriceSingleFamilyHomes": 561365,
  "averagePriceMultiFamilyHomes": null,
  "pricePerSquareMeterSingleFamily": 646.76,
  "pricePerSquareMeterMultiFamily": null,
  "annualPriceChange": 8.46,
  "fiveYearPriceChange": 50.08,
  "transactionData": {
    "totalSalesLast12Months": 0
  },
  "priceDistribution": {
    "250-500k": 8,
    "750k-1M": 4
  },
  "pricePerSquareMeterDistribution": {
    "0-2500": 12
  }
}
```

{% endtab %}

{% tab title="400: Bad Request Unsuccessful response" %}

```
De postcode bestaat, maar er is onvoldoende gegevens (bijv. ontbrekende data of prijzen) om KPI's te berekenen.
```

{% endtab %}

{% tab title="404 Not Found" %}

```
Er bestaan geen transacties of stamgegevens voor de opgegeven postcode
```

{% endtab %}

{% tab title="422: Validation Error" %}
Het postcodeformaat was onjuist (bijv. "12345")
{% endtab %}

{% tab title="500: Internal Server Error Service is not available and/or down" %}

```
Error in database connection or unhandled exception in the calculation logic
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.altum.ai/taxeren-en-waarderen/markttrend-api/authentication-input-and-response.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
