Realestate Specific Parameters
Radius search
https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/radius
Region search
https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/region
Example
search for apparmentBuy in Berlin Mitte with attribute "Neubau":
https://rest.immobilienscout24.de/restapi/api/search/v1.0/search/region?realestatetype=apartmentbuy&geocodes=1276003001046&newbuilding=true
apartmentBuy
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| livingspace |
##.## - ##.## |
|
| numberofrooms |
##.## - ##.## |
|
| equipment |
builtInKitchen, parking, balcony, garden, lift, guestToilet, cellar, handicappedAccessible, assistedLiving |
you can use any order of the values. Lift means "passenger lift" in this context |
| apartmenttypes |
apartment, groundfloor, halfbasement, loft, maisonette, other, penthouse, raisedgroundfloor, roofstorey, terracedflat |
you can use any order of the values |
| constructionyear |
#### - #### |
|
| heatingtypes |
stove, selfcontainedcentral, central |
you can use any order of the values |
| rented |
true, false |
use you only one of this values; specifies the renting status of the apartment you want to buy. Returns only rented apartments if true, only unrented apartments if false and all apartments, if not given |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
| newbuilding |
true |
flag parameter. if given in the url, only buildings which have been build within the last 3 years will be returned |
| buildingproject |
true |
flag parameter. if given in the url, only buildings which are part of a project will be returned |
apartmentRent
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| pricetype |
rentpermonth, budgetrent |
That values specify the meaning of the price parameter. If not specified in URL "rentpermonth" is implied. "budgetrent" is a calculated combination of all given price information which comes with this offer |
| livingspace |
##.## - ##.## |
|
| numberofrooms |
##.## - ##.## |
|
| equipment |
builtInKitchen, parking, balcony, garden, lift, guestToilet, cellar, handicappedAccessible, assistedLiving |
you can use any order of the values. Lift means "passenger lift" in this context |
| apartmenttypes |
apartment, groundfloor, halfbasement, loft, maisonette, other, penthouse, raisedgroundfloor, roofstorey, terracedflat |
you can use any order of the values |
| constructionyear |
#### - #### |
|
| heatingtypes |
stove, selfcontainedcentral, central |
you can use any order of the values |
| haspromotion |
true, false |
use only one of this values. haspromotion means "certificate of eligibility for public housing" ("Wohnungsberechtigungsschein" WBS) |
| newbuilding |
true |
flag parameter. if given in the url, only buildings which have been build within the last 3 years will be returned |
assistedLiving
| PARAMETER |
VALUE |
COMMENTS |
| additionalservices |
petsallowed, trialliving |
|
| equipment |
balcony, cookingpossibility, garden, handicappedaccessible, ownfurnishing, parking |
|
| medicalservices |
ambulantnursingservice |
|
| pricetype |
buy, rent |
|
compulsoryAuction
| PARAMETER |
VALUE |
COMMENTS |
| marketvalue |
##.## - ##.## |
|
| auctionobjecttypes |
freeholdflat, familyhouse, businessandyield, lot, garageandother |
comma seperated list of values |
| auctiontypes |
recurrenceappointment, splittingauction |
comma seperated list of values |
flatShareRoom
| PARAMETER |
VALUE |
COMMENTS |
| equipment |
cooker, dishwasher, fridge, handicappedaccessible, internet, oven, petsallowed |
you can use any order of the values |
| flatsharesize |
2, 3, 4, 5, 6, 7, 8, 9, 10, greaterthenten |
one of these values |
| furniture |
true, false |
one of these values |
| gender |
female, male |
one of these values |
| price |
##.## - ##.## |
monthly net rent range |
| livingspace |
##.## - ##.## |
living space range |
| smokingallowed |
allowed, ownroomonly, unwanted |
one of these values |
| startrentaldate |
YYYY-MM-DD |
an ISO 8601 date |
| rentalduration |
### |
integer number of months. Values from 1-100 |
garageBuy
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| garagetypes |
garage, streetparking |
comma seperated list of values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
garageRent
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| garagetypes |
garage, streetparking |
comma seperated list of values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
gastronomy
| PARAMETER |
VALUE |
COMMENTS |
| gastronomytypes |
guestshouse, clubdisco, barlounge, cafe, hotelresidence, tavern, hotelgarni, hotel, restaurant, pension, bungalow |
comma separated list of values |
| equipment |
cellar |
|
| totalfloorspace |
###.### - ###.### |
range: double values; for the meaning of the totalfloorspace refer to the Area entry in the glossary |
| numberofbeds |
### - ### |
range: integer values |
| numberofseats |
### - ### |
range: integer values |
| price |
true |
|
| pricetype |
lease, buy |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned |
| freeofcourtageonly |
##.## - ##.## |
flag parameter. if given in the url, only real estates without courtage will be returned |
houseBuy
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| livingspace |
##.## - ##.## |
|
| ground |
##.## - ##.## |
|
| numberofrooms |
##.## - ##.## |
|
| equipment |
parking, guesttoilet, cellar, handicappedaccessible, lodgerflat |
you can use any order of the values |
| buildingtypes |
singlefamilyhouse, midterracehouse, endterracehouse, multifamilyhouse, bungalow, farmhouse, semidetachedhouse, villa, castlemanorhouse, specialrealestate, otherrealestate |
you can use any order of the value |
| constructionyear |
#### - #### |
|
| heatingtypes |
stove, selfcontainedcentral, central |
you can use any order of the values |
| constructionphasetypes |
projected, underconstruction, completed, noinformation |
you can use any order of the values |
| rented |
true, false |
use you only one of this values; specifies the renting status of the house you want to buy |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
| newbuilding |
true |
flag parameter. if given in the url, only buildings which have been build within the last 3 years will be returned |
| buildingproject |
true |
flag parameter. if given in the url, only buildings which are part of a project will be returned |
houseRent
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| pricetype |
rentpermonth, budgetrent |
That values specify the meaning of the price parameter. If not specified in URL "rentpermonth" is implied. "budgetrent" is a calculated combination of all given price information which comes with this offer |
| livingspace |
##.## - ##.## |
|
| ground |
##.## - ##.## |
|
| numberofrooms |
##.## - ##.## |
|
| equipment |
parking, guesttoilet, cellar, handicappedaccessible, builtinkitchen |
you can use any order of the values |
| buildingtypes |
singlefamilyhouse, midterracehouse, endterracehouse, multifamilyhouse, bungalow, farmhouse, semidetachedhouse, villa, castlemanorhouse, specialrealestate, otherrealestate |
you can use any order of the value |
| constructionyear |
#### - #### |
|
| heatingtypes |
stove, selfcontainedcentral, central |
you can use any order of the values |
| newbuilding |
true |
flag parameter. if given in the url, only buildings which have been build within the last 3 years will be returned |
houseType
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| buildingtypes |
blockhouse,bungalow, semidetachedhouse,onefamilyhouse, familyhousewithlodgerflat,tudorhouse, woodenhouse,countryhouse, apartmentbuilding,nondetachedhouse, cityvilla, villa,semidetachedhousepair |
comma seperated list of values |
| livingspace |
##.## - ##.## |
|
industry
| PARAMETER |
VALUE |
COMMENTS |
| industrytypes |
showroomspace,hall,highlackstorage,industryhall, industryhallwithopenarea,coldstorage, multideckcabinetstorage, storagewithopenarea,storagearea,storagehall, servicearea,shippingstorage,repairshop |
comma separated list of values |
| equipment |
lift,autolift,cranerunway,ramp |
"Lift" means "goods lift" in this context |
| totalfloorspace |
###.### - ###.### |
range: double values; for the meaning of the totalfloorspace refer to the Area entry in the glossary |
| netfloorspace |
###.### - ###.### |
range: double values; for the meaning of the netfloorspace refer to the Area entry in the glossary |
| price |
##.## - ##.## |
|
| pricetype |
rentpersqm, rentpermonth, buy |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
investment
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| netfloorspace |
###.## - ###.## |
range: double values |
| pricepersqm |
##.## - ##.## |
range: double values |
| pricemultiplier |
##.## - ##.## |
range: double values; it is the result of price / annual net cold rent |
| investmenttypes |
singlefamilyhouse, multifamilyhouse,freeholdflat,shoppingcentre, restaurant,hotel,leisurefacility, commercialunit,officebuilding, commercialbuilding,commercialproperty, hallstorage,industrialproperty, shopsalesfloor,servicecentre, other,supermarket,livingbusinesshouse, housingestate |
comma separated list of values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
livingBuySite
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| pricetype |
buy, longlease |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned. note: if you search pricetype "longlease", you get the marketingtype "leasehold" as response |
| plotarea |
###.## - ###.## |
|
| shorttermconstructible |
true |
flag parameter. if given in the url, only sites that are short term constructible will be returned |
| buildingpermission |
true |
flag parameter. if given in the url, only sites that have a building permission will be returned |
| siteconstructibletypes |
externalarea, constructionplan, neighbourconstruction |
you can use any order of the values |
| sitedevelopmenttypes |
developed, developedpartially, notdeveloped |
you can use any order of the values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
livingRentSite
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
|
| pricetype |
rent, lease |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned |
| plotarea |
##.## - ##.## |
|
| shorttermconstructible |
true |
flag parameter. if given in the url, only sites that are short term constructible will be returned |
| buildingpermission |
true |
flag parameter. if given in the url, only sites that have a building permission will be returned |
| siteconstructibletypes |
externalarea, constructionplan, neighbourconstruction |
you can use any order of the values |
| sitedevelopmenttypes |
developed, developedpartially, notdeveloped |
you can use any order of the values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
office
| PARAMETER |
VALUE |
COMMENTS |
| equipment |
highvoltage, airconditioning, lancables, handicappedaccessible |
you can use any order and any subset of the values |
| numberofparkingspaces |
## - ## |
range: integer values |
| netfloorspace |
###.### - ###.### |
range: double values; for the meaning of the netfloorspace refer to the Area entry in the glossary |
| officetypes |
loft, studio, office, officefloor, officebuilding, officecentre, officestoragebuilding, surgery, surgeryfloor, surgerybuilding, commercialcentre, livingandcommercialbuilding, officeandcommercialbuilding |
comma separated list of values |
| price |
##.## - ##.## |
|
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
| rentduration |
weekly, monthly, yearly, longterm |
comma separated list of values. Searches for shortterm or longterm rental contracts |
seniorCare
| PARAMETER |
VALUE |
COMMENTS |
| additionalservices |
petsallowed |
|
| equipment |
balcony |
|
| roomtype |
singlebedroom, sharedroom |
you can use any order of the values |
| caretype |
stationary, day, shortterm, respite |
you can use any order of the values |
| seniorcarelevel |
level1, level2, level3 |
you can use any order of the values |
| careof |
dementia, artificialrespiration, comavigil, stroke, parkinson, alzheimer, multiplesclerosis |
you can use any order of the values |
shortTermAccomodation
| PARAMETER |
VALUE |
COMMENTS |
| shorttermaccommodationtype |
flat,house,room |
either one of these values |
| startrentaldate |
YYYY-MM-DD |
an ISO 8601 date |
| price |
##.## - ##.## |
range: double values |
| equipment |
cellar,guesttoilet,parking |
comma seperated list of values |
| nonsmoker |
true, false |
|
| furniture |
true, false |
|
| freeduration |
number |
|
| freeinterval |
month,week,day |
either one of these values |
| numberofrooms |
number |
|
specialPurpose
| PARAMETER |
VALUE |
COMMENTS |
| specialpurposetypes |
residence,farm, horsefarm, vineyard,repairshop, leisurefacility, industrialarea, specialestate, commercialcentre |
comma separated list of values |
| equipment |
cellar |
|
| totalfloorspace |
###.### - ###.### |
range: double values; for the meaning of the totalfloorspace refer to the Area entry in the glossary |
| price |
##.## - ##.## |
range: double values |
| pricetype |
rentpersqm, rentpermonth, buy |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
store
| PARAMETER |
VALUE |
COMMENTS |
| storetypes |
showroomspace, shoppingcentre, factoryoutlet, departmentstore, kiosk, store, selfservicemarket, salesarea, saleshall |
comma separated list of values |
| equipment |
cellar |
|
| totalfloorspace |
###.### - ###.### |
range: double values; for the meaning of the totalfloorspace refer to the Area entry in the glossary |
| netfloorspace |
###.### - ###.### |
range: double values; for the meaning of the totalfloorspace refer to the Area entry in the glossary |
| price |
##.## - ##.## |
range: double values |
| pricetype |
rentpersqm, rentpermonth, buy |
That values specify the meaning of the price parameter. If not specified in URL no filtering will be applied. So every result for every price type will be returned |
| locationclassification |
a, b, shoppingcentre |
comma separated list of values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
tradeSite
| PARAMETER |
VALUE |
COMMENTS |
| price |
##.## - ##.## |
range: double values |
| pricetype |
rent, buy, lease, longlease |
an unordered list of these values; if a price is given, only one value may be given here. note: if you search pricetype "longlease", you get the marketingtype "leasehold" as response |
| utilizationtradesites |
leisure, agricultureforestry, trade |
comma separated list of values |
| plotarea |
###.### - ###.### |
range: double values |
| shorttermconstructible |
true |
flag parameter. if given in the url, only sites that are short term constructible will be returned |
| buildingpermission |
true |
flag parameter. if given in the url, only sites that are short term constructible will be returned |
| siteconstructibletypes |
externalarea, constructionplan, neighbourconstruction |
comma separated list of values |
| sitedevelopmenttypes |
developed, developedpartially, notdeveloped |
comma separated list of values |
| freeofcourtageonly |
true |
flag parameter. if given in the url, only real estates without courtage will be returned |
Supplementary Notes
-
If the request contains a parameter "price", then "pricetype" must be specified. With the "pricetype" parameter, commercial real estate indirectly hands out information on CommerzialisationType (Rent or Buy). The parameter "pricetype" can be used "solo" without price - but not vice versa.
For "price" ranges you may omit start or end value, like "12000-" or "-20000".
-
ApartmentRent and HouseRent may use "pricetype" to search for "budgetrent". "pricetype" is optional and defaults to "rentpermonth" if omitted.