# Homely Agency Profile API Documentation

Scrappa's `GET /api/homely/office` returns the public profile of one Homely agency (office). Send the numeric `id`, which is `office.id` in search and listing results.

## What you get

`name`, `slug`, `address`, `email`, `phone`, `website`, `lat`, `lng`, `branding`, `associations`, `subscription` and `franchise_id`.

## Agents

Homely has no public agent profile data. The agents of a listing, with name, phone and email, come with the search and listing results.

## Unknown ids

An id that Homely does not know answers `404` (`not_found`) and is not billed. An id that is not a number answers `422`.

- **Documentation:** [https://scrappa.co/docs/homely-api/homely_office](https://scrappa.co/docs/homely-api/homely_office)
- **API group:** Homely API
- **Endpoint:** `GET https://scrappa.co/api/homely/office`

## 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 | Numeric office id from search or listing (office.id), for example 38010. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/homely/office?id=38010"
```

## Example response

```json
{
    "success": true,
    "office": {
        "id": 38010,
        "name": "Sample Realty Mandurah",
        "slug": "sample-realty-mandurah",
        "address": "Unit 2/32 Sample Road Mandurah WA 6210 Australia",
        "email": "office@example.com",
        "phone": "08 5550 0100",
        "website": "https://example.com/",
        "subscription": "basic",
        "lat": -32.53443,
        "lng": 115.7209,
        "branding": {
            "color": "#FFE206"
        },
        "associations": [],
        "franchise_id": 9004
    },
    "meta": {
        "endpoint_family": "office",
        "billable": true,
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | No agency exists with that id (`not_found`). Non-billable. |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored (`request_rejected` is the same failure raised by the source). Non-billable. |
| 503 | Source Unavailable | Homely could not be reached in time, refused the request, or its answer changed shape (`upstream_unavailable`, `request_blocked`, `deadline_exhausted`, `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)