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

BoligPortal Rental Search API Documentation

GET https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC

Scrappa's GET /api/boligportal/search returns BoligPortal rental homes in Denmark as structured JSON, 18 homes per page.

Rentals only

BoligPortal lists homes for rent. It has no sale listings and no bathroom count, so this API has no sale or bathroom parameter. Agency profiles are not available; listing returns the landlord facts BoligPortal shows publicly.

What you get

Each home has id, url, title, category, state, the address parts and postal_code, rooms, size_m2, monthly_rent with currency DKK, monthly_rent_extra_costs, deposit, prepaid_rent, rental_period, available_from, advertised_date, the energy label, 14 features flags, images, location coordinates and listing flags. description is empty in search results; call listing for it. result_count is BoligPortal's own match count and anchor_links lists city match counts.

Filters are honoured

BoligPortal rounds rooms (1.5 rooms matches a search for 2), and it can leave a feature flag unknown. Scrappa checks every returned home again against min_rooms, max_rooms, size, rent, type and each feature flag, and drops homes that do not match. meta.filtered_out_count says how many were dropped, so a page can hold fewer than 18 homes while pagination.has_next stays true.

Sort

order is DEFAULT (newest first), RENT_ASC, RENT_DESC, SIZE_M2_DESC or SIZE_M2_ASC. BoligPortal puts promoted homes first even when a sort is asked for, so Scrappa sorts the returned page by the requested key (meta.sorted_within_page). Paging across pages follows BoligPortal. It does not break ties, so homes with the same rent or size can swap places between pages and one home can show on two adjacent pages.

Locations

location is a city from BoligPortal's own city list. An unknown city returns 422 (unknown_location) with suggestions and costs nothing. district and area narrow inside the city.

Pagination

page is 1-based. A page past the last one returns an empty list with has_next false. A page is never labelled with another page's homes.

