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

Yad2 Real Estate Search API Documentation

GET https://scrappa.co/api/yad2/search?deal=forsale&region=2&page=1

Search public Yad2 real-estate listings for sale or for rent in one region, with price, rooms, floor, size, property type and sorting filters and one-based paging. Each listing carries its token, advertiser type, numeric price in Israeli shekels with the ILS currency, the full address with coordinates, the property details, every image, the marketing tags and the public web url. Promoted listings that are ordinary ads (platinum, trio, booster and king of the har) ride along in buckets. A page past the end of the result set is a successful, billable answer.

Yad2 Real Estate Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yad2/search?deal=forsale&region=2&page=1
Auth header
x-api-key
Cost
1 credit/request
deal = forsale region = 2
Response preview
200 OK
{
    "success": true,
    "data": {
        "deal": "forsale",
        "region": 2,
        "listings": [
            {
                "token": "hei3dmp5",
                "order_id": 57601142,
                "ad_type": "private",
                "category_id": 2,
                "subcategory_id": 1,
                "price": 1950000,
                "currency": "ILS",
...

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.

14 optional filters available.

deal string Required

forsale for the sale feed or rent for the rental feed. Required.

Example value forsale
region integer Required

Region id from the regions endpoint, for example 2 for the south or 8 for Jerusalem. Required.

Example value 2
page integer Optional

1-based page number. Defaults to 1. The gateway returns 20 private and 20 agency listings per page.

Example value 1
minPrice integer Optional

Lower price bound in Israeli shekels.

Example value 10
maxPrice integer Optional

Upper price bound in Israeli shekels.

Example value 10
minRooms number Optional

Lower bound on the room count, decimals allowed (3.5).

Example value 10
maxRooms number Optional

Upper bound on the room count.

Example value 10
minSquaremeter number Optional

Lower bound on the built area in square meters.

Example value 10
maxSquaremeter number Optional

Upper bound on the built area in square meters.

Example value 10
minSquareMeterBuild number Optional

Lower bound on the built area excluding the garden, in square meters.

Example value 10
maxSquareMeterBuild number Optional

Upper bound on the built area excluding the garden, in square meters.

Example value 10
minFloor number Optional

Lower bound on the floor, -1 for a basement.

Example value 10
maxFloor number Optional

Upper bound on the floor.

Example value 10
property integer Optional

Property type id from the property facet, for example 1 for an apartment, 5 for a private house or 33 for a plot.

Example value 10
propertyCondition integer Optional

Property condition id from the property facet rows.

Example value 10
sort integer Optional

Sort order id as used by the Yad2 feed.

Example value relevance

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yad2/search?deal=forsale&region=2&page=1",
    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/yad2/search?deal=forsale&region=2&page=1');

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/yad2/search?deal=forsale&region=2&page=1', 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/yad2/search?deal=forsale&region=2&page=1',
    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/yad2/search?deal=forsale&region=2&page=1")
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/yad2/search?deal=forsale&region=2&page=1", 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/yad2/search?deal=forsale&region=2&page=1', 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/yad2/search?deal=forsale&region=2&page=1")
        .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/yad2/search?deal=forsale&region=2&page=1", 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/yad2/search?deal=forsale&region=2&page=1"
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/yad2/search?deal=forsale&region=2&page=1"));
            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/yad2/search?deal=forsale&region=2&page=1',
            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/yad2/search?deal=forsale&region=2&page=1")
        .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 meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "deal": "forsale",
        "region": 2,
        "listings": [
            {
                "token": "hei3dmp5",
                "order_id": 57601142,
                "ad_type": "private",
                "category_id": 2,
                "subcategory_id": 1,
                "price": 1950000,
                "currency": "ILS",
                "address": {
                    "region": {
                        "id": "2",
                        "text": "\u05d3\u05e8\u05d5\u05dd"
                    },
                    "area": {
                        "text": "\u05d0\u05d6\u05d5\u05e8 \u05d0\u05e9\u05d3\u05d5\u05d3, \u05d0\u05e9\u05e7\u05dc\u05d5\u05df \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4"
                    },
                    "city": {
                        "id": "7100",
                        "text": "\u05d0\u05e9\u05e7\u05dc\u05d5\u05df"
                    },
                    "neighborhood": {
                        "id": "471",
                        "text": "\u05d1\u05e8\u05e0\u05e2"
                    },
                    "street": {
                        "text": "\u05d9\u05d5\u05e0\u05ea\u05df \u05e0\u05ea\u05e0\u05d9\u05d4\u05d5"
                    },
                    "house": {
                        "number": 8,
                        "floor": 10
                    },
                    "coords": {
                        "lat": 31.688916,
                        "lon": 34.578495
                    }
                },
                "details": {
                    "property": {
                        "text": "\u05d3\u05d9\u05e8\u05d4"
                    },
                    "property_condition": {
                        "id": "2"
                    },
                    "rooms_count": 4,
                    "square_meter": 120
                },
                "cover_image": "https://img.yad2.co.il/Pic/202610/10/2_1/o/y2_1pa_010545_20261010223138.jpeg",
                "images": [
                    "https://img.yad2.co.il/Pic/202610/10/2_1/o/y2_1pa_010545_20261010223138.jpeg",
                    "https://img.yad2.co.il/Pic/202610/10/2_1/o/y2_1pa_010921_20261010223139.jpeg"
                ],
                "tags": [
                    {
                        "name": "\u05d7\u05e0\u05d9\u05d4",
                        "id": 903,
                        "priority": 1
                    },
                    {
                        "name": "\u05de\u05de\"\u05d3",
                        "id": 909,
                        "priority": 1
                    }
                ],
                "web_url": "https://www.yad2.co.il/item/hei3dmp5"
            }
        ],
        "buckets": {
            "platinum": [
                {
                    "token": "d3jocwiu",
                    "ad_type": "commercial",
                    "price": 1100000,
                    "currency": "ILS",
                    "web_url": "https://www.yad2.co.il/item/d3jocwiu"
                }
            ]
        },
        "pagination": {
            "page": 1,
            "total": 16891,
            "total_pages": 702,
            "has_more": true
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

503

Yad2 Upstream Unavailable

Yad2 could not be reached for this request after the attempt budget. Never charged.

{
    "success": false,
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Yad2 API is temporarily unavailable. Please retry."
    },
    "meta": {
        "endpoint_family": "search",
        "billable": false,
        "retryable": true
    }
}
503

Yad2 Refused

Yad2 refused every attempt for this request instead of answering with data. The response is never charged.

{
    "success": false,
    "error": {
        "code": "UPSTREAM_BLOCKED",
        "message": "The upstream service is temporarily unavailable. Please retry shortly."
    },
    "meta": {
        "endpoint_family": "search",
        "billable": false,
        "retryable": true
    }
}
422

Invalid Parameter

Yad2 refused a value in this request. The request is never forwarded upstream and is never charged.

{
    "success": false,
    "error": {
        "code": "INVALID_PARAMETER",
        "message": "Yad2 rejected this request. Check the parameters and retry."
    },
    "meta": {
        "endpoint_family": "search",
        "billable": false,
        "retryable": false
    }
}
502

Parser Drift

Yad2 answered with a payload this parser does not recognise. The incident has been reported; retrying returns the same body.

{
    "success": false,
    "error": {
        "code": "PARSER_DRIFT",
        "message": "Yad2 answered with a payload this parser does not recognise. The incident has been reported."
    },
    "meta": {
        "endpoint_family": "search",
        "billable": false,
        "retryable": 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.