/centaline/new-properties/search

POST /api/centaline/new-properties/search

Price: 5 credits

Search Hong Kong first-hand (new-build) residential projects listed by Centaline. Filter by free-text keyword, Housing Market Area, estate type code, project id, sales-cycle stage, construction state, ownership category, developer and starting price. Each project carries its Chinese and English name, address and district, sales and property status, starting and discounted prices, sold-out and sole-agency flags, the developer consortium, the first price-list and first sales-arrangement dates, the estimated key handover date, media availability and coordinates.

How to use it

Search Centaline (中原地產) Hong Kong first-hand new-build projects. Set count. Narrow by keyword, hma_ids, estates, projects (project ids), sale_status ('OnSale'/'ComingSoon'/'RegistrationOfIntent'), property_status ('Completed'/'UnsoldUnits'/'OffPlan'), estate_usages, developers and min_price/max_price (HKD). Dates are unix seconds.

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")
• sale_status array nullable — Where the project is in its sales cycle. (one of: "OnSale", "ComingSoon", "RegistrationOfIntent")
• property_status array nullable — Construction state — completed, remaining unsold stock or still off-plan. (one of: "Completed", "UnsoldUnits", "OffPlan")
• estate_usages array nullable — Property ownership categories to include. (one of: "RE", "HOS", "PRH", "Other")
• developers array nullable — Developer codes, e.g. 'de183'. (examples: ["de183"])
• projects array nullable — Project ids to restrict to. (examples: ["2493"])
• min_price integer nullable — Minimum starting price in HKD. (min: 0)
• max_price integer nullable — Maximum starting price in HKD. (min: 0)

Response

• @type string (default: "CentalineNewProperty")
• id string required
• url string nullable
• name string nullable
• name_en string nullable
• address string nullable
• district string nullable
• region string nullable
• sale_status string nullable
• property_status string nullable
• min_price number nullable
• discount_price number nullable
• is_sold_out boolean nullable
• is_sole_agent boolean nullable
• developers array (default: [])
• first_sales_arrangement_at integer nullable
• first_price_list_at integer nullable
• estimated_key_at integer nullable
• created_at integer 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

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.