Yad2

get/yad2/search

Request

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

Query parameters

deal'forsale' | 'rent' required

forsale or rent. Required.

regioninteger required

Region id from the regions endpoint, for example 2 for the south.

pageinteger nullable

1-based page number. Defaults to 1.

minPriceinteger nullable

Lower price bound in Israeli shekels.

maxPriceinteger nullable

Upper price bound in Israeli shekels.

minRoomsnumber nullable

Lower bound on the room count, decimals allowed.

maxRoomsnumber nullable

Upper bound on the room count.

minSquaremeternumber nullable

Lower bound on the built area in square meters.

maxSquaremeternumber nullable

Upper bound on the built area in square meters.

minSquareMeterBuildnumber nullable

Lower bound on the built area excluding the garden.

maxSquareMeterBuildnumber nullable

Upper bound on the built area excluding the garden.

minFloornumber nullable

Lower bound on the floor, -1 for a basement.

maxFloornumber nullable

Upper bound on the floor.

propertyinteger nullable

Property type id from the property facet, for example 1 for an apartment.

propertyConditioninteger nullable

Property condition id from the property facet rows.

sortinteger nullable

Sort order id as used by the Yad2 feed.

Response

string required

Changes

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