# Imovirtual Agency Profile API Documentation

Retrieve a real estate agency profile from Imovirtual: id, name, slug, public url, logo, business address and seller badges, plus aggregate statistics (ads for sale, ads for rent, cities with ads and the account creation date). Contact details are never returned. An unknown agency returns a non-billable 404.

- **Documentation:** [https://scrappa.co/docs/imovirtual-api/imovirtual_agency](https://scrappa.co/docs/imovirtual-api/imovirtual_agency)
- **API group:** Imovirtual API
- **Endpoint:** `GET https://scrappa.co/api/imovirtual/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 |
| --- | --- | --- | --- |
| `agency` | string | Yes | Agency slug with its numeric id, e.g. trimovel-ID2872714. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/imovirtual/agency?agency=trimovel-ID2872714"
```

## Example response

```json
{
    "success": true,
    "data": {
        "agency": {
            "id": 2872714,
            "name": "Trim\u00f3vel",
            "slug": "trimovel-ID2872714",
            "url": "https://www.imovirtual.com/pt/empresas/agencias-imobiliarias/trimovel-ID2872714",
            "type": "agency",
            "sellerBadges": [
                "quality-leader-pro"
            ]
        },
        "statistics": {
            "sellAds": 82,
            "rentAds": 5,
            "citiesWithAds": 21,
            "createdAt": "2019-02-08"
        }
    },
    "meta": {
        "endpoint_family": "agency",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | The requested Imovirtual resource was not found. Not billed. |
|  | Error | Imovirtual could not be reached. Not billed. |
|  | Error | Imovirtual rejected the request. Not billed. |
|  | Error | The upstream service is temporarily unavailable. Please retry shortly. |
|  | Error | Imovirtual returned an unexpected payload shape. Not billed. |

## 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)