# 28Hse Search API

<p>Search apartments for sale or rent on 28Hse, the Hong Kong property portal. Filter by exact bedroom count, price bucket, saleable or gross area bucket, district and estate, sort and page through the results, 15 listings per page. Every returned listing satisfies every filter you send, and the response lists the filters that were applied. A page past the last page returns an empty list with the real total. Each listing carries the id, title, district, estate, saleable area, price per square foot, agency, price as text and as a number in HKD, tags, bedrooms and photo count. Rent is HK$ per month, sale is the total in HK$. The posted text is relative ("2 hours ago"), not a date. Open a listing by id for the exact position, dates and photos.</p>

- **Documentation:** [https://scrappa.co/docs/28hse-api/28hse_search](https://scrappa.co/docs/28hse-api/28hse_search)
- **API group:** 28Hse API
- **Endpoint:** `GET https://scrappa.co/api/28hse/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 |
| --- | --- | --- | --- |
| `mode` | string | Yes | `buy` for properties for sale, `rent` for properties for rent. |
| `bedrooms` | integer | No | Exact number of bedrooms: `1`, `2`, `3` or `4`. Omit for all. |
| `price_range` | integer | No | Price bucket. Buy: `1` below HK$2M, `2` HK$2M-4M, `3` HK$4M-8M, `4` HK$8M-20M, `5` above HK$20M. Rent per month: `1` below HK$5,000, `2` HK$5,000-10,000, `3` HK$10,000-15,000, `4` HK$15,000-20,000, `5` HK$20,000-40,000, `6` above HK$40,000. The site offers these steps only. |
| `area_type` | string | No | Which area the area range applies to: `saleable` or `gross`. Needs area_range. |
| `area_range` | integer | No | Area bucket in square feet: `1` below 300, `2` 300-500, `3` 500-1,000, `4` 1,000-2,000, `5` above 2,000. Needs area_type. |
| `estate_id` | string | No | Estate id from the autocomplete endpoint, e.g. `1140` for Taikoo Shing. |
| `location` | string | No | District code from the `district.location` field of a search result, e.g. `di47-24259`. |
| `sort` | string | No | `default`, `latest`, `price_low`, `price_high`, `saleable_area_low`, `saleable_area_high`, `gross_area_low`, `gross_area_high`, `unit_price_saleable_low`, `unit_price_saleable_high`, `unit_price_gross_low` or `unit_price_gross_high`. Price and unit price sorts leave out listings without a price, so their total is a little smaller. |
| `page` | integer | No | Page number, 1-based, up to 3000. 15 listings per page. |

## Example response

```json
{
    "data": {
        "mode": "buy",
        "page": 1,
        "total": 6312,
        "filters": {
            "sort": "default",
            "bedrooms": 2,
            "price_label": "HK$4M-8M",
            "price_range": 3
        },
        "listings": [
            {
                "id": "4069683",
                "url": "https://www.28hse.com/en/buy/apartment/property-4069683",
                "mode": "buy",
                "tags": [
                    "2 Bedrooms",
                    "North east",
                    "Apartment",
                    "Henderson"
                ],
                "grade": "Golden",
                "price": 4040000,
                "title": "Received 13,000 in rent. Received 4% return!",
                "estate": {
                    "id": "4214",
                    "name": "Sheung Shui Centre"
                },
                "bedrooms": 2,
                "currency": "HKD",
                "district": {
                    "id": "105",
                    "name": "Sheung Shui",
                    "location": "di112-105"
                },
                "thumbnail": "https://i1.28hse.com/2026/10/202610252320003487430_thumb.jpg",
                "price_text": "Sale HK$4.04 million",
                "agency_name": "Midland Property",
                "photo_count": 7,
                "posted_text": "2 hours ago",
                "property_type": "apartment",
                "price_per_sqft": 11510,
                "unit_description": "Unit D,Low Floor,BLOCK 1",
                "saleable_area_sqft": 351
            }
        ],
        "per_page": 15,
        "total_pages": 421
    },
    "meta": {
        "billable": true,
        "endpoint_family": "search"
    },
    "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)