/centaline/transactions/search

POST /api/centaline/transactions/search

Price: 5 credits

Search Hong Kong property transactions recorded by Centaline — Land Registry filings plus Centaline's own closed deals, covering roughly three years of sales and leases. Filter by deal type, look-back period, free-text keyword, Housing Market Area, estate and phase type codes, primary school net, record source, first- or second-hand market, ownership category, price, saleable area, price per saleable sq ft, building age, bedroom count and developer, ordered by date, price, area or price per sq ft. Each record has the address down to the unit, price, gross and saleable areas with per-sq-ft rates, bedroom count, orientation, occupation year, building group, instrument and registration dates and coordinates.

How to use it

Search Centaline (中原地產) Hong Kong property transactions. Set deal_type ('Sale'/'Rent'), period ('Day30'…'Day1095') and count. Narrow by keyword, hma_ids, estates/phases, primary_school_nets, source ('Land' = Land Registry, 'AC' = Centaline), market ('FirstHand'/'SecondHand'), estate_usages, price, saleable area, price per sq ft, building age, bedroom_counts and developers; order with sort and order. Areas are square feet, money is HKD, instrument_at/registered_at 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")
• deal_type string — Sale or lease transactions. (default: "Sale"; one of: "Sale", "Rent")
• period string — How far back to look. (default: "Day30"; one of: "Day30", "Day90", "Day180", "Day365", "Day1095")
• phases array nullable — Estate phase type codes, e.g. '2-OVDUURFSCJ'. (examples: ["2-OVDUURFSCJ"])
• primary_school_nets array nullable — Primary school net codes, e.g. '14'. (examples: ["14"])
• source array nullable — Where the record came from — the Land Registry or Centaline's own deals. (one of: "Land", "AC")
• market array nullable — First-hand (primary) or second-hand deals. (one of: "FirstHand", "SecondHand")
• estate_usages array nullable — Property ownership categories to include. (one of: "RE", "HOS", "PRH", "Carpark", "Other")
• min_price integer nullable — Minimum transaction price in HKD. (min: 0)
• max_price integer nullable — Maximum transaction price 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: [3])
• developers array nullable — Developer codes, e.g. 'de183'. (examples: ["de183"])
• sort string — Field the results are ordered by. (default: "InsOrRegDate"; one of: "InsOrRegDate", "Price", "NSize", "NUnitPrice")

Response

• @type string (default: "CentalineTransaction")
• id string required
• url string nullable
• deal_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
• gross_area number nullable
• saleable_area number nullable
• gross_price_per_sqft number nullable
• saleable_price_per_sqft number nullable
• bedroom_count integer nullable
• direction string nullable
• unit_type_code string nullable
• estate_structure string nullable
• occupation_year string nullable
• source string nullable
• market string nullable
• instrument_at integer nullable
• registered_at integer nullable
• building_group_id string nullable
• building_group_name string nullable
• unit_code string nullable
• type_code 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
• image string nullable
• floor_plans array (default: [])

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.