/centaline/valuations

POST /api/centaline/valuations

Price: 1 credit

CentaEstimate (中原估算) weekly AI valuation of a single Hong Kong private residential unit, identified by its property reference number (PRN). Returns the estimated price with its month-on-month change, the lower and upper bounds of the estimate range, saleable area and estimated price per saleable sq ft, the valuation and previous valuation dates, the building group the model clustered the unit into, and the surrounding estate profile (developer, management company, phase/building/unit counts, pet policy, facilities, nearby MTR, malls, parks and carparks, school nets and coordinates).

How to use it

Get the CentaEstimate (中原估算) valuation of one Hong Kong flat by its property reference number, e.g. unit='A2678882'. Estimates are refreshed weekly and cover private residential units only — subsidised and public housing, carparks and commercial units have no estimate. Money is HKD, saleable_area is square feet, valuation_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 descriptions. (default: "hk"; one of: "hk", "sc", "en")
• unit string required — Property reference number (PRN) of the residential unit to value. (examples: "A2678882")

Response

• @type string (default: "CentalineValuation")
• id string required
• unit_code string nullable
• building_type_code string nullable
• estate_name string nullable
• unit_address string nullable
• location string nullable
• estate_url string nullable
• valuation_at integer nullable
• previous_valuation_at integer nullable
• price number nullable
• price_change_percent number nullable
• min_price number nullable
• max_price number nullable
• min_price_change_percent number nullable
• max_price_change_percent number nullable
• saleable_area number nullable
• saleable_price_per_sqft number nullable
• building_group_id string nullable
• building_group_name string nullable
• developer string nullable
• management_company string nullable
• phase_count integer nullable
• building_count integer nullable
• unit_count integer nullable
• is_pet_friendly boolean nullable
• facilities array (default: [])
• category_labels array (default: [])
• shopping_mall string nullable
• nearby_places array (default: [])
  • @type string (default: "CentalineNearbyPlace")
  • name string required
  • kind string required
  • walk_minutes integer 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
• latitude number nullable
• longitude number nullable
• image 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 — No CentaEstimate valuation exists for this property 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.