Skip to main content
POST
/centaline/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: 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
primary_school_nets
string[] | null
estate_usages
enum<string>[] | null
Available options:
RE,
HOS,
PRH,
Other
facilities
enum<string>[] | null
Available options:
SwimmingPool,
IndoorSwimmingPool,
ChildrensPool,
Gymnasium,
ChildrenPlaygroundPlayRoom,
PlaygroundPlayroom,
SaunnaRoom,
SteamBathRoom,
Jacuzzi,
TennisCourt,
SquashCourt,
BadmintonCourt,
TableTennis,
SnookerRoom,
GolfDrivingRange,
BallRoom,
ReadingStudyRoom
developers
string[] | null
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
sort
enum<string>
default:Ranking
Available options:
Ranking,
NUnitPrice,
BuildingAge

Response

Successful Response

id
string
required
@type
string
default:CentalineEstateSummary
url
string | null
name
string | null
phase_name
string | null
address
string | null
estate_structure
string | null
developer
string | null
management_company
string | null
phase_count
integer | null
building_count
integer | null
unit_count
integer | null
min_building_age
integer | null
max_building_age
integer | null
first_occupation_at
integer | null
last_occupation_at
integer | null
sale
object | null
rent
object | null
school_net
object | null
scope
object | null
media
object | null
latitude
number | null
longitude
number | null
image
string | null
updated_at
integer | null