Skip to main content
POST
Search German homes for rent or sale
  • Endpoint: immoscout.search
  • Returns: data has listings, total.
  • Cost: 1 credit per 25 items, at least 1 credit. Failed calls cost nothing.
  • Paging: Yes. Send the cursor from the response to get the next page. See Paging.

Example

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
location
string
required
Required string length: 2 - 200
type
enum<string>
default:apartmentRent
Available options:
apartmentRent,
apartmentBuy,
houseRent,
houseBuy,
land,
flatShare,
shortTerm
sort
enum<string>
default:newest
Available options:
newest,
priceLow,
priceHigh,
largest
price
object
rooms
object
livingSpace
object
equipment
enum<string>[]
Minimum array length: 1
Available options:
balcony,
builtInKitchen,
garden,
cellar,
parking,
lift,
stepFree,
guestToilet
newConstruction
boolean
query
string
Required string length: 1 - 100
limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string
Pattern: ^(?:\d{1,4}~(?:[1-9]\d{0,4})?|(?:[1-9]\d{0,4}))$

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required