# /midland/properties

`POST /api/midland/properties`

Price: 20 credits

Get one Midland Realty Hong Kong residential listing by its reference number (or listing URL). Returns the full listing page: asking price or rent with previous price and per-area figures, HOS pricing, gross and saleable area with the efficiency ratio, room breakdown (bedrooms, master bedrooms, guest and sitting rooms, bathrooms, covered carparks), floor band, flat and orientation, typed photos, agent video, static maps, unit features, estate facilities, walkable amenities and MTR stations, the eight-level geography, the neighbourhood profile with air quality and market stats, the estate profile (developer, vendor, occupation dates, block and storey breakdown, school nets, listing counts and price ranges, site plans, videos, other phases), the building, the monthly price and rent index for the phase, recent nearby sale and rental deals, nearby branches, the listing agents with EAA licence numbers, and mortgage assumptions.

## How to use it

Get a single Midland Realty Hong Kong listing by serial_no (e.g. 'M351962478'); a full listing URL is also accepted. Set lang (zh-hk / zh-cn / en), unit (feet / meter) and currency (HKD / CNY) to control the output locale — all names, areas and prices are converted. Sale listings populate price / price_per_net_area, rentals populate rent / rent_per_net_area. Use midland/properties/search to find serial numbers, midland/estates for the estate profile and midland/transactions/search for past deals in the same estate.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `lang` (string) — Output language. Districts, estates, buildings and feature names are all translated. (default: "zh-hk"; one of: "zh-hk", "zh-cn", "en")
- `unit` (string) — Area unit used for areas and per-area prices. (default: "feet"; one of: "feet", "meter")
- `currency` (string) — Currency used for prices, rents and monthly payments. (default: "HKD"; one of: "HKD", "CNY")
- `serial_no` (string, required) — Midland listing reference, or the full listing URL. (examples: "M351962478")

## Response

### 200 — Successful Response

- `@type` (string) (default: "MidlandProperty")
- `serial_no` (string, required)
- `url` (string, nullable)
- `url_zh_cn` (string, nullable)
- `url_en` (string, nullable)
- `transaction_types` (array) (default: [])
- `tags` (array) (default: [])
- `sale_tags` (array) (default: [])
- `rent_tags` (array) (default: [])
- `unit_type` (string, nullable)
- `is_hos` (boolean, nullable)
- `is_sole_agent` (boolean, nullable)
- `is_tenancy` (boolean, nullable)
- `is_hot_new` (boolean, nullable)
- `has_valuation` (boolean, nullable)
- `is_deluxe_sale` (boolean, nullable)
- `is_deluxe_rent` (boolean, nullable)
- `deluxe_star` (string, nullable)
- `deluxe_star_rate` (integer, nullable)
- `lifestyle_themes` (array) (default: [])
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `price` (number, nullable)
- `previous_price` (number, nullable)
- `price_hkd` (number, nullable)
- `price_per_area` (number, nullable)
- `price_per_net_area` (number, nullable)
- `hos_price` (number, nullable)
- `previous_hos_price` (number, nullable)
- `hos_price_hkd` (number, nullable)
- `hos_price_per_area` (number, nullable)
- `hos_price_per_net_area` (number, nullable)
- `rent` (number, nullable)
- `previous_rent` (number, nullable)
- `rent_hkd` (number, nullable)
- `rent_per_area` (number, nullable)
- `rent_per_net_area` (number, nullable)
- `monthly_payment` (number, nullable)
- `monthly_payment_hkd` (number, nullable)
- `hos_monthly_payment` (number, nullable)
- `hos_monthly_payment_hkd` (number, nullable)
- `mortgage_percent` (number, nullable)
- `hos_mortgage_percent` (number, nullable)
- `area` (number, nullable)
- `net_area` (number, nullable)
- `net_area_ratio` (number, nullable)
- `bedroom_count` (integer, nullable)
- `master_bedroom_count` (integer, nullable)
- `guest_room_count` (integer, nullable)
- `sitting_room_count` (integer, nullable)
- `bathroom_count` (integer, nullable)
- `other_room_count` (integer, nullable)
- `covered_carpark_count` (integer, nullable)
- `floor_level` (object, nullable)
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `flat` (string, nullable)
- `orientation` (object, nullable)
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `image` (string, nullable)
- `photos` (array) (default: [])
  - `@type` (string) (default: "MidlandPropertyPhoto")
  - `url` (string, nullable)
  - `name` (string, nullable)
  - `type` (string, nullable)
  - `width` (integer, nullable)
  - `height` (integer, nullable)
