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

Zimmo Agency Profile API Documentation

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

Zimmo Agency Profile API Get one estate agency: name, category, VAT number, business phone numbers, website, address, coordinates, logo, images, operating area, descriptions and review scores.

Only public business data is returned. The flag has_email tells if the agency has an e-mail address, but the address itself is not part of the data.

Zimmo Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zimmo/agency
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "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"
        },
...

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.

1 optional filter available.

id string Required

Agency id (id) from the agencies endpoint or from a listing (agency.id).

Example value 1234567890
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": {
        "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": [
            {
                "url": "https://files.zimmo.be/backend-api/kgBFgS8NuR0OVisK1HCwVDa1ouo=/fit-in/1200x1200/filters:image-format(pjpg)/-/real-estate/customers/b4fa4d68-4bae-11e9-922b-005056b768a1/dealers/75d5bb79-4273-4a50-8085-0cbc093e5d57/images/019aa56f-7284-7f36-af3c-0fa0f18e4099",
                "order": 1,
                "thumbnails": {
                    "original": "https://files.zimmo.be/backend-api/96WDWtP_DK4hR_ZG6KTdINR8FwQ=/filters:image-format(pjpg)/-/real-estate/customers/b4fa4d68-4bae-11e9-922b-005056b768a1/dealers/75d5bb79-4273-4a50-8085-0cbc093e5d57/images/019aa56f-7284-7f36-af3c-0fa0f18e4099",
                    "z-detail": "https://files.zimmo.be/backend-api/kUJifvhLQC2BrFkCTA6_hLsyt4A=/500x380/filters:image-format(pjpg)/-/real-estate/customers/b4fa4d68-4bae-11e9-922b-005056b768a1/dealers/75d5bb79-4273-4a50-8085-0cbc093e5d57/images/019aa56f-7284-7f36-af3c-0fa0f18e4099"
                }
            }
        ],
        "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
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency"
    },
    "success": true
}

Errors

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

404

Not Found

The requested Zimmo agency was not found. Use an agency id from the agencies endpoint. This response is not billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false
    },
    "error": {
        "message": "The requested Zimmo agency was not found. Use an agency id from the agencies endpoint.",
        "failure_type": "agency_not_found"
    },
    "success": false
}
422

Validation Error

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

{
    "errors": {
        "id": [
            "The agency id looks like 75d5bb79-4273-4a50-8085-0cbc093e5d57."
        ]
    },
    "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.