Skip to main content
POST
/propertyfinder/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
location_id
integer | null
category
enum<string>
default:1
Available options:
1,
2,
3,
4,
5
property_type
enum<string> | null
Available options:
1,
35,
22,
20,
42,
24,
18,
29,
10,
5,
30,
31,
45
beds
enum<string>[] | null
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8
baths
enum<string>[] | null
Available options:
1,
2,
3,
4,
5,
6,
7,
8
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
price_period
enum<string> | null
Available options:
yearly,
monthly,
weekly,
daily
completion_status
enum<string> | null
Available options:
off_plan,
completed
furnishing
enum<string> | null
Available options:
0,
1,
2,
3
min_area
integer | null
Required range: x >= 0
max_area
integer | null
Required range: x >= 0
min_price_per_area
integer | null
Required range: x >= 0
max_price_per_area
integer | null
Required range: x >= 0
amenities
enum<string>[] | null
Available options:
MR,
BA,
SP,
SS,
SY,
AC,
CS,
CP,
VW,
BL,
PA,
PR,
CO,
BR,
BW,
ST,
WC,
PJ
virtual_viewing
enum<string> | null
Available options:
360_tours,
video,
live
listed_within
enum<string> | null
Available options:
86400,
604800,
1296000,
2592000,
7776000
keywords
string | null
sort
enum<string>
default:mr
Available options:
mr,
nd,
pa,
pd,
ba,
bd,
da,
dd
domain
enum<string>
default:ae
Available options:
ae,
sa,
qa,
bh,
eg

Response

Successful Response

id
string
required
url
string
required
@type
string
default:PropertyfinderSearchResult
property_type
string | null
offering_type
string | null
category_id
integer | null
completion_status
string | null
furnishing
string | null
price
number | null
price_period
string | null
currency
string | null
price_per_area
number | null
bedrooms
string | null
bathrooms
integer | null
area
number | null
area_unit
string | null
is_verified
boolean | null
is_premium
boolean | null
is_new_construction
boolean | null
is_high_demand
boolean | null
is_great_value
boolean | null
has_video
boolean | null
has_view_360
boolean | null
latitude
number | null
longitude
number | null
location_name
string | null
reference
string | null
listed_date
string | null
image
string | null
agent_name
string | null
broker_name
string | null