# Residential Property Prices API
> How house prices are moving across the world's economies, read live from the Bank for International Settlements' Selected Residential Property Prices dataset. For roughly 60 countries the BIS publishes a quarterly residential property price index — both nominal and real (inflation-adjusted) — together with its year-on-year change. The latest endpoint returns every country's most recent reading at once — the nominal and real index plus the nominal and real year-on-year growth — sortable by nominal or real YoY so you instantly see which housing markets are heating up and which are cooling once you strip out inflation. The country endpoint returns a single country's latest reading; the history endpoint returns its quarterly index time series (nominal and real) so you can chart a market over time. Countries are given as ISO-2 codes (US, DE, GB, JP) or common names (xm is the euro area). The nominal index is the headline price level; the real index is deflated by consumer prices, so a negative real YoY means prices are falling after inflation even when the nominal index still rises. This is the real-estate / property-price macro data-cut — distinct from the FX-rate, central-bank, yield-curve, commodity and equity-index APIs in the catalogue. Live source, no key required upstream, nothing stored.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/houseprices-api/..."
```

## Pricing
- **Free** (Free) — 350 calls/Mo, 2 req/s
- **Starter** ($11/Mo) — 6,800 calls/Mo, 6 req/s
- **Pro** ($34/Mo) — 43,500 calls/Mo, 16 req/s
- **Business** ($80/Mo) — 235,000 calls/Mo, 40 req/s

## Endpoints

### House Prices

#### `GET /v1/country` — One country's latest reading

**Parameters:**
- `country` (query, required, string) — ISO-2 code or common name Example: `US`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/houseprices-api/v1/country?country=US"
```

**Response:**
```json
{
    "data": {
        "period": "2025-Q4",
        "source": "BIS",
        "country": "US",
        "real_index": 158.4,
        "real_yoy_pct": -1.77,
        "nominal_index": 235.4,
        "nominal_yoy_pct": 0.87
    },
    "meta": {
        "timestamp": "2026-06-12T01:41:17.478Z",
        "request_id": "84347391-9553-467d-b0eb-d62b813ef257"
    },
    "status": "ok",
    "message": "Country retrieved successfully",
    "success": true
}
```

#### `GET /v1/history` — One country's quarterly index history

**Parameters:**
- `country` (query, required, string) — ISO-2 code or common name Example: `US`
- `quarters` (query, optional, string) — Number of recent quarters (1-200, default 40) Example: `40`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/houseprices-api/v1/history?country=US&quarters=40"
```

**Response:**
```json
{
    "data": {
        "count": 40,
        "source": "BIS",
        "country": "US",
        "history": [
            {
                "period": "2016-Q1",
                "real_index": 118.8,
                "nominal_index": 129.4
            },
            {
                "period": "2016-Q2",
                "real_index": 118.8,
                "nominal_index": 130.8
            },
            {
                "period": "2016-Q3",
                "real_index": 120,
                "nominal_index": 132.6
            },
            {
                "period": "2016-Q4",
                "real_index": 121.6,
                "nominal_index": 134.7
            },
            {
                "period": "2017-Q1",
                "real_index": 122.3,
                "nominal_index": 136.5
            },
            {
                "period": "2017-Q2",
                "real_index": 123.4,
                "nominal_index": 138.5
            },
            {
                "period": "2017-Q3",
                "real_index": 124.8,
                "nominal_index": 140.6
            },
            {
                "period": "2017-Q4",
                "real_index": 126.3,
                "nominal_index": 142.8
            },
            {
                "period": "2018-Q1",
                "real_index": 127.1,
                "nominal_index": 145
            },
            {
                "period": "2018-Q2",
                "real_index": 127.3,
                "nominal_index
…(truncated, see openapi.json for full schema)
```

#### `GET /v1/latest` — Every country's latest house-price reading

**Parameters:**
- `sort` (query, optional, string) — Sort order: nominal_yoy (default), real_yoy or country Example: `nominal_yoy`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/houseprices-api/v1/latest?sort=nominal_yoy"
```

**Response:**
```json
{
    "data": {
        "count": 61,
        "source": "BIS",
        "countries": [
            {
                "period": "2025-Q4",
                "country": "TR",
                "real_index": 220.8,
                "real_yoy_pct": -0.75,
                "nominal_index": 4310.7,
                "nominal_yoy_pct": 30.62
            },
            {
                "period": "2025-Q4",
                "country": "MK",
                "real_index": 123,
                "real_yoy_pct": 19.96,
                "nominal_index": 199,
                "nominal_yoy_pct": 25.01
            },
            {
                "period": "2025-Q4",
                "country": "HU",
                "real_index": 216.1,
                "real_yoy_pct": 16.83,
                "nominal_index": 416.9,
                "nominal_yoy_pct": 21.24
            },
            {
                "period": "2025-Q4",
                "country": "PT",
                "real_index": 196.2,
                "real_yoy_pct": 16.28,
                "nominal_index": 261,
                "nominal_yoy_pct": 18.89
            },
            {
                "period": "2025-Q4",
                "country": "HR",
                "real_index": 147.3,
                "real_yoy_pct": 12.01,
                "nominal_index": 215.3,
                "nominal_yoy_pct": 16.05
            },
            {
                "period": "2025-Q4",
                "country": "RU",
                "real_index": 76.4,
                "rea
…(truncated, see openapi.json for full schema)
```

### Meta

#### `GET /v1/meta` — Spec

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/houseprices-api/v1/meta"
```

**Response:**
```json
{
    "data": {
        "note": "The nominal index is the headline price index; the real index is deflated by consumer prices, showing house prices relative to the cost of living (a negative real YoY means prices are falling after inflation). country is an ISO-2 code (US, DE, GB, JP) or a common name; XM is the euro area. Data is quarterly with the usual statistical lag.",
        "source": "BIS Data Portal (stats.bis.org/api/v2, dataflow WS_SPP, quarterly)",
        "service": "houseprices-api",
        "countries": 61,
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/latest": "Every country's latest house-price reading (nominal & real index + YoY), sortable (sort=nominal_yoy).",
            "GET /v1/country": "One country's latest reading (country=US or country=Germany).",
            "GET /v1/history": "One country's quarterly index history, nominal & real (country=US, quarters=40)."
        },
        "description": "How house prices are moving across the world, from the BIS Selected Residential Property Prices dataset. For ~60 countries it gives a quarterly residential property price index, nominal and real (inflation-adjusted), with year-on-year growth. latest returns every country's most recent reading (nominal & real index + YoY); country returns one country's latest; history returns its quarterly index time series. Live, no key, nothing stored. The real-estate / property-price macro data-cut, distinct from the FX-rate, yield-c
…(truncated, see openapi.json for full schema)
```


---
Marketplace page: https://www.oanor.com/api/houseprices-api
OpenAPI spec: https://www.oanor.com/api/houseprices-api/openapi.json
