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

BoligPortal Price Histogram API Documentation

GET https://scrappa.co/api/boligportal/price-histogram?location=K%C3%B8benhavn&type=apartment

Scrappa's GET /api/boligportal/price-histogram returns the monthly rent distribution of the matching rentals in 50 equal-width buckets.

Reading the buckets

min_price is the start of the first bucket and bucket_width the width of each, in DKK. buckets[i] is the number of homes with a rent from min_price + i * bucket_width up to the next bucket.

Filters

All search filters except rent bounds, order and page. The histogram covers the whole rent range. With a rooms filter meta.count_exact is false because BoligPortal rounds half rooms.

BoligPortal Price Histogram API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/boligportal/price-histogram?location=K%C3%B8benhavn&type=apartment
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "currency": "DKK",
    "min_price": 2500,
    "max_price": 30000,
    "bucket_width": 550,
    "buckets": [
        3,
        4,
        17,
        15,
        33
    ],
    "applied_filters": {
...

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.

29 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 10
max_rooms number Optional

Maximum number of rooms, halves allowed.

Example value 10
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_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

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/boligportal/price-histogram?location=K%C3%B8benhavn&type=apartment",
    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/price-histogram?location=K%C3%B8benhavn&type=apartment');

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/price-histogram?location=K%C3%B8benhavn&type=apartment', 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/price-histogram?location=K%C3%B8benhavn&type=apartment',
    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/price-histogram?location=K%C3%B8benhavn&type=apartment")
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/price-histogram?location=K%C3%B8benhavn&type=apartment", 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/price-histogram?location=K%C3%B8benhavn&type=apartment', 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/price-histogram?location=K%C3%B8benhavn&type=apartment")
        .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/price-histogram?location=K%C3%B8benhavn&type=apartment", 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/price-histogram?location=K%C3%B8benhavn&type=apartment"
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/price-histogram?location=K%C3%B8benhavn&type=apartment"));
            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/price-histogram?location=K%C3%B8benhavn&type=apartment',
            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/price-histogram?location=K%C3%B8benhavn&type=apartment")
        .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 currency min_price max_price bucket_width buckets applied_filters meta
JSON Response
200 OK
{
    "success": true,
    "currency": "DKK",
    "min_price": 2500,
    "max_price": 30000,
    "bucket_width": 550,
    "buckets": [
        3,
        4,
        17,
        15,
        33
    ],
    "applied_filters": {
        "location": "k\u00f8benhavn",
        "type": [
            "apartment"
        ]
    },
    "meta": {
        "endpoint_family": "price_histogram",
        "count_exact": 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.