/propertyfinder/properties

POST /api/propertyfinder/properties

Price: 10 credits

Get full Property Finder property listing details by id or URL: title, description, price (with period and currency), price per area, beds/baths/area, property type, offering type, furnishing, completion status, amenities, regulatory (RERA/DLD permit and validation), geo coordinates, gallery, agent, broker and location.

How to use it

Fetch a single Property Finder listing by numeric id (e.g. 101262258) or a property URL. Returns one item with title, description, reference, property_type, offering_type, completion_status (Ready/Off-plan), furnishing (Furnished/Unfurnished/Partly furnished), price/price_period/currency (AED), price_per_area, bedrooms (e.g. '3' or 'studio'), bathrooms, area/area_unit (sqft), is_verified/is_premium/is_exclusive/is_new_construction/is_direct_from_developer/is_high_demand/is_great_value flags, listed_date, available_at (rental availability date), latitude/longitude, location_name/location_path_name, location_tree (hierarchy of id/name/type/alias/level from city down to building), amenities, image+images (gallery), video_id, view_360_url, agent (name, ratings, languages, profile_url), broker (agency name, image, license, totals) and regulatory (permit_number, issued_license_number, permit_validation_url, authority_name, broker/agent license, zone_name). 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)
• property string required — Property listing id or a property page URL containing it (examples: "101262258", "https://www.propertyfinder.ae/en/plp/buy/apartment-for-sale-dubai-101262258.html"; minLength: 1)
• domain string — Country marketplace (default: "ae"; one of: "ae", "sa", "qa", "bh", "eg")

Response

• @type string (default: "PropertyfinderProperty")
• id string required
• url string required
• description string nullable
• reference string nullable
• property_type string nullable
• offering_type string nullable
• category_id integer nullable
• completion_status string nullable
• furnishing string nullable
• price number nullable
• price_period string nullable
• currency string nullable
• price_per_area number nullable
• bedrooms string nullable
• bathrooms integer nullable
• area number nullable
• area_unit string nullable
• is_verified boolean nullable
• is_premium boolean nullable
• is_exclusive boolean nullable
• is_new_construction boolean nullable
• is_direct_from_developer boolean nullable
• is_high_demand boolean nullable
• is_great_value boolean nullable
• listed_date string nullable
• available_at string nullable
• latitude number nullable
• longitude number nullable
• location_name string nullable
• location_path_name string nullable
• location_tree array (default: [])
  • @type string (default: "PropertyfinderLocationNode")
  • id string required
  • name string nullable
  • location_type string nullable
  • alias string nullable
  • level integer nullable
• amenities array (default: [])
• image string nullable
• images array (default: [])
• video_id string nullable
• view_360_url string nullable
• agent object nullable
  • @type string (default: "PropertyfinderPropertyAgent")
  • id string nullable
  • name string nullable
  • alias string nullable
  • image string nullable
  • email string nullable
  • phone string nullable
  • whatsapp_phone string nullable
  • position string nullable
  • languages array (default: [])
  • is_super_agent boolean nullable
  • years_of_experience integer nullable
  • total_property_count integer nullable
  • review_count integer nullable
  • rating number nullable
  • transaction_count integer nullable
  • profile_url string nullable
• broker object nullable
  • @type string (default: "PropertyfinderPropertyBroker")
  • id string nullable
  • name string nullable
  • alias string nullable
  • image string nullable
  • address string nullable
  • email string nullable
  • phone string nullable
  • license_number string nullable
  • total_property_count integer nullable
  • total_agent_count integer nullable
• regulatory object nullable
  • @type string (default: "PropertyfinderRegulatory")
  • permit_number string nullable
  • issued_license_number string nullable
  • permit_validation_url string nullable
  • authority_name string nullable
  • broker_license_number string nullable
  • agent_license_number string nullable
  • zone_name 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 — Property not found (well-formed but nonexistent listing id, or page has no listing) 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.