BienIci

get/bienici/search

Request

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

Query parameters

transaction_type'buy' | 'rent' | 'new_build' | 'null' nullable

buy (achat), rent (location), or new_build (neuf, which searches new-build programmes).

property_type[]string[]
zone_ids[]number[]

Repeatable zone ids from the locations endpoint. -7444 is Paris: the captured search in tests/Fixtures/BienIci/search.json is exactly that zone id and returns Paris ads. Zone ids are hyphenated strings upstream; plain numbers are accepted and normalized, but the locations endpoint returns them as strings.

postal_code[]string[]

Repeatable 5-digit postal codes applied after the search, for exact postal-code matching.

min_pricenumber nullable

Minimum price.

max_pricenumber nullable

Maximum price.

min_areanumber nullable

Minimum floor area in m².

max_areanumber nullable

Maximum floor area in m².

min_bedroomsinteger nullable

Minimum bedrooms (chambres), excluding the living room.

max_bedroomsinteger nullable

Maximum bedrooms (chambres).

min_roomsinteger nullable

Minimum total rooms (pièces).

max_roomsinteger nullable

Maximum total rooms (pièces).

min_garden_areanumber nullable

Minimum land area in m².

max_garden_areanumber nullable

Maximum land area in m².

energy_classificationstring nullable

Energy performance letter, for example D.

on_the_marketboolean nullable

Only ads currently on the market.

new_onlyboolean nullable

Only new properties.

sort'publicationDate' | 'null' nullable

Sort order key. Only publicationDate is offered; the upstream default relevance sort mixes buy ads into rent results.

sort_order'asc' | 'desc' | 'null' nullable

asc or desc, default desc.

pageinteger nullable

1-based page. page and size must not address a window beyond 2500 results.

sizeinteger nullable

Ads per page, 1 to 500.

is_previewboolean nullable
is_on_last_floorboolean nullable
has_3d_modelboolean nullable
is_ground_floorboolean nullable
is_not_ground_floorboolean nullable
has_poolboolean nullable
has_balconyboolean nullable
has_terraceboolean nullable
has_balcony_or_terraceboolean nullable
has_cellarboolean nullable
has_parkingboolean nullable
has_fire_placeboolean nullable
has_door_codeboolean nullable
has_intercomboolean nullable
has_gardenboolean nullable
has_elevatorboolean nullable
work_to_doboolean nullable
no_work_to_doboolean nullable
single_storey_houseboolean nullable
is_disabled_people_friendlyboolean nullable
flat_sharingboolean nullable
is_building_plotboolean nullable
is_exclusive_sale_mandateboolean nullable
has_caretakerboolean nullable
is_duplexboolean nullable
has_separate_toiletboolean nullable
is_furnishedboolean nullable
is_not_furnishedboolean nullable
has_photoboolean nullable
is_eligible_for_denormandie_lawboolean nullable
exportable_adboolean nullable
is_in_student_residenceboolean nullable
is_in_senior_residenceboolean nullable
is_in_tourism_residenceboolean nullable
is_in_managed_residenceboolean nullable
is_not_in_residenceboolean nullable
is_not_life_annuity_saleboolean nullable
is_life_annuity_sale_onlyboolean nullable
is_not_property_without_usufructboolean nullable
is_property_without_usufruct_onlyboolean nullable
is_promoted_new_propertyboolean nullable
has_no_photoboolean nullable
has_no_addressboolean nullable
has_addressboolean nullable
has_no_priceboolean nullable
is_promoted_as_exclusiveboolean nullable
has_to_be_builtboolean nullable
has_not_to_be_builtboolean nullable

Response

string required

Changes

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