/centaline/properties

POST /api/centaline/properties

Price: 1 credit

Get a single Centaline Hong Kong listing by its reference number (or detail URL). Returns the listing with sale price and monthly rent, the land-premium-paid and premium-unpaid asking prices on subsidised housing, the previous asking price or rent and the percentage cut where the asking has been reduced, gross and saleable areas plus efficiency ratio, price and rent per sq ft, rental yield, monthly mortgage estimate, bedroom and ensuite counts, building age and orientation, ownership flags, lease and inclusive-charge flags, estate/building/type codes, labels, nearby places, the district hierarchy, media availability, coordinates and publish/update timestamps.

How to use it

Get one Centaline (中原地產) Hong Kong listing by reference number, e.g. property='EGA952'. A full detail URL is accepted too. lang switches names and addresses between traditional Chinese, simplified Chinese and English. Areas are in square feet, money in HKD. Use centaline/properties/search to find reference numbers.

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")
• property string required — Centaline listing reference number, or the listing detail URL. (examples: "EGA952")

Response

• @type string (default: "CentalineProperty")
• id string required
• url string nullable
• listing_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
• premium_paid_price number nullable
• premium_unpaid_price number nullable
• original_price number nullable
• price_change_percent number nullable
• rent number nullable
• original_rent number nullable
• rent_change_percent number nullable
• price_text string nullable
• rent_text string nullable
• gross_area number nullable
• saleable_area number nullable
• efficiency_ratio number nullable
• gross_price_per_sqft number nullable
• saleable_price_per_sqft number nullable
• gross_rent_per_sqft number nullable
• saleable_rent_per_sqft number nullable
• rental_yield number nullable
• monthly_mortgage_payment number nullable
• bedroom_count integer nullable
• ensuite_count integer nullable
• building_age integer nullable
• direction string nullable
• building_type string nullable
• unit_type string nullable
• estate_structure string nullable
• is_hos boolean nullable
• is_public_housing boolean nullable
• is_house boolean nullable
• is_sole_agent boolean nullable
• has_key boolean nullable
• is_foreclosure boolean nullable
• is_pet_friendly boolean nullable
• is_hot_listing boolean nullable
• is_director_pick boolean nullable
• with_lease boolean nullable
• is_management_fee_included boolean nullable
• is_government_rates_included boolean nullable
• is_government_rent_included boolean nullable
• estate_group_code string nullable
• estate_code string nullable
• building_code string nullable
• type_code string nullable
• labels array (default: [])
• nearby_places array (default: [])
  • @type string (default: "CentalineNearbyPlace")
  • name string required
  • kind string required
  • walk_minutes integer 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
• latitude number nullable
• longitude number nullable
• image string nullable
• aerial_view_url string nullable
• published_at integer nullable
• 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 — No live Centaline listing with this reference number. 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.