# Boligsiden Previews API Documentation

<p><strong>Boligsiden Previews API Documentation</strong> List homes announced before they go on the market: approximate price, price per square metre, living and lot area with ranges, rooms, floors, build year, area, description, page views and the agency. Filters for location, address type, price, rooms and area are honoured.</p>

- **Documentation:** [https://scrappa.co/docs/boligsiden-api/boligsiden_previews](https://scrappa.co/docs/boligsiden-api/boligsiden_previews)
- **API group:** Boligsiden API
- **Endpoint:** `GET https://scrappa.co/api/boligsiden/previews`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `zip_codes` | string | No | One or more 4-digit Danish zip codes separated by commas. Example: 2100,2200. |
| `cities` | string | No | One or more city names exactly as shown by the locations endpoint (display name such as Aarhus C, not the slug). Separate with commas or send cities[]=A&cities[]=B. |
| `municipalities` | string | No | One or more municipality slugs such as aarhus or koebenhavn. Use the reference endpoint with type=municipalities. |
| `provinces` | string | No | One or more province slugs such as nordjylland. Use the reference endpoint with type=provinces. |
| `address_types` | string | No | Comma separated list (rows of other types are removed from the page and counted in meta.excluded_by_type_filter): villa, terraced house, condo, holiday house, allotment, cooperative, farm, full year plot, holiday plot, villa apartment, cattle farm, pig farm, plant farm, forest, hobby farm, special, houseboat, garage, parking, business, double house, multiple family house, room. |
| `price_min` | integer | No | Minimum price in DKK. |
| `price_max` | integer | No | Maximum price in DKK. |
| `rooms_min` | integer | No | Minimum number of rooms. |
| `area_min` | integer | No | Minimum living area in square metres. |
| `area_max` | integer | No | Maximum living area in square metres. |
| `sort_by` | string | No | created_at, living_area, lot_area, price, price_per_area, zip_code or rooms. |
| `sort_ascending` | boolean | No | true or false. Used with sort_by. Defaults to true. |
| `page` | integer | No | Page number, starting at 1. Page times page size must not exceed 10000. Defaults to 1. |
| `per_page` | integer | No | Rows per page, 1 to 100. Defaults to 20. |

## Example response

```json
{
    "data": {
        "meta": {
            "page": 1,
            "has_more": true,
            "per_page": 20,
            "total_hits": 1220,
            "total_pages": 16
        },
        "results": [
            {
                "id": "5c95cc4a-0db3-4666-9f73-082498cbc02d",
                "url": "https://www.edc.dk/ejendomsmaegler/skagen/poul-erik-bech",
                "area": 66,
                "city": "Skagen",
                "price": 2695000,
                "rooms": 4,
                "title": "Prisvenligt og velholdt sommerhus i Gammel Skagen \u2013 t\u00e6t p\u00e5 strand og solnedgang",
                "floors": 1,
                "status": "open",
                "realtor": {
                    "id": "791ba94d-a960-4f1c-a59d-eaeba6ac76ee",
                    "cvr": "18215101",
                    "name": "EDC Poul Erik Bech",
                    "slug": "edc-poul-erik-bech-sct.-laurentii-vej-63c-9990-skagen-791ba94da9604f1ca59deaeba6ac76ee",
                    "email": "999@edc.dk",
                    "phone": "98441616",
                    "rating": {
                        "buyer": {
                            "score": 9.13,
                            "responses": 8
                        },
                        "seller": {
                            "score": 9.57,
                            "responses": 7
                        }
                    },
                    "address": {
                        "city": "Skagen",
                        "road": "Sct. Laurentii Vej",
                        "floor": "st",
                        "zip_code": 9990,
                        "house_number": "63C"
                    },
                    "image_url": "https://images.boligsiden.dk/images/realtor_image/791ba94d-a960-4f1c-a59d-eaeba6ac76ee/1440x960/88cebef4-5c9b-4fa7-a222-65ca71f04538.webp?h=a35c1846641d261f37146093a9d84d18b0d3494a8e06b0a7a1ffb5bbfc966ce6",
                    "branch_name": "EDC",
                    "active_listings": {
                        "for_rent": 0,
                        "for_sale": 68,
                        "cooperative": 0
                    }
                },
                "latitude": 57.46252,
                "lot_area": 900,
                "province": "Nordjylland",
                "zip_code": 9990,
                "longitude": 10.4148445,
                "area_range": {
                    "max": 75
                },
                "page_views": 15,
                "year_built": 1984,
                "description": "Attraktivt og velholdt sommerhus t\u00e6t p\u00e5 stranden i Gammel Skagen\n\nI det eftertragtede Gammel Skagen finder I dette hyggelige og velholdte sommerhus p\u00e5 66 m\u00b2, be...",
                "address_type": "holiday house",
                "municipality": "Frederikshavn",
                "lot_area_range": {
                    "max": 1200,
                    "min": 750
                },
                "price_per_area": 40833,
                "year_built_range": {
                    "max": 2000,
                    "min": 1980
                },
                "price_per_area_range": {
                    "max": 41000,
                    "min": 40500
                }
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "previews"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter is missing or invalid. No upstream request is made. This response is not billable. |
| 503 | Service Unavailable | Boligsiden could not be reached, blocked or rate limited every attempt, or answered with a shape that no longer matches the documented contract. Retry shortly. This response is not billable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)