Return the live Yad2 search facets for one deal. Each requested field comes back as a list of rows with the display text, the value to send back to the search endpoint, and the facet group or breadcrumb trail where the gateway provides one. Ask for city, area, property and rooms by default, or name any other field the Yad2 app uses. A field the gateway does not know comes back as an empty list, which is a successful, billable answer.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
forsale or rent. Required.
forsale
string
Optional
Comma-separated facet names, up to 12. Defaults to city,area,property,rooms. Without a field list the gateway answers an empty result.
city,area,property,rooms
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms")
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
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/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms"
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/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/yad2/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/filters?deal=forsale&fields=city%2Carea%2Cproperty%2Crooms")
.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
{
"success": true,
"data": {
"deal": "forsale",
"facets": {
"city": [
{
"text": "\u05de\u05d1\u05e9\u05e8\u05ea \u05e6\u05d9\u05d5\u05df",
"value": "1015",
"breadcrumbs": [
"\u05de\u05d7\u05d5\u05d6 \u05d9\u05e8\u05d5\u05e9\u05dc\u05d9\u05dd",
"\u05d0\u05d6\u05d5\u05e8 \u05d4\u05e8\u05d9 \u05d9\u05d4\u05d5\u05d3\u05d4, \u05de\u05d1\u05e9\u05e8\u05ea \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4"
]
},
{
"text": "\u05d0\u05d5\u05e8 \u05e2\u05e7\u05d9\u05d1\u05d0",
"value": "1020",
"breadcrumbs": [
"\u05d7\u05d3\u05e8\u05d4, \u05d6\u05db\u05e8\u05d5\u05df \u05d5\u05d4\u05e2\u05de\u05e7\u05d9\u05dd",
"\u05d0\u05d6\u05d5\u05e8 \u05e7\u05d9\u05e1\u05e8\u05d9\u05d4 \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4"
]
}
],
"area": [
{
"text": "\u05e6\u05e4\u05d5\u05df",
"value": "25"
},
{
"text": "\u05d0\u05d6\u05d5\u05e8 \u05d7\u05d9\u05e4\u05d4 \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4",
"value": "5"
}
],
"property": [
{
"text": "\u05d3\u05d9\u05e8\u05d4",
"value": "1",
"group": "apartments",
"advanced_search": false
},
{
"text": "\u05d3\u05d9\u05e8\u05ea \u05d2\u05df",
"value": "3",
"group": "apartments",
"advanced_search": false
}
],
"rooms": []
}
},
"meta": {
"endpoint_family": "filters",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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
}
}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
}
}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
}
}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.