# /centaline/estates/search

`POST /api/centaline/estates/search`

Price: 5 credits

Search the Centaline directory of Hong Kong residential estates (屋苑). Filter by free-text keyword, Housing Market Area, estate type code, primary school net, ownership category, clubhouse facilities, developer, average price per saleable sq ft and building age, ordered by ranking, price per sq ft or building age. Each estate carries its type code, name, address, developer and management company, phase/building/unit counts, occupation date range, current sale and rent price levels with month-on-month trend and listing/transaction counts, school nets, district hierarchy and coordinates.

## How to use it

Search Centaline (中原地產) Hong Kong estates. Set count. Narrow by keyword, hma_ids, estates (type codes), primary_school_nets, estate_usages ('RE' private / 'HOS' subsidised / 'PRH' public / 'Other'), facilities, developers, min_price_per_sqft/max_price_per_sqft and min_building_age/max_building_age; order with sort and order. Each result's id is the estate type code — pass it to centaline/estates for the full profile or to centaline/estates/transactions for the building's deal history.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `lang` (string) — Language of the returned names, addresses and descriptions. (default: "hk"; one of: "hk", "sc", "en")
- `count` (integer, required) — Max number of results to return (min: 1)
- `keyword` (string, nullable) — Free-text keyword (estate name, street, school or building).
- `hma_ids` (array, nullable) — Centaline Housing Market Area codes to restrict the search to, e.g. 'HMA034' (Taikoo Shing). (examples: ["HMA034"])
- `estates` (array, nullable) — Estate type codes, e.g. '3-OVDUURFSRJ'. (examples: ["3-OVDUURFSRJ"])
- `order` (string) — Result ordering direction. (default: "Ascending"; one of: "Ascending", "Descending")
- `primary_school_nets` (array, nullable) — Primary school net codes, e.g. '14'. (examples: ["14"])
- `estate_usages` (array, nullable) — Property ownership categories to include. (one of: "RE", "HOS", "PRH", "Other")
- `facilities` (array, nullable) — Clubhouse facilities the estate has. (one of: "SwimmingPool", "IndoorSwimmingPool", "ChildrensPool", "Gymnasium", "ChildrenPlaygroundPlayRoom", "PlaygroundPlayroom", "SaunnaRoom", "SteamBathRoom", "Jacuzzi", "TennisCourt", "SquashCourt", "BadmintonCourt", "TableTennis", "SnookerRoom", "GolfDrivingRange", "BallRoom", "ReadingStudyRoom")
- `developers` (array, nullable) — Developer codes, e.g. 'de183'. (examples: ["de183"])
- `min_price_per_sqft` (integer, nullable) — Minimum average price per saleable sq ft in HKD. (min: 0)
- `max_price_per_sqft` (integer, nullable) — Maximum average price per saleable sq ft in HKD. (min: 0)
- `min_building_age` (integer, nullable) — Minimum building age in years. (min: 0)
- `max_building_age` (integer, nullable) — Maximum building age in years. (min: 0)
- `sort` (string) — Field the results are ordered by. (default: "Ranking"; one of: "Ranking", "NUnitPrice", "BuildingAge")

## Response

### 200 — Successful Response

- `@type` (string) (default: "CentalineEstateSummary")
- `id` (string, required)
- `url` (string, nullable)
- `name` (string, nullable)
- `phase_name` (string, nullable)
- `address` (string, nullable)
- `estate_structure` (string, nullable)
- `developer` (string, nullable)
- `management_company` (string, nullable)
- `phase_count` (integer, nullable)
- `building_count` (integer, nullable)
- `unit_count` (integer, nullable)
- `min_building_age` (integer, nullable)
- `max_building_age` (integer, nullable)
- `first_occupation_at` (integer, nullable)
- `last_occupation_at` (integer, nullable)
- `sale` (object, nullable)
  - `@type` (string) (default: "CentalinePriceTrend")
  - `saleable_price_per_sqft` (number, nullable)
  - `saleable_price_per_sqft_change_percent` (number, nullable)
  - `gross_price_per_sqft` (number, nullable)
  - `gross_price_per_sqft_change_percent` (number, nullable)
  - `min_price` (number, nullable)
  - `max_price` (number, nullable)
  - `min_saleable_price_per_sqft` (number, nullable)
  - `max_saleable_price_per_sqft` (number, nullable)
  - `listing_count` (integer, nullable)
  - `transaction_count` (integer, nullable)
- `rent` (object, nullable)
  - `@type` (string) (default: "CentalinePriceTrend")
  - `saleable_price_per_sqft` (number, nullable)
  - `saleable_price_per_sqft_change_percent` (number, nullable)
  - `gross_price_per_sqft` (number, nullable)
  - `gross_price_per_sqft_change_percent` (number, nullable)
  - `min_price` (number, nullable)
  - `max_price` (number, nullable)
  - `min_saleable_price_per_sqft` (number, nullable)
  - `max_saleable_price_per_sqft` (number, nullable)
  - `listing_count` (integer, nullable)
  - `transaction_count` (integer, nullable)
- `school_net` (object, nullable)
  - `@type` (string) (default: "CentalineSchoolNet")
  - `primary_school_net` (string, nullable)
  - `primary_school_url` (string, nullable)
  - `secondary_school_district` (string, nullable)
  - `secondary_school_url` (string, nullable)
- `scope` (object, nullable)
  - `@type` (string) (default: "CentalineScope")
  - `region` (string, nullable)
  - `region_code` (string, nullable)
  - `district` (string, nullable)
  - `district_code` (string, nullable)
  - `area` (string, nullable)
  - `area_code` (string, nullable)
  - `hma` (string, nullable)
  - `hma_id` (string, nullable)
  - `hma_description` (string, nullable)
  - `image` (string, nullable)
- `media` (object, nullable)
  - `@type` (string) (default: "CentalineMediaFlags")
  - `has_media` (boolean, nullable)
  - `has_photos` (boolean, nullable)
  - `has_street_view` (boolean, nullable)
  - `has_sphere` (boolean, nullable)
  - `has_video` (boolean, nullable)
  - `has_virtual_tour` (boolean, nullable)
  - `has_floor_plan` (boolean, nullable)
  - `has_planning_diagram` (boolean, nullable)
  - `has_unit_plan` (boolean, nullable)
  - `has_aerial_view` (boolean, nullable)
  - `has_building_3d_model` (boolean, nullable)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `image` (string, nullable)
- `updated_at` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.