Skip to main content
POST
/centaline/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
lang
enum<string>
default:hk
Available options:
hk,
sc,
en
keyword
string | null
hma_ids
string[] | null
estates
string[] | null
order
enum<string>
default:Ascending
Available options:
Ascending,
Descending
listing_type
enum<string>
default:Sale
Available options:
Sale,
Rent
phases
string[] | null
mtr_stations
integer[] | null
primary_school_nets
string[] | null
universities
enum<string>[] | null
Available options:
香港大學,
香港中文大學,
香港科技大學,
香港理工大學,
香港城市大學,
香港浸會大學,
嶺南大學,
香港樹仁大學
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_saleable_area
integer | null
Required range: x >= 0
max_saleable_area
integer | null
Required range: x >= 0
min_price_per_sqft
integer | null
Required range: x >= 0
max_price_per_sqft
integer | null
Required range: x >= 0
min_building_age
integer | null
Required range: x >= 0
max_building_age
integer | null
Required range: x >= 0
bedroom_counts
integer[] | null
Required range: 0 <= x <= 4
estate_usages
enum<string>[] | null
Available options:
RE,
HosPaid,
HosUnpaid,
PrhPaid,
PrhUnpaid,
Other
floor_levels
enum<string>[] | null
Available options:
HighFloor,
MiddleFloor,
LowFloor
views
enum<string>[] | null
Available options:
Green,
Sea,
Mountain,
Building,
Street,
Pond,
Pool,
River,
Stadium,
Racecourse,
Bridge
characteristics
enum<string>[] | null
Available options:
Balcony,
Carpark,
Roof,
Terrace,
Garden,
Carport1,
SwimmingPool,
AdjacentUnit,
DuplexUnit
facilities
enum<string>[] | null
Available options:
SwimmingPool,
IndoorSwimmingPool,
ChildrensPool,
Gymnasium,
ChildrenPlaygroundPlayRoom,
PlaygroundPlayroom,
SaunnaRoom,
SteamBathRoom,
Jacuzzi,
TennisCourt,
SquashCourt,
BadmintonCourt,
TableTennis,
SnookerRoom,
GolfDrivingRange,
BallRoom,
ReadingStudyRoom
topics
enum<string>[] | null
Available options:
mortgage90,
mortgage1125to1500,
hasmatterport,
vrguide,
aivr,
aitalk,
hasvideo,
interior,
keeppet,
midprice,
kol,
haskey,
ssd100,
entry,
mansion,
highrentalreturnestate,
carpark,
soleagent,
above30m,
salemarkdown,
rentmarkdown,
house,
highrent,
latest,
todayspecial,
selection,
discountpost,
mortgagee
nearby_facilities
enum<string>[] | null
Available options:
NearMtr,
NearArcade,
NearCarpark,
NearEVCharge,
NearLargePark,
NearUniversity
max_mtr_walk_time
enum<string> | null
Available options:
120,
300,
600
developers
string[] | null
branches
string[] | null
hos_only
boolean | null
sort
enum<string>
default:Ranking
Available options:
Ranking,
PublishDate,
Price,
NSize,
Size,
NUnitPrice,
UnitPrice,
BuildingAge

Response

Successful Response

id
string
required
@type
string
default:CentalineProperty
url
string | null
listing_type
string | null
estate_group_name
string | null
estate_name
string | null
building_name
string | null
address
string | null
district
string | null
floor_level
string | null
unit
string | null
price
number | null
premium_paid_price
number | null
premium_unpaid_price
number | null
original_price
number | null
price_change_percent
number | null
rent
number | null
original_rent
number | null
rent_change_percent
number | null
price_text
string | null
rent_text
string | null
gross_area
number | null
saleable_area
number | null
efficiency_ratio
number | null
gross_price_per_sqft
number | null
saleable_price_per_sqft
number | null
gross_rent_per_sqft
number | null
saleable_rent_per_sqft
number | null
rental_yield
number | null
monthly_mortgage_payment
number | null
bedroom_count
integer | null
ensuite_count
integer | null
building_age
integer | null
direction
string | null
building_type
string | null
unit_type
string | null
estate_structure
string | null
is_hos
boolean | null
is_public_housing
boolean | null
is_house
boolean | null
is_sole_agent
boolean | null
has_key
boolean | null
is_foreclosure
boolean | null
is_pet_friendly
boolean | null
is_hot_listing
boolean | null
is_director_pick
boolean | null
with_lease
boolean | null
is_management_fee_included
boolean | null
is_government_rates_included
boolean | null
is_government_rent_included
boolean | null
estate_group_code
string | null
estate_code
string | null
building_code
string | null
type_code
string | null
labels
string[]
nearby_places
object[]
scope
object | null
media
object | null
latitude
number | null
longitude
number | null
image
string | null
aerial_view_url
string | null
published_at
integer | null
updated_at
integer | null