BoligPortal Rental Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "result_count": 216,
    "returned": 1,
    "pagination": {
        "page": 1,
        "per_page": 18,
        "pages_count": 12,
        "has_next": true,
        "next_page": 2
    },
    "applied_filters": {
        "location": "k\u00f8benhavn",
        "type": [
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

33 optional filters available.

location string Optional

City such as København, Aarhus or Odense (not case sensitive). Unknown cities return 422 with suggestions.

Example value København
district string Optional

District inside the city, for example valby or frederiksberg.

Example value example
area string Optional

Neighbourhood inside the district.

Example value example
street string Optional

Street name, for example Gammel Køge Landevej.

Example value example
type string Optional

apartment, house, townhouse or room. Comma-separated.

Example value apartment
min_rooms number Optional

Minimum number of rooms, halves allowed, for example 1.5. Applied exactly: the platform rounds, so results are checked again.

Example value 2
max_rooms number Optional

Maximum number of rooms, halves allowed.

Example value 2
min_size integer Optional

Minimum size in square metres.

Example value 10
max_size integer Optional

Maximum size in square metres.

Example value 10
min_rent integer Optional

Minimum monthly rent in DKK, without extra costs.

Example value 10
max_rent integer Optional

Maximum monthly rent in DKK, without extra costs.

Example value 12000
min_rental_period integer Optional

Minimum rental period in months.

Example value 10
available_before string Optional

Latest move-in date, YYYY-MM-DD.

Example value example
min_lat number Optional

South edge of a bounding box. Send all four box values or none.

Example value 10
max_lat number Optional

North edge of a bounding box.

Example value 10
min_lng number Optional

West edge of a bounding box.

Example value 10
max_lng number Optional

East edge of a bounding box.

Example value 10
pet_friendly boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
furnished boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
balcony boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
parking boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
elevator boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
shareable boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
student_only boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
senior_friendly boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
social_housing boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
newbuild boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
electric_charging_station boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
dishwasher boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
washing_machine boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
dryer boolean Optional

true to require the feature. false or omitted applies no filter. Homes where the feature is unknown are left out.

Example value true
order string Optional

DEFAULT (newest first), RENT_ASC, RENT_DESC, SIZE_M2_DESC or SIZE_M2_ASC.

Example value RENT_ASC
page integer Optional

Result page, 1-based. 18 homes per page.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/boligportal/search?location=K%C3%B8benhavn&type=apartment&max_rent=12000&min_rooms=2&max_rooms=2&pet_friendly=true&order=RENT_ASC")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

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

Example response fields

Scan these fields before integrating.

success result_count returned pagination applied_filters listings anchor_links meta

Common listings fields

id url title category
JSON Response
200 OK
{
    "success": true,
    "result_count": 216,
    "returned": 1,
    "pagination": {
        "page": 1,
        "per_page": 18,
        "pages_count": 12,
        "has_next": true,
        "next_page": 2
    },
    "applied_filters": {
        "location": "k\u00f8benhavn",
        "type": [
            "apartment"
        ],
        "max_rent": 12000,
        "order": "RENT_ASC"
    },
    "listings": [
        {
            "id": 5450948,
            "url": "https://www.boligportal.dk/lejligheder/k%C3%B8benhavn/53m2-2-vaer-id-5450948",
            "title": "Perfekt delevenlig 2 v\u00e6relses Valby lejlighed",
            "category": "rental_apartment",
            "state": "ACTIVE_APPROVED",
            "city": "K\u00f8benhavn",
            "city_area": "Valby",
            "city_level_1": "k\u00f8benhavn",
            "city_level_2": "valby",
            "city_level_3": null,
            "postal_code": "2500",
            "street_name": "Gammel K\u00f8ge Landevej",
            "street_number": "178",
            "floor": 2,
            "rooms": 2,
            "size_m2": 53,
            "monthly_rent": 10000,
            "currency": "DKK",
            "monthly_rent_extra_costs": 500,
            "deposit": 30000,
            "prepaid_rent": 0,
            "rental_period": 0,
            "available_from": null,
            "advertised_date": "2026-10-24T14:53:16.021199+00:00",
            "created": "2024-08-11T16:12:32.761437+00:00",
            "energy_rating": "D",
            "energy_label_valid_to": "2030-11-21",
            "features": {
                "pet_friendly": true,
                "furnished": false,
                "balcony": true,
                "parking": true,
                "elevator": false,
                "shareable": true,
                "student_only": false,
                "senior_friendly": false,
                "electric_charging_station": null,
                "dishwasher": true,
                "washing_machine": null,
                "dryer": null,
                "social_housing": false,
                "newbuild": false
            },
            "images": [
                {
                    "url": "https://image-lambda.boligportal.dk/8a0bcaa57234198fed3464214dad171a",
                    "is_floor_plan": false
                }
            ],
            "location": {
                "lat": 55.645,
                "lng": 12.503
            },
            "is_newbuild": false,
            "social_housing": false,
            "has_video": false,
            "digital_showing": false,
            "open_house": null,
            "is_promoted": false,
            "has_owner": true
        }
    ],
    "anchor_links": [
        {
            "name": "K\u00f8benhavn S",
            "count": 74
        }
    ],
    "meta": {
        "endpoint_family": "search",
        "currency": "DKK",
        "filtered_out_count": 0,
        "sorted_within_page": true,
        "billable": true
    }
}

Errors

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

422

Unknown Location

The `location` is not a BoligPortal city (`unknown_location`). BoligPortal would answer an unknown city with zero results, so the request is rejected with up to five suggestions. Non-billable.

{
    "meta": {
        "attempts": 0,
        "billable": false
    },
    "error": {
        "code": "unknown_location",
        "message": "The location is not a known BoligPortal city. Use one of the suggestions.",
        "suggestions": [
            "aarhus"
        ]
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Sale, bathroom and agency filters do not exist. Non-billable.

{
    "errors": {
        "order": [
            "The selected order is invalid."
        ]
    },
    "message": "The order field must be one of DEFAULT, RENT_ASC, RENT_DESC, SIZE_M2_DESC, SIZE_M2_ASC."
}
503

Upstream Unavailable

BoligPortal could not be reached after retries, blocked the request, returned another page than asked for, or returned a page this API could not read (`upstream_unavailable`, `upstream_blocked`, `offset_mismatch`, `parser_drift`, `transport_unavailable`, `no_exit_available`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 4,
        "billable": false
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "BoligPortal did not answer on every attempt."
    },
    "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.