Yaencontre

get/yaencontre/search

Request

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

Query parameters

operation'BUY' | 'RENT' | 'TRANSFER' required

BUY, RENT, or TRANSFER. Default BUY.

family'FLAT' | 'HOUSE' | 'GARAGE' | 'LAND' | 'NEW_CONSTRUCTION' | 'OFFICE' | 'HOME' | 'BUILDING' | 'BUSINESS' required

FLAT, HOUSE, GARAGE, LAND, NEW_CONSTRUCTION, OFFICE, HOME, BUILDING, or BUSINESS. Default FLAT.

locationstring nullable

Location token from the autocomplete endpoint.

real_estate_agency_idinteger nullable

Agency id from the autocomplete agencies bucket. Returns that agency stock plus its profile.

min_priceinteger nullable

Lower price bound in euros. Only with operation=BUY.

max_priceinteger nullable

Upper price bound in euros. Only with operation=BUY.

roomsinteger nullable

Minimum number of rooms, from 1 to 4. Values outside that range return 422.

bathroomsinteger nullable

Minimum number of bathrooms, from 1 to 4. Values outside that range return 422.

rental_type'LONG_TERM_RENT' | 'SEASONAL_RENT' | 'null' nullable

LONG_TERM_RENT or SEASONAL_RENT. Only with operation=RENT.

lat_minnumber nullable

South edge of the map box, sent with lat_max, lon_min and lon_max.

lat_maxnumber nullable

North edge of the map box.

lon_minnumber nullable

West edge of the map box.

lon_maxnumber nullable

East edge of the map box.

sizeinteger nullable

Map size hint sent with a bounds box. Default 200.

page_numberinteger required

1-based page number.

page_sizeinteger required

Results per page, 1 to 50. Default 50.

Response

string required

Changes

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