Search the published Madlan agency and agent index, optionally narrowed to one city and to agents or offices. Each entry carries the office or agent id, name, city, neighbourhood docId, published phone number and ranking category, which makes this the fastest way to build an agency directory for a city and then resolve the ids through the agent endpoints.
Run this endpoint
Endpoint
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.
string
Optional
Match against the published city name, for example חיפה.
חיפה
string
Optional
agent or office.
agent
integer
Optional
Number of entries to skip.
10
integer
Optional
Number of entries to return, 1 to 100.
3
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&limit=3');
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/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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
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/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&limit=3', 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/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&limit=3"
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/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&limit=3"));
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/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&limit=3',
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/madlan/agents-index?city=%D7%97%D7%99%D7%A4%D7%94&role=agent&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
total_entries
total_index_entries
offset
limit
returned
entries
notes
Common entries fields
role
agentName
agentId
city
{
"success": true,
"total_entries": 229,
"total_index_entries": 6587,
"offset": 0,
"limit": 3,
"returned": 3,
"entries": [
{
"role": "agent",
"agentName": "Dan Schwarzmann",
"agentId": "re_agent_gA5a9JnwQDY",
"city": "\u05d7\u05d9\u05e4\u05d4",
"category": "top_10"
}
],
"notes": [
"This is a ranking and geography index, not a complete agency directory: entries carry a ranking category and most are unranked.",
"Entries carry office and agent ids that the agent and office endpoints accept directly."
]
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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
}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
}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
}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
}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"
}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.