Skip to main content
POST
/centaline/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
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
deal_type
enum<string>
default:Sale
Available options:
Sale,
Rent
period
enum<string>
default:Day30
Available options:
Day30,
Day90,
Day180,
Day365,
Day1095
phases
string[] | null
primary_school_nets
string[] | null
source
enum<string>[] | null
Available options:
Land,
AC
market
enum<string>[] | null
Available options:
FirstHand,
SecondHand
estate_usages
enum<string>[] | null
Available options:
RE,
HOS,
PRH,
Carpark,
Other
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
developers
string[] | null
sort
enum<string>
default:InsOrRegDate
Available options:
InsOrRegDate,
Price,
NSize,
NUnitPrice

Response

Successful Response

id
string
required
@type
string
default:CentalineTransaction
url
string | null
deal_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
gross_area
number | null
saleable_area
number | null
gross_price_per_sqft
number | null
saleable_price_per_sqft
number | null
bedroom_count
integer | null
direction
string | null
unit_type_code
string | null
estate_structure
string | null
occupation_year
string | null
source
string | null
market
string | null
instrument_at
integer | null
registered_at
integer | null
building_group_id
string | null
building_group_name
string | null
unit_code
string | null
type_code
string | null
scope
object | null
media
object | null
image
string | null
floor_plans
string[]