/28hse/estates/units

POST /api/28hse/estates/units

Price: 10 credits

Get the full transaction history of a single flat in a Hong Kong estate. Returns the unit's address, phase and block, its gross and saleable areas in square feet, the bedroom count, the number of recorded deals and the unit floor plan, plus every recorded transaction with its date, price in HKD, price per gross and per saleable square foot, whether the record comes from the Land Registry or from market reporting, the profit or loss percentage against the previous sale and the date of that previous sale — a chain that reaches back to the early 2000s for older estates. The flat is addressed by the estate, phase, block and unit numbers together, exactly as they appear on a transaction row; a set that does not describe one flat returns 412.

How to use it

Get one flat's price history in a 28Hse / Squarefoot estate, e.g. estate='1140', unit='173829', phase_no='2', block_no='25'. Take all four values from one row of 28hse/estates/transactions or 28hse/transactions/search (fields estate_id, unit_id, phase_no, block_no) — a flat is addressed by the whole set, and a set whose parts come from different flats returns 412. Money is HKD, areas are square feet.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• site string — Which Hong Kong portal to read. Both run on the same platform but hold different listing inventories: 28hse is the larger Chinese-first marketplace, squarefoot is the English-first one. (default: "28hse"; one of: "28hse", "squarefoot")
• lang string — Language of names, addresses and descriptions. It also changes which listings exist: some categories are only published in the Chinese editions. (default: "tc"; one of: "tc", "cn", "en")
• estate string required — Estate id, the '{name}-{id}' slug, or the estate page URL. (examples: "1140")
• unit string required — Unit id, as published on the estate history rows. (examples: "173829")
• phase_no string — Phase sequence number of the unit. (default: "0"; examples: "2")
• block_no string — Block sequence number of the unit. (default: "0"; examples: "25")

Response

• @type string (default: "Hse28EstateUnit")
• estate_id string required
• unit_id string required
• url string nullable
• estate_url string nullable
• name string nullable
• street string nullable
• phase string nullable
• block string nullable
• gross_area number nullable
• saleable_area number nullable
• room_count integer nullable
• transaction_count integer nullable
• floor_plan string nullable
• transactions array (default: [])
  • @type string (default: "Hse28UnitTransaction")
  • transaction_at integer nullable
  • price number nullable
  • price_per_gross_sqft number nullable
  • price_per_saleable_sqft number nullable
  • transaction_type string nullable
  • profit_loss_percent number nullable
  • previous_transaction_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 flat with this estate, phase, block and unit combination. 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.