- `videos` (array) (default: [])
  - `@type` (string) (default: "MidlandPropertyVideo")
  - `id` (string, nullable)
  - `url` (string, nullable)
  - `stream_url` (string, nullable)
  - `thumbnail` (string, nullable)
- `virtual_tours` (array) (default: [])
  - `@type` (string) (default: "MidlandVirtualTour")
  - `url` (string, nullable)
  - `thumbnail` (string, nullable)
  - `is_deluxe` (boolean, nullable)
- `floor_plans` (array) (default: [])
  - `@type` (string) (default: "MidlandFloorPlan")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `url` (string, nullable)
  - `source` (string, nullable)
  - `phase_id` (string, nullable)
  - `phase_name` (string, nullable)
  - `building_id` (string, nullable)
  - `building_name` (string, nullable)
  - `floor_from` (string, nullable)
  - `floor_to` (string, nullable)
  - `floor_text` (string, nullable)
- `static_maps` (array) (default: [])
- `features` (array) (default: [])
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `facility_groups` (array) (default: [])
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `amenities` (array) (default: [])
  - `@type` (string) (default: "MidlandAmenity")
  - `type` (string, nullable)
  - `name` (string, nullable)
  - `walking_minutes` (integer, nullable)
- `mtr_stations` (array) (default: [])
  - `@type` (string) (default: "MidlandMtrStation")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `exit` (string, nullable)
  - `walking_seconds` (integer, nullable)
- `geo` (object, nullable)
  - `@type` (string) (default: "MidlandGeo")
  - `region` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `subregion` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `sm_district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `combined_district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `int_district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `int_sm_district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `lux_district` (object, nullable)
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
- `neighbourhood` (object, nullable)
  - `@type` (string) (default: "MidlandNeighbourhood")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `url` (string, nullable)
  - `unit_rank_text` (string, nullable)
  - `total_unit_count` (integer, nullable)
  - `sell_count` (integer, nullable)
  - `rent_count` (integer, nullable)
  - `air_quality_level` (string, nullable)
  - `market_stat` (object, nullable)
    - `@type` (string) (default: "MidlandMarketStat")
    - `net_ft_price` (number, nullable)
    - `previous_net_ft_price` (number, nullable)
    - `net_ft_price_change_percent` (number, nullable)
    - `ft_price` (number, nullable)
    - `previous_ft_price` (number, nullable)
    - `ft_price_change_percent` (number, nullable)
    - `net_ft_rent` (number, nullable)
    - `transaction_count` (integer, nullable)
    - `transaction_amount` (number, nullable)
- `estate` (object, nullable)
  - `@type` (string) (default: "MidlandPropertyEstate")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `phase_id` (string, nullable)
  - `phase_name` (string, nullable)
  - `address` (string, nullable)
  - `developer` (string, nullable)
  - `vendor` (string, nullable)
  - `management_company` (string, nullable)
  - `op_date_text` (string, nullable)
  - `first_op_at` (integer, nullable)
  - `last_op_at` (integer, nullable)
  - `block_count_text` (string, nullable)
  - `storey_text` (string, nullable)
  - `total_flats_text` (string, nullable)
  - `school_net` (object, nullable)
    - `@type` (string) (default: "MidlandSchoolNet")
    - `kindergarten_id` (string, nullable)
    - `kindergarten_name` (string, nullable)
    - `primary_id` (string, nullable)
    - `primary_name` (string, nullable)
    - `secondary_id` (string, nullable)
    - `secondary_name` (string, nullable)
  - `sell_count` (integer, nullable)
  - `rent_count` (integer, nullable)
  - `min_price` (number, nullable)
  - `max_price` (number, nullable)
  - `min_rent` (number, nullable)
  - `max_rent` (number, nullable)
  - `avg_net_ft_price` (number, nullable)
  - `avg_net_ft_rent` (number, nullable)
  - `net_ft_rent` (number, nullable)
  - `site_plans` (array) (default: [])
  - `videos` (array) (default: [])
    - `@type` (string) (default: "MidlandPropertyVideo")
    - `id` (string, nullable)
    - `url` (string, nullable)
    - `stream_url` (string, nullable)
    - `thumbnail` (string, nullable)
  - `other_phases` (array) (default: [])
    - `@type` (string) (default: "MidlandRef")
    - `id` (string, nullable)
    - `name` (string, nullable)
  - `url` (string, nullable)
