/propertyfinder/locations/search

POST /api/propertyfinder/locations/search

Price: 20 credits

Resolve a Property Finder location (city, community or building) by name. Returns matching locations with their numeric id (use as location_id in propertyfinder/properties/search), name, slug, hierarchy path, type and coordinates.

How to use it

Look up Property Finder locations by name to resolve the numeric location id needed for propertyfinder/properties/search. Pass keyword (e.g. 'Dubai Marina'). Each result has id (the location_id), name, alias, path (hierarchy id chain), path_name (human-readable hierarchy), location_type, latitude/longitude and children_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)
• keyword string required — Location name to look up (city, community or building) (minLength: 1)
• 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: "PropertyfinderLocation")
• id string required
• name string nullable
• alias string nullable
• path string nullable
• path_name string nullable
• location_type string nullable
• latitude number nullable
• longitude number nullable
• children_count integer 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.