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

Madlan Listing Search API

GET https://scrappa.co/api/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3

Search Madlan's public property listings and receive them as structured JSON. Results cover apartments, houses and land across Israel for both sale and rent, with price, room count, floor, size, address, coordinates, images, amenities and price history for each listing. All text is returned in Hebrew exactly as published.

Madlan Listing Search API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "offset": 0,
    "limit": 3,
    "matched_upstream": 3230,
    "total": null,
    "deal_type": "unitRent",
    "returned": 3,
    "filtered_out_by_deal_type": 0,
    "page_fill": 1,
    "listings": [
        {
            "id": "lcqaJQo4LjP",
            "price": 8000,
...

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.

8 optional filters available.

query string Optional

Free-text search matched against the listing description. Hebrew is supported and returned as raw UTF-8.

Example value coffee shops
deal_type string Optional

unitBuy for sale or unitRent for rent. Sale and rent listings are separated after the search returns, because Madlan does not offer a server-side deal type filter.

Example value unitRent
price_min number Optional

Minimum price in Israeli shekels.

Example value 0
price_max number Optional

Maximum price in Israeli shekels. Usable on its own; when price_min is also given, it must be greater than or equal to it.

Example value 6000
beds number Optional

Number of bedrooms.

Example value 3
floor number Optional

Floor number.

Example value 10
offset integer Optional

Number of listings to skip.

Example value 10
limit integer Optional

Number of listings to return, 1 to 100.

Example value 3

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3",
    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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3');

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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3', 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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3',
    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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3")
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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3", 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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3', 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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3")
        .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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3", 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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3"
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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3"));
            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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3',
            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/madlan/search?deal_type=unitRent&price_min=0&price_max=6000&beds=3&limit=3")
        .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 offset limit matched_upstream total deal_type returned filtered_out_by_deal_type +4 more

Common listings fields

id price currency dealType
JSON Response
200 OK
{
    "success": true,
    "offset": 0,
    "limit": 3,
    "matched_upstream": 3230,
    "total": null,
    "deal_type": "unitRent",
    "returned": 3,
    "filtered_out_by_deal_type": 0,
    "page_fill": 1,
    "listings": [
        {
            "id": "lcqaJQo4LjP",
            "price": 8000,
            "currency": "NIS",
            "dealType": "unitRent",
            "beds": 6,
            "baths": 2,
            "area": 150,
            "floor": "2",
            "address": "\u05e0\u05d5\u05e3 \u05d4\u05e8\u05d5\u05d3\u05d9\u05d5\u05df 1, \u05e0\u05d5\u05d5\u05d4 \u05d3\u05e0\u05d9\u05d0\u05dc",
            "description": "\u05de\u05d5\u05dc \u05e0\u05d5\u05e3 \u05e4\u05ea\u05d5\u05d7 \u05d5\u05e2\u05d5\u05e6\u05e8 \u05e0\u05e9\u05d9\u05de\u05d4 \u05e9\u05dc \u05d4\u05e8\u05d9 \u05d9\u05d4\u05d5\u05d3\u05d4, \u05d1\u05e9\u05db\u05d5\u05e0\u05d4 \u05d7\u05d3\u05e9\u05d4...",
            "structuredAddress": {
                "text": "\u05e0\u05d5\u05e3 \u05d4\u05e8\u05d5\u05d3\u05d9\u05d5\u05df 1, \u05e0\u05d5\u05d5\u05d4 \u05d3\u05e0\u05d9\u05d0\u05dc",
                "city": "\u05e0\u05d5\u05d5\u05d4 \u05d3\u05e0\u05d9\u05d0\u05dc",
                "streetName": "\u05e0\u05d5\u05e3 \u05d4\u05e8\u05d5\u05d3\u05d9\u05d5\u05df"
            },
            "locationPoint": {
                "lat": 32.1846,
                "lng": 34.9875
            },
            "images": [
                {
                    "imageUrl": "https://images.madlan.co.il/...",
                    "isFloorplan": false
                }
            ]
        }
    ],
    "notes": [
        "For sale and for rent are separated after the search returns: Madlan rejects every server-side deal type field, so rows are matched on their own deal type after they come back.",
        "matched_upstream is Madlan's own count and covers sale and rent together, because the deal type split happens after the search returns. On a deal_type query total is null for that reason: there is no honest total for the scoped subset.",
        "Madlan serves search results from a rotating shard set, so consecutive pages can overlap or skip. Use the listing corpus endpoint to enumerate ids.",
        "page_fill is the share of the requested page that was actually filled, after the deal type split removed rows. It is not a measure of how much of the corpus this request covered."
    ],
    "meta": {
        "attempts": 1,
        "duration_ms": 412
    }
}

Errors

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

503

Madlan rejected the query

Madlan answered the request but refused to compute it. Branch on `error.code`: this response is not retryable. Nothing is charged for a failed request.

{
    "error": {
        "code": "upstream_rejected",
        "message": "Madlan rejected this query.",
        "retryable": false,
        "http_status": 503
    },
    "success": false
}
503

Madlan refused the request

Madlan answered with a client-side rejection before running the query, for example a bad path or an unsupported document. Retrying the same request changes nothing. Branch on `error.code`: this response is not retryable. Nothing is charged.

{
    "error": {
        "code": "upstream_request_rejected",
        "message": "Madlan rejected this request.",
        "retryable": false,
        "http_status": 503
    },
    "success": false
}
503

Madlan returned an unreadable response

Madlan answered, but not with the shape this endpoint reads, for example an HTML page where structured data was expected. The request was not answered, so it is not billed. Branch on `error.code`: this response is not retryable.

{
    "error": {
        "code": "unexpected_response_shape",
        "message": "Madlan returned an unexpected response.",
        "retryable": false,
        "http_status": 503
    },
    "success": false
}
503

Madlan is temporarily unavailable

The upstream could not be reached, returned a server error, or throttled the request. `rate_limited_upstream` is the throttle path and is retryable once the wait has passed; `upstream_unavailable` covers a connection that could not be established, a server error, and a listing corpus that is still cold — the corpus is built in the background, so a cold one is a 503 that schedules a rebuild rather than a fan-out inside your request. Branch on `error.code`, then try again shortly. Nothing is charged.

{
    "error": {
        "code": "upstream_unavailable",
        "message": "Madlan is temporarily unavailable. Please retry.",
        "retryable": true,
        "http_status": 503
    },
    "success": false
}
422

Invalid parameters

One or more parameters are missing, out of range, or a filter Madlan cannot apply. Filters it cannot apply are refused rather than ignored, so the response never carries the unfiltered corpus in answer to a filter. The response lists the offending fields.

{
    "errors": {
        "limit": [
            "The limit may not be greater than 100."
        ]
    },
    "message": "The request validation failed"
}
404

No record under that id

The id is well-formed and Madlan answered, but nothing is published under it. The body carries `found => false`. The lookup was answered, so it is billed; unlike a 503 this is not an upstream fault and retrying will not change it.

{
    "found": false,
    "notes": [
        "Nothing is published under that id."
    ],
    "record": null,
    "success": true
}

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.