/centaline/estates

POST /api/centaline/estates

Price: 10 credits

Get the full profile of a Hong Kong residential estate (屋苑) by its Centaline type code. Returns the estate name in Chinese and English, address and prose description, ownership category, developer and management company, phase/building/unit counts, first and last occupation dates, walking time to the MTR, clubhouse facilities and category labels, current sale and rent price levels with month-on-month trend and listing and transaction counts, the Centaline adjusted price and rent per sq ft with the rental yield, the phase list with per-phase listing counts, 2021 census figures for the surrounding area (population, households, median age, income, rent, mortgage, spoken language, education and tenure), the school nets, the district hierarchy, the agents and branches that cover the estate, photos, site floor plans and coordinates.

How to use it

Get one Centaline (中原地產) Hong Kong estate by type code, e.g. estate='3-OVDUURFSRJ' (太古城 / Taikoo Shing). The estate page URL is accepted too. Type codes start with 3- (estate group), 2- (phase) or 1- (single building); find them with centaline/estates/search. lang switches text between traditional Chinese, simplified Chinese and English. Areas are square feet, money is HKD.

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")
• estate string required — Centaline estate type code, or the estate page URL. (examples: "3-OVDUURFSRJ")

Response

• @type string (default: "CentalineEstate")
• id string required
• url string nullable
• name string nullable
• name_en string nullable
• phase_name string nullable
• phase_name_en string nullable
• address string nullable
• description string nullable
• estate_usage string nullable
• developer string nullable
• management_company string nullable
• phase_count integer nullable
• building_count integer nullable
• unit_count integer nullable
• first_occupation_at integer nullable
• last_occupation_at integer nullable
• mtr_station string nullable
• mtr_walk_minutes integer nullable
• facilities array (default: [])
• category_labels array (default: [])
• sale object nullable
  • @type string (default: "CentalinePriceTrend")
  • saleable_price_per_sqft number nullable
  • saleable_price_per_sqft_change_percent number nullable
  • gross_price_per_sqft number nullable
  • gross_price_per_sqft_change_percent number nullable
  • min_price number nullable
  • max_price number nullable
  • min_saleable_price_per_sqft number nullable
  • max_saleable_price_per_sqft number nullable
  • listing_count integer nullable
  • transaction_count integer nullable
• rent object nullable
  • @type string (default: "CentalinePriceTrend")
  • saleable_price_per_sqft number nullable
  • saleable_price_per_sqft_change_percent number nullable
  • gross_price_per_sqft number nullable
  • gross_price_per_sqft_change_percent number nullable
  • min_price number nullable
  • max_price number nullable
  • min_saleable_price_per_sqft number nullable
  • max_saleable_price_per_sqft number nullable
  • listing_count integer nullable
  • transaction_count integer nullable
• adjusted_sale_price_per_sqft number nullable
• adjusted_rent_per_sqft number nullable
• rental_yield number nullable
• phases array (default: [])
  • @type string (default: "CentalineEstatePhase")
  • id string required
  • name string nullable
  • sale_listing_count integer nullable
  • rent_listing_count integer nullable
  • latitude number nullable
  • longitude number 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
• branches array (default: [])
  • @type string (default: "CentalineBranch")
  • id string required
  • url string nullable
  • name string nullable
  • branch_code string nullable
  • branch_name string nullable
  • district string nullable
  • address string nullable
  • phone string nullable
  • fax string nullable
  • manager_name string nullable
  • manager_name_en string nullable
  • manager_id string nullable
  • agent_count integer nullable
  • listing_count integer nullable
  • sale_listing_count integer nullable
  • rent_listing_count 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
  • latitude number nullable
  • longitude number nullable
  • image string nullable
• census object nullable
  • @type string (default: "CentalineEstateCensus")
  • statistical_year integer nullable
  • population number nullable
  • household_count number nullable
  • median_age number nullable
  • average_household_size number nullable
  • median_household_income number nullable
  • median_monthly_rent number nullable
  • median_rent_to_income_ratio number nullable
  • median_mortgage_payment number nullable
  • median_mortgage_to_income_ratio number nullable
  • cantonese_speaking_percent number nullable
  • putonghua_speaking_percent number nullable
  • english_speaking_percent number nullable
  • tertiary_education_percent number nullable
  • secondary_education_percent number nullable
  • primary_education_percent number nullable
  • owner_occupied_percent number nullable
  • owner_occupied_with_mortgage_percent number nullable
  • rented_percent number 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
• bookmark_count integer nullable
• floor_plan_count integer nullable
• floor_plans array (default: [])
• images array (default: [])
• latitude number nullable
• longitude number nullable
• image string 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 Centaline estate with this type code. 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.