# Vuokraovi Agency Profile API Documentation

Scrappa's `GET /api/vuokraovi/agency` returns the public profile of one rental agency (office) by `id`. Take the id from `office.id` on a listing.

## What you get

`name`, `url`, `description`, `logo_url`, the address, `phone`, `website`, coordinates and the number of rental and sales listings by property type. For the agency's homes call the search endpoint with `office_id`.

## Notes

An id that has no public profile returns `404`, which is never billed.

- **Documentation:** [https://scrappa.co/docs/vuokraovi-api/vuokraovi_agency](https://scrappa.co/docs/vuokraovi-api/vuokraovi_agency)
- **API group:** Vuokraovi API
- **Endpoint:** `GET https://scrappa.co/api/vuokraovi/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` | integer | Yes | Agency office id from a listing, for example 257. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/vuokraovi/agency?id=257"
```

## Example response

```json
{
    "success": true,
    "agency": {
        "id": 257,
        "name": "Ylinkerros Oy",
        "url": "https://www.vuokraovi.com/yritykset/257",
        "description": "KOKEMUKSELLA ON MERKITYST\u00c4!",
        "address": "Runeberginkatu 61",
        "postal_code": "00260",
        "post_office": "HELSINKI",
        "city": "Helsinki",
        "region": "Uusimaa",
        "mobile_phone": "050 365 9200",
        "phone": "050 365 9200",
        "website": "www.ylinkerros.fi",
        "latitude": 60.180639,
        "longitude": 24.924787,
        "rental_listing_counts": {
            "RESIDENTIAL": 4
        },
        "sales_listing_counts": {
            "RESIDENTIAL": 23,
            "PLOT": 5
        }
    },
    "meta": {
        "endpoint_family": "agency",
        "billable": true,
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | Nothing exists with that identifier on Vuokraovi (`not_found`). Non-billable. |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Vuokraovi could not be reached after retries, answered with an error or changed its format (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited. |

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