Immoweb

Search Belgian listings

get/immoweb/search

Request

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

Query parameters

transactionTypes'FOR_SALE' | 'FOR_RENT' required

FOR_SALE or FOR_RENT. Required.

propertyTypes'HOUSE' | 'APARTMENT' | 'HOUSE_AND_APARTMENT' | 'OFFICE' | 'INDUSTRY' | 'COMMERCIAL' | 'LAND' | 'GARAGE' | 'TENEMENT_BUILDING' | 'HOMES_TO_BUILD' | 'HOUSE_GROUP' | 'APARTMENT_GROUP' | 'LOT_SALES' | 'OTHER' | 'null' nullable

Property type, for example HOUSE, APARTMENT, LAND or HOMES_TO_BUILD for new build.

constructionTypes'ANY' | 'ALL_KIND' | 'APARTMENT_BUILDING' | 'BEL_ETAGE' | 'BUNGALOW' | 'HOUSE' | 'VILLA' | 'null' nullable

Construction type, for example VILLA, HOUSE, BUNGALOW, BEL_ETAGE, APARTMENT_BUILDING, ALL_KIND or ANY. This vocabulary is not yet confirmed against the live API. An unrecognised value is rejected with HTTP 422. If a recognised value turns out not to be a query value the tier accepts, it returns zero results rather than the full inventory.

buildingConditions'FIRST_TIME_USED' | 'GOOD' | 'AS_NEW' | 'TO_RESTORE' | 'JUST_RENOVATED' | 'TO_BE_DONE_UP' | 'TO_RENOVATE' | 'CASCO' | 'null' nullable
gardenOrientations'NORTH' | 'SOUTH' | 'EAST' | 'WEST' | 'NORTH_EAST' | 'NORTH_WEST' | 'SOUTH_EAST' | 'SOUTH_WEST' | 'null' nullable
epcScores'A' | 'B' | 'C' | 'null' nullable

The measured parameter is epcScores with label values, not the DEX model enum.

priceType'PRICE' | 'MONTHLY_RENTAL_PRICE' | 'YEARLY_RENTAL_PRICE' | 'PRICE_PER_SQM' | 'YEARLY_RENTAL_PRICE_PER_SQM' | 'null' nullable

PRICE, MONTHLY_RENTAL_PRICE, YEARLY_RENTAL_PRICE, PRICE_PER_SQM or YEARLY_RENTAL_PRICE_PER_SQM.

sort'PRICE' | 'AD_QUALITY' | 'POSTAL_CODE' | 'PUBLICATION_DATE' | 'null' nullable

PRICE, AD_QUALITY, POSTAL_CODE or PUBLICATION_DATE. Each criterion has one fixed direction.

language'nl' | 'fr' | 'en' | 'null' nullable

nl, fr or en. Bare two-letter codes only; defaults to nl.

minPriceinteger nullable

Minimum price.

maxPriceinteger nullable

Maximum price.

minSurfaceinteger nullable
maxBedroomCountinteger nullable
minConstructionYearinteger nullable
minParkingPlacesinteger nullable
maxDaysSinceActivationinteger nullable
customerIdsstring nullable
postalCodesstring nullable

Comma-separated Belgian postal codes. Both 9000 and BE-9000 are accepted.

provincesstring nullable

Unprefixed province codes, for example ANTWERP or EAST_FLANDERS.

districtsstring nullable

Unprefixed district codes, for example GENT.

hasGardenboolean nullable

Restrict to listings with a garden.

hasLiftboolean nullable
hasSwimmingPoolboolean nullable
hasPicturesboolean nullable
hasVirtualTourOr360boolean nullable
isNewlyBuiltboolean nullable
isSoldOrRentedboolean nullable
isFurnishedboolean nullable
isImmediatelyAvailableboolean nullable
isAPublicSaleboolean nullable

Restrict to notary public sales (veiling).

isALifeAnnuitySaleboolean nullable
isAnInvestmentPropertyboolean nullable
isUnderOptionboolean nullable
isAWorkSpacePropertyboolean nullable
areBigPetsAllowedboolean nullable
isConstructionPermitObtainedboolean nullable
rangestring nullable

0-based and inclusive at both ends. The width ceiling lives in withValidator() below, where it can be reported as a validation error rather than a silent truncation.

Response

string required
OR
OR

Changes

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