Bayut

get/bayut/search

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/bayut/search
  • Auth: API key in header X-API-KEY

Query parameters

querystring nullable

Free-text search, e.g. dubai marina.

purpose'for-sale' | 'for-rent' | 'null' nullable

for-sale or for-rent.

price_mininteger nullable

Optional minimum price in AED.

price_maxinteger nullable

Optional maximum price in AED.

roomsinteger nullable

Exact room count, 0 to 10. 0 is a studio.

bathsinteger nullable

Exact bathroom count.

area_minnumber nullable

Optional minimum area in square metres.

area_maxnumber nullable

Optional maximum area in square metres.

location_external_id[]string[]

Repeatable location id from the locations endpoint, e.g. 5003 for Dubai Marina.

category_external_idstring nullable

Category id, e.g. 1 for Residential.

sort'default' | 'price-asc' | 'price-desc' | 'date-desc' | 'v6-score' | 'verified-score' | 'null' nullable

default, price-asc, price-desc, date-desc, v6-score or verified-score. Defaults to default.

pageinteger nullable

Zero-based page number. Defaults to 0.

limitinteger nullable

Listings per page, 1 to 50. Defaults to 20.

Response

string required

Changes

No recorded changes to this operation across all 3 revisions of this API.