# Boligsiden Reference API Documentation

<p><strong>Boligsiden Reference API Documentation</strong> 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.</p>

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

## 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 |
| --- | --- | --- | --- |
| `type` | string | Yes | zip_codes, municipalities or provinces. |

## Example response

```json
{
    "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

| 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)