Skip to main content
POST
/midland/properties/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
transaction_type
enum<string> | null
Available options:
S,
L
text
string | null
Minimum string length: 1
property_types
enum<string>[] | null
Available options:
private,
hos_prempaid,
hos_premunpaid,
tps_prempaid,
tps_premunpaid
categories
enum<string>[] | null
Available options:
pet,
university,
northern_metro,
tenancy,
below,
90ltv,
100ssd,
with_key,
property_exchange,
above_mtr,
deluxe,
high_rental_return,
sole,
invest_immi,
talent_hot_selection,
sale,
latest,
foreclosure,
hot
sort
enum<string>
default:default
Available options:
default,
latest,
random,
price,
price_desc,
sale_perc,
sale_perc_desc,
area,
area_desc,
net_area,
net_area_desc,
ft_price,
ft_price_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
lux_district_ids
string[] | null
Minimum string length: 1
estate_ids
string[] | null
Minimum string length: 1
phase_ids
string[] | null
Minimum string length: 1
building_ids
string[] | null
Minimum string length: 1
street_ids
string[] | null
Minimum string length: 1
house_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_price
number | null
Required range: x >= 0
max_price
number | null
Required range: x >= 0
min_area
number | null
Required range: x >= 0
max_area
number | null
Required range: x >= 0
min_net_area
number | null
Required range: x >= 0
max_net_area
number | null
Required range: x >= 0
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
bedrooms
enum<string>[] | null
Available options:
0,
1,
2,
3,
4+
master_bedrooms
enum<string>[] | null
Available options:
1,
2,
3+
bathrooms
enum<string>[] | null
Available options:
1,
2,
3+
other_rooms
enum<string>[] | null
Available options:
1,
2,
3+
floor_levels
enum<string>[] | null
Available options:
H,
M,
L
flat
string | null
Minimum string length: 1
orientations
enum<string>[] | null
Available options:
N,
NE,
E,
SE,
S,
SW,
W,
NW
views
enum<string>[] | null
Available options:
MISCF00037,
MISCF00039,
MISCF00036,
MISCF00035,
MISCF00042,
MISCF00049,
MISCF00047,
MISCF00041,
MISCF00050,
MISCF00051
garden_features
enum<string>[] | null
Available options:
MISCF00015,
MISCF00072,
MISCF00070,
MISCF00016,
MISCF00014,
MISCF00013,
MISCF00067,
MISCF00071,
MISCF00024,
MISCF00025,
MISCF00077,
MISCF00044,
MISCF00052,
MISCF00001,
MISCF00005,
MISCF00004
decorations
enum<string>[] | null
Available options:
MISCF00002,
MISCF00003
facilities
enum<string>[] | null
Available options:
MISCF00009,
MISCF00007,
MISCF00011,
MISCF00010,
MISCF00048
facility_groups
enum<string>[] | null
Available options:
FM02,
FM12,
FM01,
FM07,
FM10,
FM05,
FM09,
FM13,
FM14
nearby_facilities
enum<string>[] | null
Available options:
carpark,
mall,
recreation,
mtr,
hospital,
park
media
enum<string>[] | null
Available options:
vr,
agent_video,
ai_decorate,
ai_talk
developer
string | null
Minimum string length: 1
star_ratings
enum<string>[] | null
Available options:
star4,
star5,
star6
lifestyles
enum<string>[] | null
Available options:
LS01,
LS02,
LS03,
LS04,
LS05,
LS06,
LS07,
LS08,
LS09,
LS10,
LS11,
LS12,
LS13,
LS14,
LS15,
LS16,
LS17,
LS18
department_id
string | null
Minimum string length: 1
licence_no
string | null
Minimum string length: 1
first_published
enum<string> | null
Available options:
7days
updated_after
string | null
mortgage_percent
integer | null
Required range: 1 <= x <= 100
mortgage_term
integer | null
Required range: 1 <= x <= 40

Response

Successful Response

serial_no
string
required
@type
string
default:MidlandPropertyCard
url
string | null
transaction_types
string[]
tags
string[]
is_hos
boolean | null
price
number | null
previous_price
number | null
price_hkd
number | null
price_per_area
number | null
price_per_net_area
number | null
hos_price
number | null
hos_price_hkd
number | null
hos_price_per_area
number | null
hos_price_per_net_area
number | null
rent
number | null
previous_rent
number | null
rent_hkd
number | null
rent_per_area
number | null
rent_per_net_area
number | null
monthly_payment
number | null
monthly_payment_hkd
number | null
hos_monthly_payment
number | null
hos_monthly_payment_hkd
number | null
mortgage_percent
number | null
hos_mortgage_percent
number | null
has_valuation
boolean | null
area
number | null
net_area
number | null
net_area_ratio
number | null
bedroom_count
integer | null
sitting_room_count
integer | null
floor_level
object | null
flat
string | null
orientation
object | null
image
string | null
images
string[]
has_video
boolean | null
has_agent_video
boolean | null
has_photo360
boolean | null
feature_icons
string[]
deluxe_star
string | null
is_tenancy
boolean | null
updated_at
integer | null
geo
object | null
estate
object | null
phase
object | null
building
object | null
features
object[]
facility_groups
object[]
amenities
object[]
mtr_stations
object[]
primary_school_net
string | null
location
object | null
agents
object[]