- `phase` (object, nullable)
  - `@type` (string) (default: "MidlandRef")
  - `id` (string, nullable)
  - `name` (string, nullable)
- `building` (object, nullable)
  - `@type` (string) (default: "MidlandBuilding")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `address` (string, nullable)
  - `first_op_at` (integer, nullable)
  - `floor_count` (integer, nullable)
  - `building_type` (string, nullable)
  - `latitude` (number, nullable)
  - `longitude` (number, nullable)
  - `streetview_latitude` (number, nullable)
  - `streetview_longitude` (number, nullable)
  - `streetview_angle` (integer, nullable)
- `market_stat` (object, nullable)
  - `@type` (string) (default: "MidlandMarketStat")
  - `net_ft_price` (number, nullable)
  - `previous_net_ft_price` (number, nullable)
  - `net_ft_price_change_percent` (number, nullable)
  - `ft_price` (number, nullable)
  - `previous_ft_price` (number, nullable)
  - `ft_price_change_percent` (number, nullable)
  - `net_ft_rent` (number, nullable)
  - `transaction_count` (integer, nullable)
  - `transaction_amount` (number, nullable)
- `price_index` (array) (default: [])
  - `@type` (string) (default: "MidlandPriceIndexPoint")
  - `date_at` (integer, nullable)
  - `transaction_count` (integer, nullable)
  - `avg_ft_price` (number, nullable)
  - `avg_net_ft_price` (number, nullable)
  - `avg_ft_rent` (number, nullable)
  - `avg_net_ft_rent` (number, nullable)
- `nearby_sale_transactions` (array) (default: [])
  - `@type` (string) (default: "MidlandNearbyTransaction")
  - `price` (number, nullable)
  - `net_area` (number, nullable)
  - `bedroom_count` (integer, nullable)
  - `estate_name` (string, nullable)
  - `phase_name` (string, nullable)
  - `building_name` (string, nullable)
  - `floor` (string, nullable)
  - `floor_name` (string, nullable)
  - `flat` (string, nullable)
  - `gain_percent` (number, nullable)
  - `holding_period_years` (number, nullable)
- `nearby_rent_transactions` (array) (default: [])
  - `@type` (string) (default: "MidlandNearbyTransaction")
  - `price` (number, nullable)
  - `net_area` (number, nullable)
  - `bedroom_count` (integer, nullable)
  - `estate_name` (string, nullable)
  - `phase_name` (string, nullable)
  - `building_name` (string, nullable)
  - `floor` (string, nullable)
  - `floor_name` (string, nullable)
  - `flat` (string, nullable)
  - `gain_percent` (number, nullable)
  - `holding_period_years` (number, nullable)
- `branches` (array) (default: [])
  - `@type` (string) (default: "MidlandBranchContact")
  - `name` (string, nullable)
  - `phone` (string, nullable)
- `agents` (array) (default: [])
  - `@type` (string) (default: "MidlandAgent")
  - `licence_no` (string, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `nickname` (string, nullable)
  - `job_title` (string, nullable)
  - `image` (string, nullable)
  - `phone` (string, nullable)
  - `mobile_phone` (string, nullable)
  - `china_mobile_phone` (string, nullable)
  - `wechat_id` (string, nullable)
  - `wechat_qr` (string, nullable)
  - `department_id` (string, nullable)
  - `url` (string, nullable)
  - `is_owner` (boolean, nullable)
- `mortgage` (object, nullable)
  - `@type` (string) (default: "MidlandMortgage")
  - `loan_percent` (number, nullable)
  - `loan_years` (integer, nullable)
  - `interest_rate_percent` (number, nullable)
- `comparable_room_count` (string, nullable)
- `comparable_listing_net_ft_price` (number, nullable)
- `comparable_listing_price_change_percent` (number, nullable)
- `comparable_transaction_net_ft_price` (number, nullable)
- `comparable_listing_net_ft_rent` (number, nullable)
- `comparable_transaction_net_ft_rent` (number, nullable)
- `estate_url` (string, nullable)
- `transactions_url` (string, nullable)
- `news_url` (string, nullable)
- `first_published_at` (integer, nullable)
- `posted_at` (integer, nullable)
- `updated_at` (integer, nullable)
- `eaa_effective_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 reference number (it may have been withdrawn).

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.