/propertyfinder/agents/search

POST /api/propertyfinder/agents/search

Price: 10 credits

Search Property Finder agents or companies (agencies) with filters: service offered, property type specialisation, spoken language, nationality and sort. Returns agent or company cards (name, image, ratings, languages, nationality, property counts, license) plus the total available count.

How to use it

Search Property Finder real estate agents or companies (agencies). Set mode to 'agents' or 'companies'. Filter by service (residential/commercial for sale/rent), property_type, language (id), nationality (country code) and sort. count is required. Each result has result_type ('agent' or 'company'), id (use with propertyfinder/agents for full agent details), name, alias, image, email, phone, is_verified, property counts by category, total_property_count and profile_url. Agents also carry is_super_agent, position, nationality, languages, rating, review_count, transaction_count. Companies also carry address, license_number, total_agent_count and total_branch_count. Use domain to select the country marketplace (ae/sa/qa/bh/eg).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• mode string — Search individual agents or companies (agencies) (default: "agents"; one of: "agents", "companies")
• service string nullable — Service the agent/company offers (one of: "1", "2", "3", "4")
• property_type string nullable — Property type specialisation (one of: "1", "35", "22", "20", "42", "24", "18", "29", "10", "5", "30", "31", "45")
• language string nullable — Spoken language id
• nationality string nullable — Nationality code (e.g. 'GB', 'IN')
• sort string — Sort order (default: "-trusted_score"; one of: "-trusted_score", "-total_sales_properties", "-total_rental_properties")
• count integer required — Max number of results to return (min: 1)
• domain string — Country marketplace (default: "ae"; one of: "ae", "sa", "qa", "bh", "eg")

Response

• @type string (default: "PropertyfinderAgentSearchResult")
• result_type string required
• id string required
• name string nullable
• alias string nullable
• image string nullable
• email string nullable
• phone string nullable
• whatsapp_phone string nullable
• is_super_agent boolean nullable
• is_verified boolean nullable
• position string nullable
• nationality string nullable
• languages array (default: [])
• rating number nullable
• review_count integer nullable
• transaction_count integer nullable
• total_property_count integer nullable
• residential_for_sale_count integer nullable
• residential_for_rent_count integer nullable
• commercial_for_sale_count integer nullable
• commercial_for_rent_count integer nullable
• address string nullable
• license_number string nullable
• total_agent_count integer nullable
• total_branch_count integer nullable
• profile_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.