Skip to main content
POST
/midland/estates/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: 1 <= x <= 10000
timeout
integer
default:300
Required range: 20 <= x <= 1500
lang
enum<string>
default:zh-hk
Available options:
zh-hk,
zh-cn,
en
unit
enum<string>
default:feet
Available options:
feet,
meter
currency
enum<string>
default:HKD
Available options:
HKD,
CNY
min_building_age
integer | null
Required range: 0 <= x <= 999
max_building_age
integer | null
Required range: 0 <= x <= 999
text
string | null
Minimum string length: 1
estate_name
string | null
Minimum string length: 1
exclude_estate_name
string | null
Minimum string length: 1
estate_ids
string[] | null
Minimum string length: 1
exclude_estate_ids
string[] | null
Minimum string length: 1
include_phases
boolean | null
property_types
enum<string>[] | null
Available options:
private,
hos,
tps
categories
enum<string>[] | null
Available options:
pet,
university,
northern_metro,
above_mtr
developer
string | null
Minimum string length: 1
sort
enum<string>
default:default
Available options:
default,
tx_count_desc,
tx_amount_desc,
bldg_age,
bldg_age_desc,
net_ft_price,
net_ft_price_desc
region_id
string | null
Minimum string length: 1
subregion_ids
string[] | null
Minimum string length: 1
district_ids
string[] | null
Minimum string length: 1
sm_district_ids
string[] | null
Minimum string length: 1
combined_district_ids
string[] | null
Minimum string length: 1
int_district_ids
string[] | null
Minimum string length: 1
int_sm_district_ids
string[] | null
Minimum string length: 1
street_ids
string[] | null
Minimum string length: 1
mtr_ids
string[] | null
Minimum string length: 1
walking_duration
integer | null
Required range: x >= 1
school_net
string | null
Minimum string length: 1
university_ids
enum<string>[] | null
Available options:
U01,
U02,
U03,
U04,
U05,
U06,
U07,
U08,
U09,
U10,
U11,
U12,
U13
min_net_ft_price
number | null
Required range: x >= 0
max_net_ft_price
number | null
Required range: x >= 0
min_ft_price
number | null
Required range: x >= 0
max_ft_price
number | null
Required range: x >= 0
facility_groups
enum<string>[] | null
Available options:
FM02,
FM12,
FM01,
FM07,
FM10,
FM05,
FM09,
FM13,
FM14
garden_features
enum<string>[] | null
Available options:
MISCF00067
nearby_facilities
enum<string>[] | null
Available options:
carpark,
mall,
recreation,
mtr,
hospital,
park

Response

Successful Response

id
string
required
@type
string
default:MidlandEstateCard
name
string | null
url
string | null
is_hos
boolean | null
developer
string | null
first_op_at
integer | null
image
string | null
sell_count
integer | null
rent_count
integer | null
total_unit_count
integer | null
total_block_count
integer | null
primary_school_net
string | null
is_index_component
boolean | null
index_net_ft_price
number | null
index_net_ft_price_change_percent
number | null
parent_estate_id
string | null
parent_estate_name
string | null
market_stat
object | null
monthly_prices
object[]
yearly_transaction_count
integer | null
yearly_transaction_amount
number | null
yearly_net_ft_price
number | null
yearly_net_ft_price_change_percent
number | null
geo
object | null
location
object | null
amenities
object[]
sale_listings_url
string | null
rent_listings_url
string | null
transaction_history_url
string | null