PropertyFinder

get/propertyfinder/search

Request

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

Query parameters

category_idinteger nullable

1 buy, 2 rent, 3 and 4 commercial.

location_idsstring nullable

Comma-separated location ids from the locations endpoint.

bedroomsinteger nullable

Exact number of bedrooms.

property_type_idsstring nullable

Comma-separated property type ids.

keywordsstring nullable

Free-text keywords.

price_type'daily' | 'weekly' | 'monthly' | 'yearly' | 'null' nullable

daily, weekly, monthly or yearly. Rent listings only.

min_priceinteger nullable

Minimum price in the listing currency.

max_priceinteger nullable

Maximum price in the listing currency.

sort'featured' | 'newest' | 'priceAsc' | 'priceDesc' | 'bedroomAsc' | 'null' nullable

featured, newest, priceAsc, priceDesc or bedroomAsc. Defaults to featured.

pageinteger nullable

Page number, 1-based. Defaults to 1.

limitinteger nullable

Results per page, 1 to 50.

locale'en' | 'ar' | 'null' nullable

en or ar. Defaults to en.

country'ae' | 'sa' | 'qa' | 'bh' | 'eg' | 'null' nullable

ae, sa, qa, bh or eg. Defaults to ae.

Response

string required

Changes

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