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

Gratka Property Search API Documentation

GET https://scrappa.co/api/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap

Scrappa's GET /api/gratka/search returns Gratka property listings in Poland, for sale (transaction=sale, the default) or for rent (rent), as structured JSON.

What you get

One request returns one page of up to 35 listings and Gratka's own match count in total. Each listing has id, url, title, price with price_formatted, price_per_m2, area_m2, rooms, floor_label, a structured address, all photos as image links, plan, video and 3D flags, the start of the description, dates, a promoted flag and the agent company and person. Call the listing endpoint for the full record with coordinates, features and fees.

Types

type is one of mieszkania (flats, the default), domy (houses), pokoje (rooms), lokale-uzytkowe (commercial), garaze (garages) or dzialki-grunty (plots). Plots, garages and commercial units have no room count, so rooms is null there. Rooms (pokoje) are sale only on Gratka. Combined with rent they return 404.

Filters are honoured

Gratka applies price, area, rooms, location and sort itself. Unknown parameters are rejected with 422 instead of being ignored, because Gratka would ignore them and return every listing. Bedrooms and bathrooms are not filterable on Gratka. They are returned per listing in the listing endpoint. applied_filters echoes what was sent.

Rows that break a price, area or rooms filter are removed, and their number is reported in meta.filtered_out. A row without a price is kept, because a missing value is not a violation. If every row on a page breaks the filter, the request fails without charge.

Location

location takes a city, for example warszawa or Kraków, and district takes a district of that city, for example mokotow. Use the search_params of the location-autocomplete endpoint. A place Gratka does not know returns 404.

Pagination

page is 1-based, 35 listings per page, up to page 200. total_pages and has_more describe the real result set. A page that does not exist returns 404 (page_out_of_range) without charge. Page 2 never contains page 1 data.

Data quality

Values pass through as sellers entered them. A few sale listings show a rent-sized price, and some listings ask for the price, so price is null there.

Gratka Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "transaction": "rent",
    "type": "mieszkania",
    "applied_filters": {
        "location": "krakow",
        "district": null,
        "rooms": null,
        "price_min": null,
        "price_max": 3000,
        "area_min": null,
        "area_max": null,
        "sort": "cheap"
    },
...

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.

11 optional filters available.

type string Optional

mieszkania (default), domy, pokoje, lokale-uzytkowe, garaze or dzialki-grunty.

Example value mieszkania
transaction string Optional

sale (default) or rent.

Example value rent
location string Optional

City name or slug from location-autocomplete, for example warszawa.

Example value krakow
district string Optional

District name or slug inside the city, for example mokotow. Needs location.

Example value example
price_min integer Optional

Minimum total price in PLN (monthly rent for rent listings).

Example value 10
price_max integer Optional

Maximum total price in PLN (monthly rent for rent listings).

Example value 3000
area_min integer Optional

Minimum area in square metres.

Example value 10
area_max integer Optional

Maximum area in square metres.

Example value 10
rooms integer Optional

Exact room count: 2, 3 or 4. Flats only.

Example value 10
sort string Optional

newest, oldest, cheap, expensive, cheap-m2, expensive-m2, rooms-few, rooms-many, small or large. Default order is most recently refreshed.

Example value cheap
page integer Optional

Result page, 1-200. 35 listings per page.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap",
    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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap');

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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap', 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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap',
    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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap")
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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap", 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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap', 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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap")
        .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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap", 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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap"
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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap"));
            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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap',
            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/gratka/search?type=mieszkania&transaction=rent&location=krakow&price_max=3000&sort=cheap")
        .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 transaction type applied_filters total page per_page total_pages +3 more

Common listings fields

id url title headline
JSON Response
200 OK
{
    "success": true,
    "transaction": "rent",
    "type": "mieszkania",
    "applied_filters": {
        "location": "krakow",
        "district": null,
        "rooms": null,
        "price_min": null,
        "price_max": 3000,
        "area_min": null,
        "area_max": null,
        "sort": "cheap"
    },
    "total": 1503,
    "page": 1,
    "per_page": 35,
    "total_pages": 43,
    "has_more": true,
    "listings": [
        {
            "id": "49402269",
            "url": "https://gratka.pl/nieruchomosci/mieszkanie-krakow-bronowice-ojcowska/ob/49402269",
            "title": "mieszkanie do wynaj\u0119cia",
            "headline": "Mieszkanie do wynaj\u0119cia, 153 m\u00b2, 5 pokoi Krak\u00f3w Bronowice",
            "price": {
                "amount": 4900,
                "currency": "PLN"
            },
            "price_formatted": "4 900 z\u0142",
            "price_per_m2": {
                "amount": 32.03,
                "currency": "PLN"
            },
            "price_per_m2_formatted": "32 z\u0142/m\u00b2",
            "area_m2": 153,
            "rooms": 5,
            "rooms_label": "5 pokoi",
            "floor_label": "pi\u0119tro 1",
            "address": {
                "voivodeship": "ma\u0142opolskie",
                "city": "Krak\u00f3w",
                "district": "Bronowice",
                "neighbourhood": null,
                "street": "Ojcowska",
                "street_number": null,
                "county": null,
                "commune": null,
                "latitude": null,
                "longitude": null
            },
            "photos": [
                {
                    "url": "https://d-gr.cdngr.pl/kadry/k/r/gr-ogl/aa/bb/49402269_1.jpg",
                    "alt": "Mieszkanie do wynaj\u0119cia 153m2 Krak\u00f3w Bronowice - zdj\u0119cie 1"
                }
            ],
            "photo_count": 12,
            "plans_count": 0,
            "has_3d_view": false,
            "has_video": false,
            "description": "Przestronne mieszkanie w nowym budynku...",
            "added_at": "2026-10-26",
            "refreshed_at": null,
            "is_promoted": false,
            "is_development": false,
            "agent": {
                "company": {
                    "id": 222179,
                    "name": "Nieruchomo\u015bci Splendor",
                    "type": "AGENCY",
                    "address": [
                        "Tadeusza Ko\u015bciuszki 75/40",
                        "30-114 Krak\u00f3w"
                    ],
                    "logo": "https://d-gr.cdngr.pl/kadry/k/r/gr-plogo/a4/bb/222179_1629328035.jpg"
                },
                "person": {
                    "name": "Iwona Franusiak",
                    "type": "AGENT",
                    "photo": "https://img2.staticmorizon.com.pl/thumbnail/example/200/200/2/thumbnail.jpg"
                }
            }
        }
    ],
    "meta": {
        "endpoint_family": "search",
        "billable": true,
        "attempts": 1,
        "filtered_out": 0
    }
}

Errors

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

404

Not Found

Gratka has no listing page for that type, location and transaction, or no results on that page (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "not_found",
        "message": "No Gratka record exists for that request."
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
503

Upstream Unavailable

Gratka could not be reached after retries, answered with an error, or returned a page without the expected data (`upstream_unavailable`, `upstream_blocked`, `upstream_rejected`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Gratka 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.