# Zimmo Agency Profile API Documentation

<p><strong>Zimmo Agency Profile API</strong> Get one estate agency: name, category, VAT number, business phone numbers, website, address, coordinates, logo, images, operating area, descriptions and review scores.</p><p>Only public business data is returned. The flag <code>has_email</code> tells if the agency has an e-mail address, but the address itself is not part of the data.</p>

- **Documentation:** [https://scrappa.co/docs/zimmo-api/zimmo_agency](https://scrappa.co/docs/zimmo-api/zimmo_agency)
- **API group:** Zimmo API
- **Endpoint:** `GET https://scrappa.co/api/zimmo/agency`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Agency id (id) from the agencies endpoint or from a listing (agency.id). |
| `locale` | string | No | 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 response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested Zimmo agency was not found. Use an agency id from the agencies endpoint. This response is not billable. |
| 422 | Validation Error | A required parameter is missing or invalid. This response is not billable. |
| 503 | Temporarily Unavailable | Zimmo did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)