---
title: "RES API (public)"
description: "Canonical OpenAPI 3.1 contract for the RES (Real Estate Scoring) API that powers the Aireon suite of apps.\n\nThis document **describes the API exactly as it behaves today** - it is documentation, not a redesign. No endpoint, parameter, response shape, or auth rule was changed by introducing this file, so every existing client keeps working unchanged.\n\n### Error contract - opt in to corrected status codes\n\nThe legacy parcel and OEREB endpoints historically returned authentication and validation errors as **HTTP 200 with a plain-text body** (for example `Missing Token`, `Wrong Token`, `coordinate missing`). To correct this without breaking existing callers, the fixed behaviour is **opt-in** via a request header:\n\n- Send **`X-RES-API-Version: 2`** to receive a proper `4xx`/`5xx` status code with a JSON `{ \"error\": ... }` body.\n- Omit the header to get the unchanged legacy behaviour (HTTP 200 + plain text).\n\n**New integrations should always send `X-RES-API-Version: 2`.** Once every caller is migrated the default will be flipped. The `/score/*`, `/res_api/signal/*`, `/res_api/building_data`, `/res_api/bldg_vol_bbox`, and `/image/aireon/*` endpoints already use proper status codes regardless of the header. Note: `GET /res_api/parcel_image` is used directly in `<img>` tags, which cannot send the header - its auth and validation errors therefore always use legacy behaviour, while its server and upstream failures always answer a real `500` / `502`.\n\n### Scope\n\nThis is the public subset of the RES API: parcel search and data, zone statistics, building data and 3D, POI scoring and routing, GWR building records, OEREB documents, valuation and the PRM listing monitor.\nEach operation carries `x-aireon-pack`, the data pack an API key needs for it (`core` is free).\nEvery operation needs a token unless its `security` is empty. Developer guide: https://docs.aireon.ch"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.aireon.ch/llms.txt
> Use this file to discover all available pages before exploring further.

Canonical OpenAPI 3.1 contract for the RES (Real Estate Scoring) API that powers the Aireon suite of apps.

This document **describes the API exactly as it behaves today** - it is documentation, not a redesign. No endpoint, parameter, response shape, or auth rule was changed by introducing this file, so every existing client keeps working unchanged.

\### Error contract - opt in to corrected status codes

The legacy parcel and OEREB endpoints historically returned authentication and validation errors as **HTTP 200 with a plain-text body** (for example `Missing Token`, `Wrong Token`, `coordinate missing`). To correct this without breaking existing callers, the fixed behaviour is **opt-in** via a request header:

- Send **`X-RES-API-Version: 2`** to receive a proper `4xx`/`5xx` status code with a JSON `{ "error": ... }` body.
- Omit the header to get the unchanged legacy behaviour (HTTP 200 + plain text).

**New integrations should always send `X-RES-API-Version: 2`.** Once every caller is migrated the default will be flipped. The `/score/*`, `/res_api/signal/*`, `/res_api/building_data`, `/res_api/bldg_vol_bbox`, and `/image/aireon/*` endpoints already use proper status codes regardless of the header. Note: `GET /res_api/parcel_image` is used directly in `<img>` tags, which cannot send the header - its auth and validation errors therefore always use legacy behaviour, while its server and upstream failures always answer a real `500` / `502`.

\### Scope

This is the public subset of the RES API: parcel search and data, zone statistics, building data and 3D, POI scoring and routing, GWR building records, OEREB documents, valuation and the PRM listing monitor.
Each operation carries `x-aireon-pack`, the data pack an API key needs for it (`core` is free).
Every operation needs a token unless its `security` is empty. Developer guide: https://docs.aireon.ch

Version: 1.94.4

## Servers

- `https://res.aireon.ch`

## Sections

- [Parcel](/res/tags/parcel/)
- [Building3D](/res/tags/building3-d/)
- [Score](/res/tags/score/)
- [OEREB](/res/tags/oereb/)
- [Meta](/res/tags/meta/)
- [GWR](/res/tags/gwr/)
- [PRMMonitor](/res/tags/prm-monitor/)
- [Valuation](/res/tags/valuation/)


Source: https://docs.aireon.ch/res/index.md