# 28Hse Autocomplete API

<p>Find estates by name, in English or Chinese, and get the estate id and district. Use the id as `estate_id` in the search. A keyword without a match returns an empty list. The keyword needs at least 2 characters.</p>

- **Documentation:** [https://scrappa.co/docs/28hse-api/28hse_autocomplete](https://scrappa.co/docs/28hse-api/28hse_autocomplete)
- **API group:** 28Hse API
- **Endpoint:** `GET https://scrappa.co/api/28hse/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 |
| --- | --- | --- | --- |
| `keyword` | string | Yes | Estate or location name, at least 2 characters, e.g. `Taikoo`. |
| `mode` | string | No | `buy` (default) or `rent`. |

## Example response

```json
{
    "data": {
        "mode": "buy",
        "keyword": "Taikoo",
        "results": [
            {
                "id": "1140",
                "name": "TaiKoo Shing",
                "text": "TaiKoo Shing (Taikoo Shing)",
                "district": "Taikoo Shing"
            },
            {
                "id": "1141",
                "name": "Splendid Place",
                "text": "Splendid Place (Quarry Bay)",
                "district": "Quarry Bay"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | The listing 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. |  |
|  | 28Hse 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)