/centaline/carparks/search

POST /api/centaline/carparks/search

Price: 5 credits

Search Hong Kong carpark spaces listed for sale or rent by Centaline. Filter by free-text keyword, Housing Market Area, estate type code, covered or open-air, private-car or motorcycle space, price range and Centaline branch, ordered by ranking, price or publication date. Each space carries its reference number, estate and building, address and floor, sale price and monthly rent, whether management fees are included, lease status, the district hierarchy, school nets, photos, the handling agents with their licence numbers and coordinates.

How to use it

Search Centaline (中原地產) Hong Kong carpark listings. Set listing_type ('Sale'/'Rent') and count. Narrow by keyword, hma_ids, estates, cover ('Covered'/'Opened'), vehicle_type ('PrivateCar'/'Motorcycle'), min_price/max_price (HKD) and branches; order with sort and order. Carpark spaces in Hong Kong trade as a separate asset class from flats, which is why they are not returned by centaline/properties/search.

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 carparks. (default: "Sale"; one of: "Sale", "Rent")
• cover array nullable — Covered or open-air spaces. (one of: "Covered", "Opened")
• vehicle_type array nullable — Private car or motorcycle spaces. (one of: "PrivateCar", "Motorcycle")
• 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)
• branches array nullable — Centaline branch (cost centre) codes. (examples: ["jtk"])
• sort string — Field the results are ordered by. (default: "Ranking"; one of: "Ranking", "Price", "PublishDate")

Response

• @type string (default: "CentalineCarpark")
• id string required
• url string nullable
• listing_type string nullable
• estate_group_name string nullable
• estate_name string nullable
• address string nullable
• floor_level string nullable
• price number nullable
• rent number nullable
• price_text string nullable
• rent_text string nullable
• building_type string nullable
• unit_type string nullable
• is_management_fee_included boolean nullable
• with_lease boolean nullable
• estate_code string nullable
• building_code string nullable
• type_code string nullable
• school_net object nullable
  • @type string (default: "CentalineSchoolNet")
  • primary_school_net string nullable
  • primary_school_url string nullable
  • secondary_school_district string nullable
  • secondary_school_url 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
• agents array (default: [])
  • @type string (default: "CentalineAgent")
  • id string nullable
  • name string nullable
  • name_en string nullable
  • license string nullable
  • phone string nullable
  • email string nullable
  • branch_code string nullable
  • branch_name string nullable
  • listing_count integer nullable
  • rating number nullable
  • experience string nullable
  • image string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• 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.