/propertyfinder/agents

POST /api/propertyfinder/agents

Price: 20 credits

Get a Property Finder agent profile by id or URL: name, photo, bio, position, languages, nationality, ratings and review count, years of experience, license number, transaction count, property counts by category, agency (broker) and top locations.

How to use it

Fetch a single Property Finder real estate agent by id (e.g. 114574) or profile URL. Returns one item with name, alias, image, bio, position, email, phone, whatsapp_phone, avg_whatsapp_response_time (minutes), linkedin_url, nationality, languages, is_super_agent, is_verified, experience_since (year), license_number, compliances (regulatory registrations), rating, review_count, rating_distribution (count per star), transaction_count, transactions (claimed deal_volume plus sale/rent counts and total/avg amounts), total_property_count, residential/commercial for-sale/for-rent counts, top_locations, profile_url and broker (agency id/name/alias/image). 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)
• agent string required — Agent id or agent profile URL containing it (examples: "114574", "https://www.propertyfinder.ae/en/agent/kianoush-darban-114574"; minLength: 1)
• domain string — Country marketplace (default: "ae"; one of: "ae", "sa", "qa", "bh", "eg")

Response

• @type string (default: "PropertyfinderAgent")
• id string required
• name string nullable
• alias string nullable
• image string nullable
• bio string nullable
• position string nullable
• email string nullable
• phone string nullable
• whatsapp_phone string nullable
• avg_whatsapp_response_time integer nullable
• linkedin_url string nullable
• nationality string nullable
• languages array (default: [])
• is_super_agent boolean nullable
• is_verified boolean nullable
• experience_since integer nullable
• license_number string nullable
• compliances array (default: [])
  • @type string (default: "PropertyfinderAgentCompliance")
  • type string nullable
  • value string nullable
• rating number nullable
• review_count integer nullable
• rating_distribution object nullable
  • @type string (default: "PropertyfinderAgentRatingDistribution")
  • one_star integer nullable
  • two_star integer nullable
  • three_star integer nullable
  • four_star integer nullable
  • five_star integer nullable
• transaction_count integer nullable
• transactions object nullable
  • @type string (default: "PropertyfinderAgentTransactions")
  • deal_volume integer nullable
  • sale_count integer nullable
  • sale_total_amount integer nullable
  • sale_avg_amount number nullable
  • rent_count integer nullable
  • rent_total_amount integer nullable
  • rent_avg_amount number 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
• top_locations array (default: [])
• profile_url string nullable
• broker object nullable
  • @type string (default: "PropertyfinderAgentBroker")
  • id string nullable
  • name string nullable
  • alias string nullable
  • image 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 — Agent not found (well-formed but nonexistent agent id) 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.