/centaline/properties/search

POST /api/centaline/properties/search

Price: 5 credits

Search Centaline Hong Kong residential listings for sale or rent across the full filter surface: free-text keyword, Housing Market Area, estate and phase type codes, MTR station, primary school net, nearby university, price, saleable area, price per saleable sq ft, building age, bedroom count, ownership category (private / HOS / public housing), floor band, outlook, unit characteristics, clubhouse facilities, curated categories, required nearby amenities, walking time to the MTR, developer and Centaline branch, with ordering by ranking, price, publish date, saleable or gross area, saleable or gross price per sq ft, or building age. Returns listing cards with prices and rents, the land-premium-paid and premium-unpaid asking prices on subsidised housing, the previous asking price or rent and the percentage cut where the asking has been reduced, gross and saleable areas and per-sq-ft rates, bedroom and ensuite counts, building age, orientation, labels, nearby places, district hierarchy, media availability, coordinates and timestamps.

How to use it

Search Centaline (中原地產) Hong Kong property listings. Set listing_type ('Sale'/'Rent') and count. Narrow by keyword, hma_ids (e.g. 'HMA034'), estates/phases (type codes), mtr_stations, primary_school_nets, universities, min_price/max_price (HKD), min_saleable_area/max_saleable_area (sq ft), min_price_per_sqft/max_price_per_sqft, min_building_age/max_building_age, bedroom_counts, estate_usages, floor_levels, views, characteristics, facilities, topics, nearby_facilities, max_mtr_walk_time, developers, branches and hos_only; order with sort and order. lang switches names and addresses between traditional Chinese, simplified Chinese and English. All areas are in square feet and all money is in HKD. Each result carries id (the Centaline reference number) — pass it to centaline/properties for the same listing on its own.

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")
• listing_type string — Search for-sale or for-rent listings. (default: "Sale"; one of: "Sale", "Rent")
• phases array nullable — Estate phase type codes, e.g. '2-OVDUURFSCJ'. (examples: ["2-OVDUURFSCJ"])
• mtr_stations array nullable — MTR station numbers to search around. (examples: [30])
• primary_school_nets array nullable — Primary school net codes, e.g. '14'. (examples: ["14"])
• universities array nullable — Only listings near these universities. (one of: "香港大學", "香港中文大學", "香港科技大學", "香港理工大學", "香港城市大學", "香港浸會大學", "嶺南大學", "香港樹仁大學")
• min_price integer nullable — Minimum sale price or monthly rent in HKD. (min: 0)
• max_price integer nullable — Maximum sale price or monthly rent in HKD. (min: 0)
• min_saleable_area integer nullable — Minimum saleable area in sq ft. (min: 0)
• max_saleable_area integer nullable — Maximum saleable area in sq ft. (min: 0)
• min_price_per_sqft integer nullable — Minimum price per saleable sq ft in HKD. (min: 0)
• max_price_per_sqft integer nullable — Maximum 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)
• bedroom_counts array nullable — Bedroom counts (0 = studio, 4 = four or more). (examples: [2,3])
• estate_usages array nullable — Property ownership categories to include. (one of: "RE", "HosPaid", "HosUnpaid", "PrhPaid", "PrhUnpaid", "Other")
• floor_levels array nullable — Floor bands to include. (one of: "HighFloor", "MiddleFloor", "LowFloor")
• views array nullable — Outlook types the unit faces. (one of: "Green", "Sea", "Mountain", "Building", "Street", "Pond", "Pool", "River", "Stadium", "Racecourse", "Bridge")
• characteristics array nullable — Special unit features. (one of: "Balcony", "Carpark", "Roof", "Terrace", "Garden", "Carport1", "SwimmingPool", "AdjacentUnit", "DuplexUnit")
• facilities array nullable — Estate clubhouse facilities. (one of: "SwimmingPool", "IndoorSwimmingPool", "ChildrensPool", "Gymnasium", "ChildrenPlaygroundPlayRoom", "PlaygroundPlayroom", "SaunnaRoom", "SteamBathRoom", "Jacuzzi", "TennisCourt", "SquashCourt", "BadmintonCourt", "TableTennis", "SnookerRoom", "GolfDrivingRange", "BallRoom", "ReadingStudyRoom")
• topics array nullable — Curated listing categories. (one of: "mortgage90", "mortgage1125to1500", "hasmatterport", "vrguide", "aivr", "aitalk", "hasvideo", "interior", "keeppet", "midprice", "kol", "haskey", "ssd100", "entry", "mansion", "highrentalreturnestate", "carpark", "soleagent", "above30m", "salemarkdown", "rentmarkdown", "house", "highrent", "latest", "todayspecial", "selection", "discountpost", "mortgagee")
• nearby_facilities array nullable — Amenities that must be nearby. (one of: "NearMtr", "NearArcade", "NearCarpark", "NearEVCharge", "NearLargePark", "NearUniversity")
• max_mtr_walk_time string nullable — Maximum walking time to the nearest MTR station. (one of: "120", "300", "600")
• developers array nullable — Developer codes, e.g. 'de183'. (examples: ["de183"])
• branches array nullable — Centaline branch (cost centre) codes. (examples: ["jol"])
• hos_only boolean nullable — Only subsidised-housing (HOS) listings.
• sort string — Field the results are ordered by. (default: "Ranking"; one of: "Ranking", "PublishDate", "Price", "NSize", "Size", "NUnitPrice", "UnitPrice", "BuildingAge")

Response

• @type string (default: "CentalineProperty")
• id string required
• url string nullable
• listing_type string nullable
• estate_group_name string nullable
• estate_name string nullable
• building_name string nullable
• address string nullable
• district string nullable
• floor_level string nullable
• unit string nullable
• price number nullable
• premium_paid_price number nullable
• premium_unpaid_price number nullable
• original_price number nullable
• price_change_percent number nullable
• rent number nullable
• original_rent number nullable
• rent_change_percent number nullable
• price_text string nullable
• rent_text string nullable
• gross_area number nullable
• saleable_area number nullable
• efficiency_ratio number nullable
• gross_price_per_sqft number nullable
• saleable_price_per_sqft number nullable
• gross_rent_per_sqft number nullable
• saleable_rent_per_sqft number nullable
• rental_yield number nullable
• monthly_mortgage_payment number nullable
• bedroom_count integer nullable
• ensuite_count integer nullable
• building_age integer nullable
• direction string nullable
• building_type string nullable
• unit_type string nullable
• estate_structure string nullable
• is_hos boolean nullable
• is_public_housing boolean nullable
• is_house boolean nullable
• is_sole_agent boolean nullable
• has_key boolean nullable
• is_foreclosure boolean nullable
• is_pet_friendly boolean nullable
• is_hot_listing boolean nullable
• is_director_pick boolean nullable
• with_lease boolean nullable
• is_management_fee_included boolean nullable
• is_government_rates_included boolean nullable
• is_government_rent_included boolean nullable
• estate_group_code string nullable
• estate_code string nullable
• building_code string nullable
• type_code string nullable
• labels array (default: [])
• nearby_places array (default: [])
  • @type string (default: "CentalineNearbyPlace")
  • name string required
  • kind string required
  • walk_minutes integer 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
• aerial_view_url string nullable
• published_at integer nullable
• updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 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 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 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 Wait at least 30 seconds, then retry.

Response 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.