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

Otodom Count API Documentation

GET https://scrappa.co/api/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT

Endpoint documentation for counting Otodom listings without paging results

How to call the Otodom count endpoint and how to read its totals and facets.

Scrappa's GET /api/otodom/count endpoint returns how many Otodom listings match a filter set, without paging through them.

What the response contains

A total count, a facets block echoing the resolved filters, and point_in_time: true. Otodom's totals shift slightly between calls as listings are published and removed, so treat every count as a reading at a moment in time rather than a stable number to assert against.

Filter validity

Otodom reports an invalid filter through the response type name, not the HTTP status — a bad location id still returns 200. This endpoint checks that type name and returns an INVALID_PARAMETERS error when the filters were rejected, so an invalid request is never billed and never returns a misleading total.

Commercial premises

Otodom counts commercial premises under estate=COMMERCIAL_PROPERTY. That is also the only estate use_types narrows: with any other estate, or with none, Otodom ignores use_types and returns the estate's unfiltered total behind a 200. This endpoint therefore requires estate=COMMERCIAL_PROPERTY whenever use_types is supplied and returns a 422 otherwise, so a caller is never billed for a commercial sub-count that was actually an all-premises count.

Related Otodom endpoints

  • GET /api/otodom/search — the listings themselves
  • GET /api/otodom/locations — to resolve a geo_path

Implementation playbook

What teams build with this endpoint

Market Sizing

Count listings per city, district and quarter to size local supply.

Supply Alerts

Track total counts per filter to detect shifts in market supply.

Otodom Count API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT
Auth header
x-api-key
Cost
1 credit/request
transaction = sprzedaz geo_path = mazowieckie/warszawa/warszawa/warszawa
Response preview
200 OK
{
    "success": true,
    "data": {
        "total": 20226,
        "facets": {
            "location": "mazowieckie/warszawa/warszawa/warszawa",
            "estate": "FLAT",
            "transaction": "SELL",
            "market": "ALL"
        },
        "point_in_time": true
    }
}

Parameters

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

Runnable path

2 required parameters needed before sending a request.

10 optional filters available.

transaction string Required

sprzedaz (sale) or wynajem (rent).

Example value sprzedaz
geo_path string Required

2 to 6 slash-separated segments from the locations endpoint.

Example value mazowieckie/warszawa/warszawa/warszawa
estate string Optional

Estate facet: FLAT, HOUSE, GARAGE, HALL, INVESTMENT, TERRAIN, COMMERCIAL_PROPERTY, OFFICE, BUILDING or ROOM. Counts apartments when omitted. The results-page estate_slug is not accepted here.

Example value FLAT
market string Optional

PRIMARY or SECONDARY.

Example value US
use_types[] array Optional

Commercial sub-slicing: OFFICE, RETAIL, HOTEL, INDUSTRIAL or SERVICES. Requires estate=COMMERCIAL_PROPERTY, and is rejected with a 422 otherwise because Otodom silently ignores it elsewhere.

Example value ["example"]
rooms_number[] array Optional

Room counts: ONE, TWO, THREE, FOUR or FIVE. Repeat for several values. SIX_OR_MORE is not accepted by the count operation. Amenities (extras) are not counted here — use GET /api/otodom/search for those.

Example value ["example"]
owner_type string Optional

DEVELOPER, PRIVATE or AGENCY.

Example value example
price_min integer Optional

Minimum price.

Example value 10
price_max integer Optional

Maximum price. Must be at least price_min.

Example value 10
area_min integer Optional

Minimum floor area in square meters.

Example value 10
area_max integer Optional

Maximum floor area in square meters. Must be at least area_min.

Example value 10
has_discount boolean Optional

true for listings with a discount, false for those without. Omit it to count both.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT",
    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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT');

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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT', 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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT',
    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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT")
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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT", 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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT', 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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT")
        .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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT", 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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT"
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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT"));
            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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT',
            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/otodom/count?transaction=sprzedaz&geo_path=mazowieckie%2Fwarszawa%2Fwarszawa%2Fwarszawa&estate=FLAT")
        .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 data
JSON Response
200 OK
{
    "success": true,
    "data": {
        "total": 20226,
        "facets": {
            "location": "mazowieckie/warszawa/warszawa/warszawa",
            "estate": "FLAT",
            "transaction": "SELL",
            "market": "ALL"
        },
        "point_in_time": true
    }
}

Errors

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

INVALID_PARAMETERS

HTTP INVALID_PARAMETERS

Otodom rejected these filters. This response is not billed.

COUNT_HASH_ROTATED

HTTP COUNT_HASH_ROTATED

Otodom rotated its internal query hash. This response is not billed.

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.

Otodom API FAQ

Why does my count differ slightly between calls?

Listings are published and removed continuously. Counts are point-in-time readings.

What does COUNT_HASH_ROTATED mean?

Otodom changed the internal query this endpoint uses. It affects only the count endpoint and is resolved by re-capturing the hash.

Do I get charged for a rejected filter?

No. Rejected filters return an error and are never billed.

Try It Live

Test this endpoint in our interactive playground with real data.