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

BoligPortal Listing Detail API Documentation

GET https://scrappa.co/api/boligportal/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948

Scrappa's GET /api/boligportal/listing returns the full record of one BoligPortal rental ad.

Input

Pass the url returned by search (the full link or just the path). Only BoligPortal rental ad pages are accepted; the host is not taken from your input. A new-build project page returns 422 (detail_not_supported).

What you get

Everything search returns, plus the full description, all images (including floor plans), other_details, address when BoligPortal shows it, breadcrumbs and landlord_information: number of listed rentals, last activity date, profile creation date and whether the landlord is verified with BankID.

Landlord and agency

BoligPortal shows no landlord name or agency profile publicly. A separate agency endpoint does not exist.

Cost note

This route loads the full ad page, which is heavier than the JSON routes. Use listings when you only need the core fields.

BoligPortal Listing Detail API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/boligportal/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948
Auth header
x-api-key
Cost
1 credit/request
url = /lejligheder/k%C3%B8benhavn/53m2-2-vaer-id-5450948
Response preview
200 OK
{
    "success": true,
    "listing": {
        "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",
...

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.

url string Required

Ad url or path from search, for example /lejligheder/k%C3%B8benhavn/53m2-2-vaer-id-5450948.

Example value /lejligheder/k%C3%B8benhavn/53m2-2-vaer-id-5450948

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/boligportal/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948",
    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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948');

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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948', 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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948',
    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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948")
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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948", 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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948', 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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948")
        .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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948", 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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948"
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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948"));
            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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948',
            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/listing?url=%2Flejligheder%2Fk%25C3%25B8benhavn%2F53m2-2-vaer-id-5450948")
        .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 listing meta
JSON Response
200 OK
{
    "success": true,
    "listing": {
        "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,
        "description": "Lys og venlig 2 v\u00e6relses lejlighed med altan, t\u00e6t p\u00e5 S-tog og Valby Langgade.",
        "other_details": null,
        "address": null,
        "landlord_information": {
            "num_rentables": 13,
            "last_activity_date": "2026-10-25",
            "profile_created": "2019-06-01",
            "bank_id_verified": false
        },
        "breadcrumbs": [
            {
                "text": "Lejligheder",
                "url": "https://www.boligportal.dk/lejligheder/"
            }
        ]
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true
    }
}

Errors

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

422

Unsupported Ad Page

The `url` is not a BoligPortal rental ad path (`invalid_url`), or it is a new-build project page (`detail_not_supported`). Non-billable.

{
    "meta": {
        "attempts": 0,
        "billable": false
    },
    "error": {
        "code": "invalid_url",
        "message": "The url is not a BoligPortal rental ad path."
    },
    "success": false
}
404

Not Found

BoligPortal has nothing for this request (`not_found`): an ad that is gone, a list of ids where none exists, or a postal code without a town. Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false
    },
    "error": {
        "code": "not_found",
        "message": "BoligPortal has no result for this request."
    },
    "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.