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

Yad2 Listing Details API Documentation

GET https://scrappa.co/api/yad2/listing?token=hei3dmp5

Return one public Yad2 real-estate listing by its token: the price in Israeli shekels with the ILS currency, the full address down to the street, house number and floor with coordinates, the property details with room count, built area, condition, entrance date, balcony, parking and top floor, the amenity flags, every image, the seller-facing description as plain text, the marketing tags and the listing dates in ISO 8601 UTC. An unknown token answers a non-billed 404.

Yad2 Listing Details API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yad2/listing?token=hei3dmp5
Auth header
x-api-key
Cost
1 credit/request
token = hei3dmp5
Response preview
200 OK
{
    "success": true,
    "data": {
        "token": "hei3dmp5",
        "order_id": 57601142,
        "ad_number": 67115601,
        "ad_type": "private",
        "category_id": 2,
        "subcategory_id": 1,
        "status_id": 1,
        "price": 1950000,
        "currency": "ILS",
        "address": {
            "top_area": {
...

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.

token string Required

Listing token from a search result, for example hei3dmp5. Letters and digits only.

Example value hei3dmp5

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yad2/listing?token=hei3dmp5",
    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/listing?token=hei3dmp5');

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/listing?token=hei3dmp5', 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/listing?token=hei3dmp5',
    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/listing?token=hei3dmp5")
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/listing?token=hei3dmp5", 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/listing?token=hei3dmp5', 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/listing?token=hei3dmp5")
        .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/listing?token=hei3dmp5", 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/listing?token=hei3dmp5"
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/listing?token=hei3dmp5"));
            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/listing?token=hei3dmp5',
            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/listing?token=hei3dmp5")
        .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": {
        "token": "hei3dmp5",
        "order_id": 57601142,
        "ad_number": 67115601,
        "ad_type": "private",
        "category_id": 2,
        "subcategory_id": 1,
        "status_id": 1,
        "price": 1950000,
        "currency": "ILS",
        "address": {
            "top_area": {
                "id": "41",
                "text": "\u05e9\u05e4\u05dc\u05d4 \u05d5\u05de\u05d9\u05e9\u05d5\u05e8 \u05d4\u05d7\u05d5\u05e3 \u05d4\u05d3\u05e8\u05d5\u05de\u05d9",
                "text_eng": "shfela"
            },
            "region": {
                "id": "2",
                "text": "\u05d3\u05e8\u05d5\u05dd",
                "text_eng": "South"
            },
            "area": {
                "id": "21",
                "text": "\u05d0\u05d6\u05d5\u05e8 \u05d0\u05e9\u05d3\u05d5\u05d3, \u05d0\u05e9\u05e7\u05dc\u05d5\u05df \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4",
                "text_eng": "ashdod_askelon"
            },
            "city": {
                "id": "7100",
                "text": "\u05d0\u05e9\u05e7\u05dc\u05d5\u05df"
            },
            "neighborhood": {
                "id": "471",
                "text": "\u05d1\u05e8\u05e0\u05e2"
            },
            "street": {
                "id": "0988",
                "text": "\u05d9\u05d5\u05e0\u05ea\u05df \u05e0\u05ea\u05e0\u05d9\u05d4\u05d5"
            },
            "house": {
                "number": 8,
                "floor": 10
            },
            "coords": {
                "lat": 31.688916,
                "lon": 34.578495
            },
            "address_master_id": 5848394
        },
        "details": {
            "property": {
                "id": "1",
                "text": "\u05d3\u05d9\u05e8\u05d4",
                "text_eng": "apartment"
            },
            "property_group": {
                "id": "1",
                "text": "\u05d3\u05d9\u05e8\u05d5\u05ea",
                "text_eng": "apartments"
            },
            "property_condition": {
                "id": "2",
                "text": "\u05de\u05e9\u05d5\u05e4\u05e5"
            },
            "rooms_count": 4,
            "square_meter": 120,
            "parking_spaces_count": 1,
            "balconies_count": 1,
            "building_top_floor": 14,
            "entrance_date": "2026-10-10",
            "is_entrance_date_flexible": true
        },
        "amenities": {
            "airconditioner": true,
            "balcony": true,
            "elevator": true,
            "parking": true,
            "security_room": true,
            "handicapped_access": true
        },
        "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"
        ],
        "description": "\u05dc\u05de\u05db\u05d9\u05e8\u05d4 \u05dc\u05dc\u05d0 \u05ea\u05d9\u05d5\u05d5\u05da  \u05d3\u05d9\u05e8\u05ea 4 \u05d7\u05d3\u05e8\u05d9\u05dd \u05de\u05e8\u05d5\u05d5\u05d7\u05ea \u05d1\u05de\u05d9\u05d5\u05d7\u05d3 \u05d1\u05de\u05e6\u05e4\u05d4 \u05d1\u05e8\u05e0\u05e2. \u05d7\u05e0\u05d9\u05d4 \u05e4\u05e8\u05d8\u05d9\u05ea \u05d1\u05d8\u05d0\u05d1\u05d5. \u05dc\u05d5\u05d1\u05d9 \u05de\u05e4\u05d5\u05d0\u05e8 \u05d52 \u05de\u05e2\u05dc\u05d9\u05d5\u05ea.",
        "shelter_distance_m": 870,
        "customer": {
            "name": "\u05e1\u05e8\u05d2\u05d9\u05d9",
            "id": 3022972
        },
        "dates": {
            "updated_at": "2026-10-15T12:02:51Z",
            "created_at": "2026-10-10T19:33:22Z",
            "ends_at": "2027-10-09T21:00:00Z",
            "rebounced_at": "2026-10-15T15:02:51Z"
        },
        "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"
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true
    }
}

Errors

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

404

Listing Not Found

Yad2 has no listing with that token. The gateway answers its own 404, and the request is never charged.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "Yad2 has no listing with that token."
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": false,
        "retryable": false
    }
}
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.