Skip to main content
POST
/midland/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: 1 <= x <= 10000
timeout
integer
default:300
Required range: 20 <= x <= 1500
lang
enum<string>
default:zh-hk
Available options:
zh-hk,
zh-cn,
en
unit
enum<string>
default:feet
Available options:
feet,
meter
currency
enum<string>
default:HKD
Available options:
HKD,
CNY
min_building_age
integer | null
Required range: 0 <= x <= 999
max_building_age
integer | null
Required range: 0 <= x <= 999
transaction_type
enum<string> | null
Available options:
S,
L
text
string | null
Minimum string length: 1
transaction_date
enum<string> | null
Available options:
7days,
30days,
90days,
180days,
1year,
3year
market_types
enum<string>[] | null
Available options:
1,
2
gains
enum<string>[] | null
Available options:
profit,
loss
features
enum<string>[] | null
Available options:
balcony,
utility_platform,
flat_roof,
carpark,
roof,
garden,
duplex,
triplex,
combined
source
enum<string> | null
Available options:
landreg,
midland,
hkp
property_types
enum<string>[] | null
Available options:
private,
hos,
tps
is_deluxe
boolean | null
sort
enum<string>
default:default
Available options:
default,
price,
price_desc,
net_area,
net_area_desc,
net_ft_price,
net_ft_price_desc
region_id
string | null
Minimum string length: 1
subregion_ids
string[] | null
Minimum string length: 1
district_ids
string[] | null
Minimum string length: 1
sm_district_ids
string[] | null
Minimum string length: 1
combined_district_ids
string[] | null
Minimum string length: 1
int_district_ids
string[] | null
Minimum string length: 1
int_sm_district_ids
string[] | null
Minimum string length: 1
estate_ids
string[] | null
Minimum string length: 1
phase_ids
string[] | null
Minimum string length: 1
building_ids
string[] | null
Minimum string length: 1
street_ids
string[] | null
Minimum string length: 1
house_street_ids
string[] | null
Minimum string length: 1
unit_ids
string[] | null
Minimum string length: 1
mtr_ids
string[] | null
Minimum string length: 1
walking_duration
integer | null
Required range: x >= 1
school_net
string | null
Minimum string length: 1
university_ids
enum<string>[] | null
Available options:
U01,
U02,
U03,
U04,
U05,
U06,
U07,
U08,
U09,
U10,
U11,
U12,
U13
min_price
number | null
Required range: x >= 0
max_price
number | null
Required range: x >= 0
min_net_area
number | null
Required range: x >= 0
max_net_area
number | null
Required range: x >= 0
min_net_ft_price
number | null
Required range: x >= 0
max_net_ft_price
number | null
Required range: x >= 0
min_holding_period
number | null
Required range: x >= 0
max_holding_period
number | null
Required range: x >= 0
bedrooms
enum<string>[] | null
Available options:
0,
1,
2,
3,
4+
floor_levels
enum<string>[] | null
Available options:
H,
M,
L

Response

Successful Response

id
string
required
@type
string
default:MidlandTransactionCard
url
string | null
transaction_type
string | null
transaction_at
integer | null
market_type
string | null
source
string | null
original_source
string | null
tags
string[]
price
number | null
price_per_net_area
number | null
area
number | null
net_area
number | null
previous_price
number | null
previous_transaction_at
integer | null
gain_percent
number | null
holding_period_years
number | null
bedroom_count
integer | null
sitting_room_count
integer | null
floor
string | null
floor_level
object | null
flat
string | null
is_premium_paid
boolean | null
deal_type
string | null
geo
object | null
estate
object | null
phase
object | null
building
object | null
features
object[]
floor_plans
object[]
image
string | null
location
object | null
listings_url
string | null
updated_at
integer | null