# Imovirtual Categories API Documentation

List the transaction and estate category slugs Imovirtual publishes, parsed live from the site category sitemap. Use `transactions` and `estates` to build the `transaction` and `estate` values for the search endpoint. Comma combinations such as moradia,t3 are returned as published.

- **Documentation:** [https://scrappa.co/docs/imovirtual-api/imovirtual_categories](https://scrappa.co/docs/imovirtual-api/imovirtual_categories)
- **API group:** Imovirtual API
- **Endpoint:** `GET https://scrappa.co/api/imovirtual/categories`

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

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/imovirtual/categories"
```

## Example response

```json
{
    "success": true,
    "data": {
        "transactions": [
            "arrendar",
            "comprar"
        ],
        "estates": [
            "apartamento",
            "apartamento,nova-construcao",
            "apartamento,t1",
            "armazens",
            "empreendimento",
            "garagem",
            "imoveis-comerciais",
            "moradia",
            "quarto",
            "t0",
            "terreno"
        ]
    },
    "meta": {
        "endpoint_family": "categories",
        "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)