/28hse/estates/transactions

POST /api/28hse/estates/transactions

Price: 5 credits

List the recorded sale or letting transactions of one Hong Kong estate (屋苑). Each row returns the deal id and page URL where the source publishes one, the estate name, the address down to the block, floor and flat, the transaction date, whether the record comes from the Land Registry or from market reporting, the bedroom count, the saleable area in square feet, the price in HKD with the price per saleable square foot, and — where the unit changed hands before — the profit or loss percentage against the previous sale. Rows for units with a recorded history also carry the phase, block and unit numbers that 28hse/estates/units expands into that unit's full price chain.

How to use it

List transactions of one 28Hse / Squarefoot estate, e.g. estate='1140' with count. deal_type picks sales or lettings; phase_no narrows to one phase. Rows that carry unit_id, phase_no and block_no can be passed to 28hse/estates/units for that unit's full price history with profit and loss. 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")
• count integer required — Number of transactions to return. (min: 1)
• deal_type string — Recorded sales or recorded lettings. (default: "sale"; one of: "sale", "rent")
• phase_no string nullable — Restrict to one phase of the estate, by its sequence number. (examples: "1")

Response

• @type string (default: "Hse28EstateTransaction")
• id string nullable
• url string nullable
• estate string nullable
• address string nullable
• transaction_at integer nullable
• transaction_type string nullable
• room_count integer nullable
• saleable_area number nullable
• price number nullable
• price_per_sqft number nullable
• profit_loss_percent number nullable
• unit_id string nullable
• phase_no string nullable
• block_no 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 — 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.