Skip to main content
POST
/28hse/transactions/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
deal_type
enum<string>
default:any
Available options:
any,
sale,
rent
regions
enum<string>[] | null
Available options:
hong_kong_island,
kowloon,
new_territories,
outlying_islands
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
estate_category
enum<string> | null
Available options:
private_estate,
public_and_subsidised_housing
building_ages
enum<string>[] | null
Available options:
brand_new,
within_5_years,
within_10_years,
within_15_years,
within_20_years,
within_30_years,
from_30_to_50_years,
above_50_years
keyword
string | null

Response

Successful Response

id
string
required
@type
string
default:Hse28Transaction
url
string | null
buy_rent
string | null
transaction_at
integer | null
updated_at
integer | null
price
number | null
price_per_saleable_sqft
number | null
price_per_gross_sqft
number | null
saleable_area
number | null
gross_area
number | null
room_count
integer | null
carpark_count
integer | null
has_carpark
boolean | null
direction
string | null
features
string[]
features_en
string[]
estate
string | null
estate_id
string | null
estate_cat_id
string | null
phase
string | null
phase_en
string | null
phase_no
string | null
block
string | null
block_en
string | null
block_no
string | null
floor_zone
string | null
floor
string | null
unit
string | null
unit_id
string | null
district
string | null
district_id
string | null
address
string | null
source
string | null
transaction_type
string | null
land_registry_ref
string | null
agency_ref
string | null
previous_price
number | null
previous_transaction_at
integer | null
profit_loss_percent
number | null