WgGesucht

get/wg-gesucht/search

Request

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

Query parameters

categoriesinteger required

Listing type. 0 = WG-Zimmer, 1 = 1-Zimmer-Wohnung, 2 = Wohnung, 3 = Haus. Required.

city_idinteger required

WG-Gesucht city id, from the locations endpoint. Required.

rent_typesinteger required

0 = all, 1 = fixed term, 2 = unlimited term, 3 = short term or nightly. Required.

pageinteger nullable

1-based page number. Default 1.

limitinteger nullable

Cards per page, 1-111. Default 30.

sort_columninteger nullable

0 relevance, 1 date created, 2 rooms, 4 rent price, 5 floor area, 6 available from.

sort_order'' | '1' | 'null' nullable

Empty for ascending, 1 for descending. This value space is specific to this API.

languagestring nullable
rMinnumber nullable

Minimum total monthly rent in euros.

rMaxnumber nullable

Maximum total monthly rent in euros.

sMinnumber nullable

Minimum usable area in square metres.

sMaxnumber nullable

Maximum usable area in square metres.

rmMinnumber nullable

Minimum number of rooms.

rmMaxnumber nullable

Maximum number of rooms.

aMinnumber nullable

Lowest flatmate age to include. This is an age, not an area.

aMaxnumber nullable

Highest flatmate age to include. This is an age, not an area.

wgMnFnumber nullable
wgMxTnumber nullable
flonumber nullable
radDisnumber nullable

Radius in metres around an address. Requires radAdd, radLat, and radLng together; a radius alone is ignored and widens the query to the whole city.

radLatnumber nullable

Latitude of the radius centre.

radLngnumber nullable

Longitude of the radius centre.

furboolean nullable

Only furnished listings.

kitboolean nullable

Only listings with their own or a shared kitchen.

garboolean nullable

Only listings with a garage.

hanboolean nullable
petboolean nullable

Only listings where pets are allowed.

pets_presentboolean nullable

Exclude listings with pets already living there.

sinboolean nullable
excboolean nullable
ffboolean nullable

Only listings in a building with a lift.

balboolean nullable

Only listings with a balcony.

bal_or_terboolean nullable
noDeactboolean nullable
imgboolean nullable
img_onlyboolean nullable

Only listings that have photos.

flatshare_friendlyboolean nullable
onl_tourboolean nullable
exContAdsboolean nullable
exCuboolean nullable
dFrstring nullable

Earliest move-in date as YYYY-MM-DD.

dTostring nullable

Latest move-out date as YYYY-MM-DD.

dFrDestring nullable
dToDestring nullable
wgArtstring nullable
wgFlastring nullable
wgSmostring nullable
wgSeastring nullable
genstring nullable
smostring nullable
pustring nullable
ad_typestring nullable
otstring nullable

Comma-separated district ids from the districts endpoint. Exact and additive. This is the reliable way to scope a search to districts.

radAddstring nullable

Address the radius is measured from.

Response

string required

Changes

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