Skip to main content
POST
/
api
/
propertyfinder
/
properties
/
search
/propertyfinder/properties/search
curl --request POST \
  --url https://api.anysite.io/api/propertyfinder/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "location_id": 123,
  "category": "1",
  "beds": [],
  "baths": [],
  "min_price": 1,
  "max_price": 1,
  "min_area": 1,
  "max_area": 1,
  "min_price_per_area": 1,
  "max_price_per_area": 1,
  "amenities": [],
  "keywords": "<string>",
  "sort": "mr",
  "domain": "ae"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@propertyfinder_search_result",
    "title": "<string>",
    "property_type": "<string>",
    "offering_type": "<string>",
    "category_id": 123,
    "completion_status": "<string>",
    "furnishing": "<string>",
    "price": 123,
    "price_period": "<string>",
    "currency": "<string>",
    "price_per_area": 123,
    "bedrooms": "<string>",
    "bathrooms": 123,
    "area": 123,
    "area_unit": "<string>",
    "is_verified": true,
    "is_premium": true,
    "is_new_construction": true,
    "is_high_demand": true,
    "is_great_value": true,
    "has_video": true,
    "has_view_360": true,
    "latitude": 123,
    "longitude": 123,
    "location_name": "<string>",
    "reference": "<string>",
    "listed_date": "<string>",
    "image": "<string>",
    "agent_name": "<string>",
    "broker_name": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
location_id
integer | null

Numeric location id (city/community/building); omit to search the whole country

category
enum<string>
default:1

Listing category

Available options:
1,
2,
3,
4,
5
property_type
enum<string> | null

Property type

Available options:
1,
35,
22,
20,
42,
24,
18,
29,
10,
5,
30,
31,
45
beds
enum<string>[] | null

Bedroom counts to include

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8
baths
enum<string>[] | null

Bathroom counts to include

Available options:
1,
2,
3,
4,
5,
6,
7,
8
min_price
integer | null

Minimum price (AED)

Required range: x >= 0
max_price
integer | null

Maximum price (AED)

Required range: x >= 0
price_period
enum<string> | null

Rent price period (rent categories only)

Available options:
yearly,
monthly,
weekly,
daily
completion_status
enum<string> | null

Completion status

Available options:
off_plan,
completed
furnishing
enum<string> | null

Furnishing status

Available options:
0,
1,
2,
3
min_area
integer | null

Minimum area (sqft)

Required range: x >= 0
max_area
integer | null

Maximum area (sqft)

Required range: x >= 0
min_price_per_area
integer | null

Minimum price per area (AED/sqft)

Required range: x >= 0
max_price_per_area
integer | null

Maximum price per area (AED/sqft)

Required range: x >= 0
amenities
enum<string>[] | null

Required amenities

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

Virtual viewing availability

Available options:
360_tours,
video,
live
listed_within
enum<string> | null

Only listings published within this recency window

Available options:
86400,
604800,
1296000,
2592000,
7776000
keywords
string | null

Free-text keywords (e.g. 'beach, chiller free')

sort
enum<string>
default:mr

Sort order

Available options:
mr,
nd,
pa,
pd,
ba,
bd,
da,
dd
domain
enum<string>
default:ae

Country marketplace

Available options:
ae,
sa,
qa,
bh,
eg

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@propertyfinder_search_result
title
string | null
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