Skip to content
Scrappa Get API key
Boligsiden API 1 credit/request

Boligsiden Reference API Documentation

GET https://scrappa.co/api/boligsiden/reference

Boligsiden Reference API Documentation Return the reference lists behind the search filters: zip codes with city name and slug, municipalities with code, slug, population and tax rates, or provinces with code and slug. The lists change rarely and are cached for 24 hours.

Boligsiden Reference API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/boligsiden/reference
Auth header
x-api-key
Cost
1 credit/request
type = example
Response preview
200 OK
{
    "data": {
        "meta": {
            "total_hits": 98
        },
        "type": "municipalities",
        "results": [
            {
                "name": "Albertslund",
                "slug": "albertslund",
                "population": 27677,
                "region_code": 1084,
                "municipality_code": 165,
                "church_tax_percent": 0.8,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

type string Required

zip_codes, municipalities or provinces.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "meta": {
            "total_hits": 98
        },
        "type": "municipalities",
        "results": [
            {
                "name": "Albertslund",
                "slug": "albertslund",
                "population": 27677,
                "region_code": 1084,
                "municipality_code": 165,
                "church_tax_percent": 0.8,
                "council_tax_percent": 25.6,
                "land_value_tax_per_thousand": 9.1
            },
            {
                "name": "Aller\u00f8d",
                "slug": "alleroed",
                "population": 25962,
                "region_code": 1084,
                "municipality_code": 201,
                "church_tax_percent": 0.58,
                "council_tax_percent": 25.3,
                "land_value_tax_per_thousand": 8
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "municipalities"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A query parameter is missing or invalid. No upstream request is made. This response is not billable.

{
    "errors": {
        "type": [
            "The selected type is invalid."
        ]
    },
    "message": "The request validation failed"
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "municipalities"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Boligsiden API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.