# /28hse/properties

`POST /api/28hse/properties`

Price: 10 credits

Get one Hong Kong property listing from 28Hse or Squarefoot by its numeric id. Returns the headline and full advertisement text, the internal reference, sale price or monthly rent in HKD, what the rent covers, the indicative monthly mortgage repayment, saleable and gross floor areas in square feet with the matching price per square foot, bedroom and bathroom counts, floor band, living-room orientation, kitchen type, tenancy start date, the estate with its id, age, block and unit designation, region, district, street address and coordinates, the primary and secondary school nets, whether the advertiser is the owner or an agency, the view counter, the full photo gallery including floor plans, any attached video, the feature and category labels, the listing agency with its branch address and listing counts, the named contacts with their Estate Agents Authority licence numbers, walking distances to nearby transport, malls, restaurants, schools, banks and clinics, and the publication, update and expiry timestamps.

## How to use it

Get one 28Hse / Squarefoot Hong Kong listing, e.g. property='3947798'. The listing page URL is accepted too. Ids are not shared between the two portals — set site to the one the id came from (28hse or squarefoot); 28hse/properties/search returns ids for the selected site. lang switches text between traditional Chinese, simplified Chinese and English. Areas are square feet, money is HKD. Listings expire about a month after publication — expires_at carries the exact moment.

## 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")
- `property` (string, required) — Listing id, or the full listing page URL. (examples: "3947798")

## Response

### 200 — Successful Response

- `@type` (string) (default: "Hse28Property")
- `id` (string, required)
- `url` (string, nullable)
- `buy_rent` (string, nullable)
- `headline` (string, nullable)
- `description` (string, nullable)
- `reference` (string, nullable)
- `price` (number, nullable)
- `price_per_saleable_sqft` (number, nullable)
- `price_per_gross_sqft` (number, nullable)
- `saleable_area` (number, nullable)
- `gross_area` (number, nullable)
- `rent_includes` (string, nullable)
- `mortgage_monthly_payment` (number, nullable)
- `room_count` (integer, nullable)
- `bathroom_count` (integer, nullable)
- `floor_zone` (string, nullable)
- `direction` (string, nullable)
- `kitchen_type` (string, nullable)
- `rental_start_at` (integer, nullable)
- `estate` (string, nullable)
- `estate_id` (string, nullable)
- `estate_cat_id` (string, nullable)
- `estate_url` (string, nullable)
- `estate_age` (integer, nullable)
- `block_and_unit` (string, nullable)
- `region` (string, nullable)
- `district_group` (string, nullable)
- `district` (string, nullable)
- `district_url` (string, nullable)
- `address` (string, nullable)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `primary_school_net` (string, nullable)
- `primary_school_net_id` (string, nullable)
- `secondary_school_net` (string, nullable)
- `secondary_school_net_id` (string, nullable)
- `listed_by_landlord` (boolean, nullable)
- `view_count` (integer, nullable)
- `image` (string, nullable)
- `images` (array) (default: [])
- `image_count` (integer, nullable)
- `videos` (array) (default: [])
- `labels` (array) (default: [])
- `categories` (array) (default: [])
- `agency` (object, nullable)
  - `@type` (string) (default: "Hse28Agency")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `url` (string, nullable)
  - `image` (string, nullable)
  - `address` (string, nullable)
  - `sale_listing_count` (integer, nullable)
  - `rent_listing_count` (integer, nullable)
- `contacts` (array) (default: [])
  - `@type` (string) (default: "Hse28Contact")
  - `name` (string, nullable)
  - `licence` (string, nullable)
  - `image` (string, nullable)
- `nearby_places` (array) (default: [])
  - `@type` (string) (default: "Hse28NearbyPlace")
  - `name` (string, required)
  - `kind` (string, required)
  - `walk_minutes` (integer, nullable)
- `created_at` (integer, nullable)
- `updated_at` (integer, nullable)
- `expires_at` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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 listing with this id on the selected site (it may have expired).

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.