/centaline/commercial/buildings/search

POST /api/centaline/commercial/buildings/search

Price: 5 credits

Search the Centaline Commercial (中原工商舖) directory of Hong Kong commercial buildings — offices, industrial blocks and retail properties. Filter by sub-district, property class and free-text keyword. Each building carries its Centaline building id, Chinese and English names, street address, use class, developers, year of occupation, floor count and typical floor-plate range, live sale and lease listing counts, recorded transaction count, media availability and the district hierarchy.

How to use it

Search the Centaline Commercial (中原工商舖) Hong Kong commercial building database. Set count; narrow by districts (sub-district codes such as 'WS004'), departments ('O' office, 'I' industrial, 'R' retail, 'P' carpark) and keyword. Each result's building_id can be passed as building_id to centaline/commercial/properties/search to list every unit on the market in that building.

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 labels. (default: "hk"; one of: "hk", "sc", "en")
• count integer required — Max number of results to return (min: 1)
• keyword string nullable — Free-text keyword (district, building, street or property number).
• districts array nullable — Sub-district codes, e.g. 'WS004' (Central). (examples: ["WS004"])
• departments array nullable — Property class the building is catalogued under. (one of: "O", "I", "R", "P")

Response

• @type string (default: "CentalineCommercialBuilding")
• id string required
• building_id string nullable
• name string nullable
• name_en string nullable
• address string nullable
• usage string nullable
• usage_label string nullable
• developers array (default: [])
• occupation_year integer nullable
• occupation_year_text string nullable
• floor_count integer nullable
• floor_text string nullable
• floor_area_text string nullable
• sale_listing_count integer nullable
• rent_listing_count integer nullable
• transaction_count integer nullable
• has_video boolean nullable
• has_360_view boolean nullable
• has_virtual_tour boolean nullable
• area object nullable
  • @type string (default: "CentalineCommercialArea")
  • zone_id string nullable
  • zone string nullable
  • district_id string nullable
  • district string 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.