Skip to main content
POST
/28hse/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: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
site
enum<string>
default:28hse
Available options:
28hse,
squarefoot
lang
enum<string>
default:tc
Available options:
tc,
cn,
en
listing_type
enum<string>
default:buy
Available options:
buy,
rent
keyword
string | null
sort
enum<string>
default:relevance
Available options:
relevance,
newest,
price_low_to_high,
price_high_to_low,
gross_area_low_to_high,
gross_area_high_to_low,
saleable_area_low_to_high,
saleable_area_high_to_low,
gross_price_per_sqft_low_to_high,
gross_price_per_sqft_high_to_low,
saleable_price_per_sqft_low_to_high,
saleable_price_per_sqft_high_to_low
regions
enum<string>[] | null
Available options:
hong_kong_island,
kowloon,
new_territories,
outlying_islands,
oversea
district_groups
enum<string>[] | null
Available options:
island_south,
aberdeen_ap_lei_chau_wong_chuk_hang,
chai_wan_siu_sai_wan_shek_o,
shau_kei_wan_heng_fa_chuen,
sai_wan_ho,
taikoo,
quarry_bay,
north_point_mid_levels,
north_point_fortress_hill,
tin_hau_tai_hang,
causeway_bay_happy_valley,
wan_chai_admiralty,
mid_levels,
central_sheung_wan,
sai_ying_pun_shek_tong_tsui,
kennedy_town,
whampoa,
hung_hom,
tsim_sha_tsui,
jordan,
yau_ma_tei,
mong_kok,
prince_edward,
tai_kok_tsui_olympic_kowloon_station,
lai_king,
mei_foo,
cheung_sha_wan,
lai_chi_kok,
sham_shui_po_shek_kip_mei_nam_cheong,
yau_yat_tsuen,
ho_man_tin,
kowloon_tong,
san_po_kong_wong_tai_sin,
kai_tak,
kowloon_city,
to_kwa_wan,
diamond_hill_lok_fu,
ngau_chi_wan,
kowloon_bay,
kwun_tong_ngau_tau_kok,
yau_tong,
lam_tin,
sha_tau_kok,
tsing_yi,
kwai_chung_kwai_fong,
tsuen_wan_tai_wo_hau,
tsuen_wan_sham_tseng,
tuen_mun_castle_peak_road,
tuen_mun,
tin_shui_wai,
yuen_long_hung_shui_kiu,
sheung_shui,
fan_ling,
tai_po_tai_wo_pak_shek_kok,
sha_tin_tai_wai_fotan,
ma_on_shan,
tseung_kwan_o,
sai_kung_clear_water_bay,
cheung_chau_other_islands,
lamma_island,
peng_chau,
south_lantau_island_tai_o,
tung_chung,
discovery_bay,
ma_wan,
greater_bay_area
districts
enum<string>[] | null
Available options:
pok_fu_lam,
shouson_hill,
baguio_villa,
southern_district,
repulse_bay,
tai_tam,
stanley,
south_horizons,
parkview,
wong_chuk_hang,
ap_lei_chau,
aberdeen,
chai_wan,
shek_o,
siu_sai_wan,
shau_kei_wan,
heng_fa_chuen,
north_point,
fortress_hill,
tai_hang,
tin_hau,
jardines_lookout,
happy_valley,
happy_valley_mid_levels,
causeway_bay,
admiralty,
wan_chai,
shiu_fai_terrace,
western_mid_levels,
mid_levels_central,
the_peak,
sheung_wan,
central,
sai_ying_pun,
shek_tong_tsui,
tai_kok_tsui,
olympic,
kowloon_station,
sham_shui_po,
shek_kip_mei,
nam_cheong,
san_po_kong,
wong_tai_sin,
diamond_hill,
lok_fu,
ngau_tau_kok,
kwun_tong,
kwai_chung,
kwai_fong,
tsuen_wan,
tai_wo_hau,
yuen_long,
hung_shui_kiu,
tai_po,
tai_wo,
pak_shek_kok,
sha_tin,
tai_wai,
fotan,
tseung_kwan_o_town,
lohas_park,
hang_hau,
po_lam,
tiu_keng_leng,
sai_kung,
clear_water_bay,
cheung_chau,
other_islands,
south_lantau_island,
tai_o,
zhongshan,
zhuhai,
guangdong,
huizhou,
shenzhen,
jiangmen
primary_school_nets
enum<string>[] | null
Available options:
net_11_central_and_western,
net_12_wan_chai,
net_14_eastern,
net_16_eastern,
net_18_southern,
net_31_yau_tsim_mong,
net_32_yau_tsim_mong,
net_34_kowloon_city,
net_35_kowloon_city,
net_38_sham_shui_po,
net_40_sham_shui_po,
net_41_kowloon_city,
net_43_wong_tai_sin,
net_45_wong_tai_sin,
net_46_kwun_tong,
net_48_kwun_tong,
net_62_tsuen_wan,
net_64_kwai_tsing,
net_65_kwai_tsing,
net_66_kwai_tsing,
net_70_tuen_mun,
net_71_tuen_mun,
net_72_yuen_long,
net_73_yuen_long,
net_74_yuen_long,
net_80_north,
net_81_north,
net_83_north,
net_84_tai_po,
net_88_sha_tin,
net_89_sha_tin,
net_91_sha_tin,
net_95_sai_kung,
net_96_islands,
net_97_islands,
net_98_islands,
net_99_islands
secondary_school_nets
enum<string>[] | null
Available options:
central_and_western_hk1,
wan_chai_hk2,
eastern_hk3,
southern_hk4,
yau_tsim_mong_kl1,
sham_shui_po_kl2,
kowloon_city_kl3,
wong_tai_sin_kl4,
kwun_tong_kl5,
kwai_tsing_nt1,
tsuen_wan_nt2,
tuen_mun_nt3,
yuen_long_nt4,
north_nt5,
tai_po_nt6,
sha_tin_nt7,
sai_kung_nt8
universities
enum<string>[] | null
Available options:
hku,
cuhk,
hkust,
polyu,
cityu,
hkbu,
lingnan,
shue_yan,
eduhk,
hang_seng,
metropolitan,
chu_hai_college,
saint_francis
estate_cat_ids
string[] | null
property_types
enum<string>[] | null
Available options:
any_residential,
any_carpark,
any_industrial_or_office,
any_shop,
any_land,
any_oversea,
apartment,
home_ownership_scheme,
home_ownership_scheme_premium_unpaid,
home_ownership_scheme_free_market,
village_house,
house,
public_housing,
public_housing_premium_unpaid,
public_housing_free_market,
western_style_building,
tong_lau,
stand_alone_building,
subdivided_flat,
room_share,
short_term_rental,
residential_carpark,
commercial_carpark,
truck_carpark,
motorbike_carpark,
industrial_building,
commercial_office,
shopping_mall_shop,
upstair_shop,
street_shop,
business_takeover,
residential_land,
village_house_land,
agricultural_land,
storage_land,
warehouse,
recreation_area,
oversea_new_homes,
oversea_property
rental_shortcuts
enum<string>[] | null
Available options:
subdivided_flat,
room_share,
short_term_rental
min_price
number | null
Required range: x >= 0
max_price
number | null
Required range: x >= 0
area_basis
enum<string>
default:saleable
Available options:
saleable,
gross
min_area
number | null
Required range: x >= 0
max_area
number | null
Required range: x >= 0
room_counts
enum<string>[] | null
Available options:
studio,
one,
two,
three,
four,
five_or_more
features
enum<string>[] | null
Available options:
any_view,
mountain_view,
garden_view,
open_view,
building_view,
city_view,
sea_view,
river_view,
swimming_pool_view,
any_decoration,
simple_decoration,
elegant_decoration,
luxury_decoration,
any_appliance,
all_appliances_included,
tv,
microwave,
air_conditioner,
washing_machine,
water_heater,
fridge,
steam_oven,
induction_cooker,
cooker_hood,
oven,
dishwasher,
dryer,
wine_cellar,
any_furniture,
all_furniture_included,
partly_furnished,
tv_cabinet,
wardrobe,
table,
sofa,
bed,
chair,
coffee_table,
cabinet,
dressing_table,
bookshelf,
sole_agent,
pet_friendly,
any_carpark,
indoor_carpark,
outdoor_carpark,
any_unit_feature,
garden,
welcomes_students,
with_tenancy,
balcony,
roof_top,
terrace,
ensuite,
maid_room,
duplex,
whole_floor,
clubhouse,
near_mtr,
near_shopping_mall,
good_school_net,
powder_room,
any_office_feature,
cctv_24h,
access_24h,
dedicated_mailbox,
private_toilet,
private_air_conditioner,
office_roof_top,
office_terrace,
office_whole_floor
directions
enum<string>[] | null
Available options:
east,
south_east,
south,
south_west,
west,
north_west,
north,
north_east
listed_by
enum<string>[] | null
Available options:
landlord,
big_landlord,
agency
building_ages
enum<string>[] | null
Available options:
brand_new,
within_5_years,
within_10_years,
within_15_years,
within_20_years,
within_25_years,
within_30_years,
from_20_to_30_years,
from_30_to_40_years,
from_40_to_50_years,
above_50_years
floor_zones
enum<string>[] | null
Available options:
whole_block,
high,
middle,
low,
ground,
underground
kitchen_types
enum<string>[] | null
Available options:
separate_kitchen,
open_kitchen,
no_kitchen
open_flame_cooking
boolean | null
developers
enum<string>[] | null
Available options:
shkp,
ck_asset,
henderson,
sino,
new_world,
wheelock,
nan_fung,
chinachem,
swire,
hang_lung,
kerry,
hutchison_whampoa,
china_overseas,
k_wah,
hong_kong_housing_society,
wing_tai,
kowloon_development,
wang_on,
hkr,
billion_development,
vanke_hong_kong,
road_king,
poly,
others
has_vr_or_video
boolean | null
auction_only
boolean | null
prepaid_rent_discount_only
boolean | null

Response

Successful Response

id
string
required
@type
string
default:Hse28Property
url
string | null
buy_rent
string | null
headline
string | null
reference
string | null
price
number | null
price_per_saleable_sqft
number | null
price_per_gross_sqft
number | null
saleable_area
number | null
gross_area
number | null
rent_includes
string | null
mortgage_monthly_payment
number | null
room_count
integer | null
bathroom_count
integer | null
floor_zone
string | null
direction
string | null
kitchen_type
string | null
rental_start_at
integer | null
estate
string | null
estate_id
string | null
estate_cat_id
string | null
estate_url
string | null
estate_age
integer | null
block_and_unit
string | null
region
string | null
district_group
string | null
district
string | null
district_url
string | null
address
string | null
latitude
number | null
longitude
number | null
primary_school_net
string | null
primary_school_net_id
string | null
secondary_school_net
string | null
secondary_school_net_id
string | null
listed_by_landlord
boolean | null
view_count
integer | null
image
string | null
images
string[]
image_count
integer | null
videos
string[]
labels
string[]
categories
string[]
agency
object | null
contacts
object[]
nearby_places
object[]
created_at
integer | null
updated_at
integer | null
expires_at
integer | null