# Spacious HK Autocomplete API

<p>Find buildings or neighbourhoods by name, in English or Chinese. A building result has the id, both names, address, position, developer, neighbourhood id, build year and a public housing flag. A neighbourhood result has the id, both names and the position. Use the building `id` as `building_id` together with its `neighbourhood_id` in the search. Use a neighbourhood `id` as `neighbourhood_id`. A query without a match returns an empty list.</p>

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

## 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 | Building or neighbourhood name, at least 2 characters, e.g. `imperial`. |
| `type` | string | No | `building` (default) or `neighbourhood`. |
| `limit` | integer | No | Number of results, 1 to 25. Default 10. |

## Example response

```json
{
    "data": {
        "type": "building",
        "query": "imperial",
        "results": [
            {
                "id": 66551,
                "name": "Imperial Kennedy",
                "type": "building",
                "address": "68, Belcher's Street",
                "name_zh": "Imperial Kennedy",
                "latitude": 22.282676,
                "longitude": 114.12869,
                "built_year": 2016,
                "neighbourhood": "Kennedy Town",
                "public_housing": false,
                "neighbourhood_id": 41
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "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)