# Postman API Collection

### Download the Postman Collection

Use this collection to test all **Altum AI APIs** directly, validate requests, and generate sample code for Dutch real estate data.

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

***

### Altum AI Postman API - Integration Guide

The **Altum AI Postman Collection** provides preconfigured requests for a wide range of APIs:

* **Property Valuation & AVM:** instant property values and market price estimates
* **Sustainability & Energy Labels:** building energy performance based on NTA 8800
* **Object Data & Geometry:** construction year, surface area, volume, coordinates
* **Market Data & Transactions:** sale prices, rental references, and WWS point calculations

Use this collection to test endpoints, understand input and output structures, and build integrations in production or sandbox environments.

***

### Getting Started & Authentication

Altum AI uses **API key authentication via HTTP headers**.

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

**Import instructions:**

1. Drag the `Altum APIs.postman_collection.json` file into your Postman workspace
2. Open the *Variables* tab of the collection
3. Replace `API_KEY` with your production or sandbox key
4. All requests inherit authentication from the collection level by default

***

### Core API Categories

#### 1. Property Valuation & AVM

* **Endpoints:** `/avm`, `/avmplus`, `/listingprice`
* **Key inputs:** postcode, housenumber, valuationdate
* **Usage:** Calculate property values and market prices based on Dutch housing trends
* **For:** Mortgage lenders, real estate agents, fintech platforms

#### 2. Sustainability & Energy Labels

* **Endpoints:** `/sustainability` (v1 & v2), `/energy-insights`, `/energylabel`
* **Data:** current label, potential label, CO₂ reduction, ROI of measures
* **For:** Green lending, ESG reporting, home improvement advisory

#### 3. Object Data & Geometry

* **Endpoints:** `/objectdata`, `/location-data`, `/geometry`
* **Data:** construction year, surface area (m²), volume (m³), 3D coordinates

#### 4. Market Data & Transactions

* **Endpoints:** `/movedata`, `/transaction`, `/rental-reference`, `/wws`
* **Usage:** Compare asking prices with sale prices or calculate WWS points

***

### LLM & Integration Context

Use the following **semantic mappings** for AI agents and automated workflows:

| Entity          | API Mapping                | Type             |
| --------------- | -------------------------- | ---------------- |
| Property ID     | `bagid`                    | String / Integer |
| Dutch Postcode  | `postcode` (1234AB)        | String           |
| Energy Standard | NTA 8800                   | Contextual       |
| Valuation Date  | `valuationdate` (YYYYMMDD) | String           |

**POST request structure:**

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

***

### Error Handling & Status Codes

* `401/403` – Invalid API key or insufficient permissions
* `422` – Validation error (e.g. malformed postcode)
* `429` – Rate limit exceeded

***

### Extra Resources

* **Documentation:** [docs.altum.ai](https://docs.altum.ai/english)
* **Support:** Contact the Altum AI team for implementation support


---

# 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/english/developers/postman-api-collection.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.