/centaline/estates/transactions

POST /api/centaline/estates/transactions

Price: 5 credits

Full recorded sale history of a single Hong Kong building, unit by unit and floor by floor. Returns every logged deal with its floor and flat, price, gross and saleable areas with per-sq-ft rates, gain against the previous sale, record source, instrument and registration dates and media availability.

How to use it

Per-unit sale history of one Centaline (中原地產) Hong Kong building, going back to the building's first transactions. Pass a building type code (starts with '1-'), e.g. estate='1-TNNLTHSXHI', plus count. Get building type codes from centaline/properties (field type_code) or centaline/estates/search. Lettings are not in this ledger — use centaline/transactions/search with deal_type='Rent' for those. Areas are square feet, money is HKD, instrument_at/registered_at are 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")
• estate string required — Centaline building type code (starts with '1-'), or the estate page URL of that building. (examples: "1-TNNLTHSXHI")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "CentalineBuildingTransaction")
• id string required
• floor integer nullable
• floor_label string nullable
• unit string nullable
• unit_group string nullable
• feature string nullable
• price number nullable
• gross_area number nullable
• saleable_area number nullable
• gross_price_per_sqft number nullable
• saleable_price_per_sqft number nullable
• gain_percent number nullable
• source string nullable
• instrument_at integer nullable
• registered_at integer nullable
• unit_code string nullable
• media object nullable
  • @type string (default: "CentalineMediaFlags")
  • has_media boolean nullable
  • has_photos boolean nullable
  • has_street_view boolean nullable
  • has_sphere boolean nullable
  • has_video boolean nullable
  • has_virtual_tour boolean nullable
  • has_floor_plan boolean nullable
  • has_planning_diagram boolean nullable
  • has_unit_plan boolean nullable
  • has_aerial_view boolean nullable
  • has_building_3d_model boolean 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 building 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.