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

Yad2 Regions and Cities API Documentation

GET https://scrappa.co/api/yad2/regions?type=regions&page=1&limit=50

Return the Yad2 address taxonomy page by page: the eight regions, the full city list, or the neighbourhoods. Region rows carry a region_id, city rows a city_id and neighbourhood rows a hood_id, each with its Hebrew name. The ids are the ones the search endpoint expects, so a region_id from here can be sent straight back as region. A page past the end is a successful, billable answer.

Yad2 Regions and Cities API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yad2/regions?type=regions&page=1&limit=50
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "type": "regions",
        "items": [
            {
                "region_id": 2,
                "region": "\u05d3\u05e8\u05d5\u05dd"
            },
            {
                "region_id": 8,
                "region": "\u05d9\u05e8\u05d5\u05e9\u05dc\u05d9\u05dd"
            },
            {
...

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.

4 optional filters available.

type string Optional

regions, cities or hoods. Defaults to regions.

Example value regions
page integer Optional

1-based page number. Defaults to 1.

Example value 1
limit integer Optional

Rows per page, 1 to 10000. Defaults to 50.

Example value 50
city_id integer Optional

Restrict a hoods lookup to one city_id from the cities list. Optional; the gateway returns the full neighbourhood list without it.

Example value 1234567890

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yad2/regions?type=regions&page=1&limit=50",
    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/regions?type=regions&page=1&limit=50');

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/regions?type=regions&page=1&limit=50', 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/regions?type=regions&page=1&limit=50',
    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/regions?type=regions&page=1&limit=50")
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/regions?type=regions&page=1&limit=50", 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/regions?type=regions&page=1&limit=50', 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/regions?type=regions&page=1&limit=50")
        .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/regions?type=regions&page=1&limit=50", 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/regions?type=regions&page=1&limit=50"
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/regions?type=regions&page=1&limit=50"));
            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/regions?type=regions&page=1&limit=50',
            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/regions?type=regions&page=1&limit=50")
        .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": {
        "type": "regions",
        "items": [
            {
                "region_id": 2,
                "region": "\u05d3\u05e8\u05d5\u05dd"
            },
            {
                "region_id": 8,
                "region": "\u05d9\u05e8\u05d5\u05e9\u05dc\u05d9\u05dd"
            },
            {
                "region_id": 3,
                "region": "\u05ea\u05dc \u05d0\u05d1\u05d9\u05d1 \u05d5\u05d4\u05e1\u05d1\u05d9\u05d1\u05d4"
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 50,
            "total": 8,
            "total_pages": 1,
            "has_more": false
        }
    },
    "meta": {
        "endpoint_family": "regions",
        "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.