> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/ontwikkelaars/postman-api-collection.md).

# Postman API Collection

### Download de Postman Collection

Gebruik deze collectie om alle **Altum AI API’s** direct te testen, requests te valideren en voorbeeldcode te genereren voor Nederlandse vastgoeddata.

{% file src="/files/OsjimTDX6PtbpK8KPb2H" %}

***

### Altum AI Postman API – Integratiehandleiding

De **Altum AI Postman Collection** biedt vooraf geconfigureerde requests voor een breed scala aan API’s:

* **Woningwaardering & AVM:** directe waarde- en marktprijsinschattingen
* **Verduurzaming & Energielabels:** energieprestaties volgens NTA 8800
* **Objectdata & Geometrie:** bouwjaar, oppervlak, inhoud, coördinaten
* **Marktdata & Transacties:** verkoopprijzen, huurreferenties en WWS-punten

Met deze collectie kun je endpoints testen, input/output begrijpen en integraties bouwen in productie- of sandboxomgevingen.

***

### Aan de slag & authenticatie

Altum AI gebruikt **API Key-authenticatie via headers**.

* **Base URL:** `https://api.altum.ai`
* **Header Key:** `x-api-key`

**Import instructies:**

1. Sleep het [`Altum APIs.postman_collection.json`](#download-de-postman-collection) bestand in je Postman workspace
2. Ga naar het tabblad *Variabels* van de collectie
3. Vervang `API_KEY` door je productie- of sandboxkey
4. Alle requests gebruiken standaard de collectie-authenticatie

***

### Kern API-categorieën

#### **1. Woningwaardering & AVM**

* **Endpoints:** `/avm`, `/avmplus`, `/listingprice`
* **Belangrijkste inputs:** postcode, huisnummer, valuationdate
* **Gebruik:** Bereken woningwaardes en marktprijzen op basis van Nederlandse trends
* **Voor:** Hypotheekverstrekkers, makelaars, fintech-platforms

#### **2. Verduurzaming & Energielabels**

* **Endpoints:** `/sustainability` (v1 & v2), `/energy-insights`, `/energylabel`
* **Data:** huidig label, potentieel label, CO₂-reductie, ROI van maatregelen
* **Voor:** Groene financiering, ESG-rapportages, woningverbeteringsadvies

#### **3. Objectdata & Geometrie**

* **Endpoints:** `/objectdata`, `/location-data`, `/geometry`
* **Data:** bouwjaar, oppervlak (m²), inhoud (m³), 3D-coördinaten

#### **4. Marktdata & Transacties**

* **Endpoints:** `/movedata`, `/transaction`, `/rental-reference`, `/wws`
* **Gebruik:** Vergelijk vraagprijzen met verkoopprijzen of bereken WWS-punten

***

### LLM & integratiecontext

Gebruik deze **semantische mappings** voor AI-agents en automatisering:

| Entiteit         | API-mapping                | Type           |
| ---------------- | -------------------------- | -------------- |
| Property ID      | `bagid`                    | String/Integer |
| Postcode NL      | `postcode` (1234AB)        | String         |
| Energienorm      | NTA 8800                   | Contextual     |
| Waarderingsdatum | `valuationdate` (YYYYMMDD) | String         |

**POST-request structuur:**

```json
{
  "postcode": "2728KH",
  "housenumber": 7,
  "valuationdate": "20260126"
}
```

***

### Foutafhandeling & statuscodes

* `401/403` – Ongeldige API Key of onvoldoende rechten
* `422` – Validatiefout (bijv. foutieve postcode)
* `429` – Rate limit overschreden

***

### Extra resources

* **Documentatie:** [docs.altum.ai](https://docs.altum.ai)
* **Support:** Contacteer het Altum AI team voor implementatiehulp


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.altum.ai/ontwikkelaars/postman-api-collection.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.