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

Sreality Public Brokers API

GET https://scrappa.co/api/sreality/brokers?agency_id=12345

Return public broker profiles associated with one Sreality agency.

Public agency contacts

The response carries the agency’s publicly listed broker details and contact information, together with pagination data. Contact details are returned as published and are not verified independently.

Scope

Supply the positive agency identifier. This endpoint lists broker information for an agency; it does not send messages or submit contact requests.

Sreality Public Brokers API 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/sreality/brokers?agency_id=12345
Auth header
x-api-key
Cost
1 credit/request
agency_id = 12345
Response preview
200 OK
{
    "success": true,
    "data": {
        "results": [
            {
                "user_id": 4312,
                "user_name": "Jan Nov\u00e1k",
                "broker_ico": "12345678",
                "broker_rating": 4.8,
                "broker_review_count": 37,
                "sdn_url": "https://www.sreality.cz/realitni-makleri/jan-novak"
            }
        ],
        "pagination": {
...

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.

agency_id integer Required

Positive Sreality agency identifier.

Example value 12345

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/sreality/brokers?agency_id=12345",
    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/sreality/brokers?agency_id=12345');

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/sreality/brokers?agency_id=12345', 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/sreality/brokers?agency_id=12345',
    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/sreality/brokers?agency_id=12345")
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/sreality/brokers?agency_id=12345", 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/sreality/brokers?agency_id=12345', 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/sreality/brokers?agency_id=12345")
        .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/sreality/brokers?agency_id=12345", 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/sreality/brokers?agency_id=12345"
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/sreality/brokers?agency_id=12345"));
            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/sreality/brokers?agency_id=12345',
            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/sreality/brokers?agency_id=12345")
        .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": {
        "results": [
            {
                "user_id": 4312,
                "user_name": "Jan Nov\u00e1k",
                "broker_ico": "12345678",
                "broker_rating": 4.8,
                "broker_review_count": 37,
                "sdn_url": "https://www.sreality.cz/realitni-makleri/jan-novak"
            }
        ],
        "pagination": {
            "limit": 20,
            "offset": 0,
            "total": 8
        }
    },
    "meta": {
        "endpoint_family": "brokers",
        "billable": true,
        "retryable": false
    }
}

Errors

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

422

Validation Error

The agency identifier is missing or invalid. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "brokers"
    },
    "error": {
        "code": "validation_failed",
        "message": "The agency_id parameter must be a positive integer."
    },
    "success": false
}
503

Broker Data Temporarily Unavailable

The public broker data could not be returned. This response is not billable.

{
    "meta": {
        "attempts": 4,
        "billable": false,
        "retryable": true,
        "endpoint_family": "brokers"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Broker data is temporarily unavailable. Please retry."
    },
    "success": 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.

Sreality API FAQ

What does the broker endpoint return?

It returns publicly listed profiles associated with the requested agency, including public contact fields when present.

Can I use this endpoint to contact a broker?

No. It provides public profile data only and does not submit messages or contact requests.

Try It Live

Test this endpoint in our interactive playground with real data.