# Spacious HK Agency Search API

<p>Find agencies and agent shops by name. Each result has the agency id and the licence number. Use the id with the agency endpoint. A query without a match returns an empty list.</p>

- **Documentation:** [https://scrappa.co/docs/spacious-hk-api/spacious_hk_agency_search](https://scrappa.co/docs/spacious-hk-api/spacious_hk_agency_search)
- **API group:** Spacious HK API
- **Endpoint:** `GET https://scrappa.co/api/spacious-hk/agencies/search`

## 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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Agency name, at least 2 characters, e.g. `universal`. |
| `limit` | integer | No | Number of results, 1 to 25. Default 10. |

## Example response

```json
{
    "data": {
        "query": "universal",
        "results": [
            {
                "id": 1837,
                "name": "UNIVERSAL (T.W.) PROPERTY AGENCY LIMITED",
                "licence": "C-037504"
            },
            {
                "id": 1844,
                "name": "UNIVERSAL (S.T.) PROPERTY AGENCY LIMITED",
                "licence": "C-026287"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency_search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | The listing, building or agency does not exist or is no longer online. This response is not billable. |  |
|  | A parameter is missing or invalid. This response is not billable. |  |
|  | Spacious HK is temporarily unavailable, or its answer did not match the request, for example another page or an ignored filter. Retry the request. This response is not billable. |  |

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