Skip to main content
POST
Search German homes for rent or sale
  • Endpoint: immoscout.search
  • Returns: data has total, results, page, hasMore, totalPages.
  • Cost: 1 credit per call. Failed calls cost nothing.
  • Paging: No.

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
minPrice
number
Required range: x >= 0
maxPrice
number
Required range: x >= 0
minRooms
number
Required range: x >= 0
sort
enum<string>
default:newest
Available options:
newest,
priceLow,
priceHigh,
largest
page
integer
default:1

Page number, starting at 1.

Required range: 1 <= x <= 200

Response

The data, and the credits this call used.

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