/centaline/commercial/transactions/search

POST /api/centaline/commercial/transactions/search

Price: 5 credits

Search recorded Hong Kong commercial property transactions published by Centaline Commercial (中原工商舖) — offices, industrial units, shops and commercial carparks. Filter by property class, sale or letting, sub-district and free-text keyword. Each record carries the building with a link to its transaction page, address, floor and unit, deal type, transacted price or monthly rent with per-sq-ft rates, area, whether the price is an estimate, the reporting source, the transaction date and the district hierarchy.

How to use it

Search Centaline Commercial (中原工商舖) Hong Kong commercial transactions. Set count and usage ('Any'/'Office'/'Industrial'/'Retail'/'Carpark'); narrow by deal_type ('B' both, 'S' sales, 'R' lettings), districts (sub-district codes) and keyword. The list is lease-heavy, so set deal_type='S' for sales. Residential deals live in centaline/transactions/search instead. building_profile_id matches the id of centaline/commercial/buildings/search, so you can go from a deal to that building's full profile. Areas are square feet, money is HKD, transacted_at is 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 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"])
• usage string — Property class to search. (default: "Any"; one of: "Any", "Office", "Industrial", "Retail", "Carpark")
• deal_type string — Sales, lettings, or both. (default: "B"; one of: "B", "S", "R")

Response

• @type string (default: "CentalineCommercialTransaction")
• id string required
• url string nullable
• building_id string nullable
• building_profile_id string nullable
• building_name string nullable
• building_name_en string nullable
• address string nullable
• deal_type string nullable
• usage string nullable
• usage_label string nullable
• floor string nullable
• unit string nullable
• price number nullable
• price_text string nullable
• price_per_sqft number nullable
• rent number nullable
• rent_text string nullable
• rent_per_sqft number nullable
• gross_area number nullable
• area_text string nullable
• is_price_estimated boolean nullable
• source string nullable
• transacted_at integer nullable
• area object nullable
  • @type string (default: "CentalineCommercialArea")
  • zone_id string nullable
  • zone string nullable
  • district_id string nullable
  • district 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.