Boligsiden Locations API Documentation Autocomplete cities, municipalities, roads, zip codes, provinces, places and addresses from a text, with the number of matching listings. Use the returned city name in the cities filter and the municipality slug in the municipalities filter of the search endpoint. Each address has the case id of its listing.
Run this endpoint
Endpoint
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.
2 optional filters available.
string
Required
Text to complete, at least 2 characters. Example: aarh.
coffee shops
string
Optional
sale (default) or rent. Counts follow the listing type.
example
string
Optional
Comma separated address types to count, for example villa,condo.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"locations": {
"roads": [
{
"name": "\u00c5rhusvej, 8940 Randers SV",
"slug": "aarhusvej,-8940-randers-sv",
"count": 5
},
{
"name": "\u00c5rhusvej, 8660 Skanderborg",
"slug": "aarhusvej,-8660-skanderborg",
"count": 4
},
{
"name": "\u00c5rhusgade, 2100 K\u00f8benhavn \u00d8",
"slug": "aarhusgade,-2100-koebenhavn-oe",
"count": 2
}
],
"cities": [
{
"name": "Aarhus C",
"slug": "aarhus-c",
"count": 215
},
{
"name": "Aarhus N",
"slug": "aarhus-n",
"count": 64
},
{
"name": "Aarhus V",
"slug": "aarhus-v",
"count": 31
}
],
"places": [],
"addresses": [
{
"name": "\u00c5rhusvej 37, 8883 Gjern",
"case_id": "42f3c176-5624-488c-860c-b5a915d94cb6"
},
{
"name": "\u00c5rhus Plads 2, 5. tv., 2100 K\u00f8benhavn \u00d8",
"case_id": "2d113c09-f689-43f4-a703-0a4f8d66a393"
},
{
"name": "\u00c5rhusvej 68, 8500 Grenaa",
"case_id": "16132c28-db3a-40e6-a538-9303a84b35a9"
}
],
"provinces": [],
"zip_codes": [],
"custom_areas": [],
"municipalities": [
{
"name": "Aarhus",
"slug": "aarhus",
"count": 1096
}
]
}
},
"meta": {
"billable": true,
"endpoint_family": "locations_cases"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query parameter is missing or invalid. No upstream request is made. This response is not billable.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}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": "locations_cases"
},
"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.