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

Zimmo Agency Search API Documentation

GET https://scrappa.co/api/zimmo/agencies

Zimmo Agency Search API Browse the Zimmo agency directory, optionally limited to one place with place_id. Each agency has the same data as the profile endpoint. Page through the results with page and size.

Zimmo Agency Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zimmo/agencies
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "page": 1,
        "size": 5,
        "count": 1,
        "agencies": [
            {
                "id": "75d5bb79-4273-4a50-8085-0cbc093e5d57",
                "lat": 51.0492834,
                "lon": 3.7271016,
                "url": "https://www.zimmo.be/nl/vastgoedkantoor/gent-9000/carlo-eggermont-37045",
                "logo": "https://files.zimmo.be/backend-api/YlO2SpeTAmR9kZXbPVaiNdqohUo=/filters:image-format(pjpg)/-/real-estate/customers/b4fa4d68-4bae-11e9-922b-005056b768a1/logos/01995d00-6e92-7c07-b57b-c29b8ddf32fb",
                "name": "Carlo Eggermont",
                "slug": "carlo-eggermont-37045",
...

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.

place_id integer Optional

Place id from the locations endpoint. Optional.

Example value 1234567890
page integer Optional

Page number, 1 or more. Default 1. Results stop at position 5000.

Example value 1
size integer Optional

Rows per page, 1 to 30. Default 10.

Example value 10
locale string Optional

Language of the flat text fields (title, description, url, city): nl, fr, en or de. Default nl. The full text maps keep all languages.

Example value en-US

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "page": 1,
        "size": 5,
        "count": 1,
        "agencies": [
            {
                "id": "75d5bb79-4273-4a50-8085-0cbc093e5d57",
                "lat": 51.0492834,
                "lon": 3.7271016,
                "url": "https://www.zimmo.be/nl/vastgoedkantoor/gent-9000/carlo-eggermont-37045",
                "logo": "https://files.zimmo.be/backend-api/YlO2SpeTAmR9kZXbPVaiNdqohUo=/filters:image-format(pjpg)/-/real-estate/customers/b4fa4d68-4bae-11e9-922b-005056b768a1/logos/01995d00-6e92-7c07-b57b-c29b8ddf32fb",
                "name": "Carlo Eggermont",
                "slug": "carlo-eggermont-37045",
                "urls": {
                    "en": "https://www.zimmo.be/en/estate-agency/-/carlo-eggermont-37045",
                    "fr": "https://www.zimmo.be/fr/agence-immobiliere/gent-9000/carlo-eggermont-37045",
                    "nl": "https://www.zimmo.be/nl/vastgoedkantoor/gent-9000/carlo-eggermont-37045"
                },
                "phone": "+32492087047",
                "images": [],
                "address": {
                    "box": null,
                    "city": "Gent",
                    "number": "1-102",
                    "street": "Grote Huidevettershoek",
                    "country": "Belgium",
                    "postal_code": "9000",
                    "country_code": "BE"
                },
                "reviews": {
                    "combined": {
                        "max": 10,
                        "count": 65,
                        "score": 8.4
                    },
                    "external": {
                        "max": 5,
                        "count": 63,
                        "score": 4.3
                    },
                    "housematch": {
                        "max": 10,
                        "count": 2,
                        "score": 5.5
                    }
                },
                "website": "www.carloeggermont.be",
                "category": "broker",
                "has_email": true,
                "place_ids": [
                    1506,
                    3,
                    4,
                    580
                ],
                "vat_number": "0536235794",
                "description": null,
                "descriptions": null,
                "mobile_phone": "+32492087047",
                "opening_hours": null,
                "operating_area_place_ids": [
                    1506,
                    3,
                    4,
                    580,
                    1526
                ]
            }
        ],
        "has_more": true,
        "place_id": 1506,
        "total_count": 262
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agencies"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "size": [
            "The size is at most 30."
        ]
    },
    "message": "The request validation failed"
}
503

Temporarily Unavailable

Zimmo did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true
    },
    "error": {
        "message": "Zimmo data is temporarily unavailable. Please retry.",
        "failure_type": "upstream_unavailable"
    },
    "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.

Try It Live

Test this endpoint in our interactive playground with real data.