GETbyID OnTop Placement

This method provides a method to get information about the OnTop Placement of a real estate.{username or me}/realestate/{id or externalId}/{ontop placement}

Possible OnTop Placements:

  • showcaseplacement ("Schaufenster-Platzierung")
  • premiumplacement ("Premium-Platzierung")
  • topplacement ("Top-Platzierung")

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

A System Key and an authenticated user are required for this operation:

Please use a secure connection (https) for this operation.


Path Parameters

  • Username: the username which the user uses for logging in to www.immobilienscout24.
  • Username: "me" can be used instead of the username, when the user is logged in by 3-legged oauth.
  • id: the unique scout object ID, which is being created by POST REALESTATE automatically.
  • external-id: can be used instead of the scout object ID
  •   it is the customer-defined ID of the real estate, must be unique per user
  • ontop placement: the type of the ontop placement (showcaseplacement, premiumplacement or topplacement)

Query Parameters

  • none


The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK: The requested operation was successful.


No special headers.



<premiumplacement:premiumplacements xmlns:toplisting="" xmlns:xlink="">
   <premiumplacement realestateid="53483572">
      <message>premium placed</message>

or unsuccessful response:

<premiumplacement:premiumplacements xmlns:toplisting="" xmlns:xlink="">
   <toplisting realestateid="53483572">
      <message>not premium placed</message>