# VivaReal Advertiser API Documentation

Scrappa's `GET /api/vivareal/advertiser` returns the business identity of one advertiser: `name`, `logo_url`, `license_number` (CRECI), `tier`, `trust_score`, `created_at`, `minisite` and `listings_total`, the approximate number of live listings.

Take `advertiser_id` from `advertiser.id` in a listing. `legacy_id` is the id used by the portal's public advertiser page. Broker phone numbers are never returned.

An advertiser without a live listing returns 404 `not_found`. A valid answer is billed, including an empty page. Failures never consume credits.

- **Documentation:** [https://scrappa.co/docs/vivareal-api/vivareal_advertiser](https://scrappa.co/docs/vivareal-api/vivareal_advertiser)
- **API group:** VivaReal & ZAP Imoveis API
- **Endpoint:** `GET https://scrappa.co/api/vivareal/advertiser`

## 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 |
| --- | --- | --- | --- |
| `portal` | string | No | ZAP (default) for ZAP Imoveis or VIVAREAL for VivaReal. Both use the same fields and filters. |
| `advertiser_id` | string | Yes | Advertiser uuid. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/vivareal/advertiser?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883"
```

## Example response

```json
{
    "success": true,
    "advertiser": {
        "id": "cef4b87e-6256-8bb2-b798-cf23e10cd883",
        "legacy_id": 810901,
        "legacy_zap_id": null,
        "name": "Example Imoveis Ltda",
        "logo_url": "https://resizedimgs.zapimoveis.com.br/img/vr-listing/718513a5c1a190eb20c1107deb8b40dd/logo.jpg?action=fit-in&dimension=200x200",
        "license_number": null,
        "tier": "diamond",
        "trust_score": null,
        "created_at": "2023-07-26T21:29:17Z",
        "show_address": false,
        "minisite": null,
        "listings_total": 912
    },
    "total_is_approximate": true,
    "meta": {
        "billable": true,
        "endpoint_family": "advertiser",
        "portal": "ZAP",
        "attempts": 1
    }
}
```

## Frequently asked questions

### Is this the official VivaReal or ZAP API?

No. Scrappa is an independent service and is not affiliated with VivaReal, ZAP Imoveis or their owners. Neither portal publishes a developer API.

### Are failed requests charged?

A valid answer is billed, including an empty page. Failures never consume credits.

## Related endpoints

- [Advertiser Listings](https://scrappa.co/docs/vivareal-api/vivareal_advertiser_listings)

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