Skip to main content
POST
/centaline/commercial/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
districts
string[] | null
usage
enum<string>
default:Any
Available options:
Any,
Office,
Industrial,
Retail,
Carpark
listing_type
enum<string>
default:B
Available options:
B,
S,
R
floor_types
enum<string>[] | null
Available options:
H,
M,
L,
G,
Whole Floor
views
enum<string>[] | null
Available options:
City View,
Sea View,
Open View,
Mountain View,
Garden View,
Race Course View,
River View,
Fountain View
themes
enum<string>[] | null
Available options:
Video,
360View,
HotListing,
WithKey,
SoleAgent,
VR,
OpenDay
decorations
enum<string>[] | null
Available options:
Fitted,
Ceiling,
Warehouse,
Carpet,
Water supply and drainage system,
Split-Type A/C,
Light Box,
Raised Floor,
Painted Wall,
Business Centre,
Wallpaper,
Plastic Floor
investment_types
enum<string>[] | null
Available options:
Whole Block,
CommPodium,
Hotel
shop_types
enum<string>[] | null
Available options:
Catering,
Snack Food/Bread,
Market/Household Goods /Convenient Store,
Property/Bank/Finance/Investment/Insurance,
Beauty/Fitness/Salon,
Medical,
Fashion,
Toy/Gift,
Pharmacy,
Foot Masage,
Wholesale,
Pets,
Electrica Appliances/IT/Audio-Visua Equipment,
Accessories,
Educational and Tutorial Classes,
Construction and Decoration,
Jewellery/Watches,
Leather/Shoes,
Religion,
Professional Services,
Art/Design,
Sports,
Trading - Import/Export,
Furniture/Lighting,
Investor,
Entertainment,
Business Centre,
Tourism,
Manufacturing/Engineering,
Studio/Photographic Studio,
Broadband Network,
Textile/Garment,
Home for the aged,
Hotel/Service Apartment,
Others
campaigns
enum<string>[] | null
Available options:
CIES
building_id
string | null
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_rent
integer | null
Required range: x >= 0
max_rent
integer | null
Required range: x >= 0
min_area
integer | null
Required range: x >= 0
max_area
integer | null
Required range: x >= 0

Response

Successful Response

id
string
required
@type
string
default:CentalineCommercialProperty
property_number
string | null
building_id
string | null
building_name
string | null
building_name_en
string | null
address
string | null
listing_type
string | null
usage
string | null
usage_label
string | null
floor
string | null
price
number | null
price_text
string | null
price_per_sqft
number | null
rent
number | null
rent_text
string | null
rent_per_sqft
number | null
gross_area
number | null
area_text
string | null
is_area_approximate
boolean | null
air_conditioning
string | null
mtr_station
string | null
mtr_walk_time
string | null
occupation_year
string | null
occupied_at
integer | null
is_sole_agent
boolean | null
has_key
boolean | null
is_hot_listing
boolean | null
is_open_day
boolean | null
is_director_pick
boolean | null
is_carpark
boolean | null
carpark_type
string | null
carpark_type_label
string | null
is_investment
boolean | null
with_lease
boolean | null
is_rental_inclusive
boolean | null
has_video
boolean | null
has_360_view
boolean | null
has_virtual_tour
boolean | null
features
string[]
labels
string[]
area
object | null
agents
object[]
latitude
number | null
longitude
number | null
image
string | null
published_at
integer | null