/centaline/indices

POST /api/centaline/indices

Price: 5 credits

Latest readings of the Centa-City Leading Index (CCL) family — the benchmark weekly Hong Kong secondary residential price index. Returns the all-territory index plus the Hong Kong Island, Kowloon, New Territories East and New Territories West sub-indices and the large-unit, small/medium-unit and mass-market-estate cuts, each with its week-on-week and month-on-month percentage change, survey and publication dates and the covered week. Optionally returns the full weekly history back to 1994.

How to use it

Centa-City Leading Index (中原城市領先指數, CCL) — Hong Kong's headline weekly secondary-market housing price index from Centaline. Returns the overall index plus regional and unit-size sub-indices with week-on-week and month-on-month changes. Set with_history=true to also get the full weekly series (dates and index values) since 1994.

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")
• with_history boolean — Include the full weekly history of the all-Hong-Kong index back to 1994. (default: false)

Response

• @type string (default: "CentalineIndex")
• id string required
• name string required
• value number nullable
• week_change_percent number nullable
• month_change_percent number nullable
• survey_at integer nullable
• published_at integer nullable
• period_start_at integer nullable
• period_end_at integer nullable
• chart_url string nullable
• history array (default: [])
  • @type string (default: "CentalineIndexPoint")
  • recorded_at integer required
  • value number required

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.