Skip to main content
POST
/
api
/
propertyfinder
/
agents
/
search
/propertyfinder/agents/search
curl --request POST \
  --url https://api.anysite.io/api/propertyfinder/agents/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "mode": "agents",
  "language": "<string>",
  "nationality": "<string>",
  "sort": "-trusted_score",
  "domain": "ae"
}
'
[
  {
    "result_type": "<string>",
    "id": "<string>",
    "@type": "@propertyfinder_agent_search_result",
    "name": "<string>",
    "alias": "<string>",
    "image": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "whatsapp_phone": "<string>",
    "is_super_agent": true,
    "is_verified": true,
    "position": "<string>",
    "nationality": "<string>",
    "languages": [],
    "rating": 123,
    "review_count": 123,
    "transaction_count": 123,
    "total_property_count": 123,
    "residential_for_sale_count": 123,
    "residential_for_rent_count": 123,
    "commercial_for_sale_count": 123,
    "commercial_for_rent_count": 123,
    "address": "<string>",
    "license_number": "<string>",
    "total_agent_count": 123,
    "total_branch_count": 123,
    "profile_url": "<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
mode
enum<string>
default:agents

Search individual agents or companies (agencies)

Available options:
agents,
companies
service
enum<string> | null

Service the agent/company offers

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

Property type specialisation

Available options:
1,
35,
22,
20,
42,
24,
18,
29,
10,
5,
30,
31,
45
language
string | null

Spoken language id

nationality
string | null

Nationality code (e.g. 'GB', 'IN')

sort
enum<string>
default:-trusted_score

Sort order

Available options:
-trusted_score,
-total_sales_properties,
-total_rental_properties
domain
enum<string>
default:ae

Country marketplace

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

Response

Successful Response

result_type
string
required
id
string
required
@type
string
default:@propertyfinder_agent_search_result
name
string | null
alias
string | null
image
string | null
email
string | null
phone
string | null
whatsapp_phone
string | null
is_super_agent
boolean | null
is_verified
boolean | null
position
string | null
nationality
string | null
languages
string[]
rating
number | null
review_count
integer | null
transaction_count
integer | null
total_property_count
integer | null
residential_for_sale_count
integer | null
residential_for_rent_count
integer | null
commercial_for_sale_count
integer | null
commercial_for_rent_count
integer | null
address
string | null
license_number
string | null
total_agent_count
integer | null
total_branch_count
integer | null
profile_url
string | null