Insert a Real Estate

This method creates a real estate object.

Supported media types:
XML
JSON

POST /offer/v1.0/user/{username or me}/realestate/

The new created object is deactivated (not published by default). Please use publish request for publishing the Real-Estate.

Things you need to know

  • Don't encode the xml/json if you send it within the body. It won't work (error code 409)
  • "Preis auf Anfrage" is set by entering a "0" in the price field. This is only supported for "Grundstücke" (plots) and all "Gewerbeimmtypen" (commercial real estate types).
  • The tag "contact" is optional. If you don't enter a contact id, we'll take the standard contact address of the realtor.
  • if the address cannot be geocoded by IS24 then you should send the "wgs84Coordinate" (vice versa: should be omitted for geocodable addresses)
  • externalID is optional. If it is not entered, than we'll set the scout object id automatically as externalId.
  • If you use an existing foreignobjectid, you'll get a 409 error message (the foreignobjectid needs to be unique within the real estate objects of a realtor/customer).
  • realEstateProjectId can't be set by the realestate api! Use the RealEstateProject resource to add the realEstates to your project.
  • lastModificationDate is ignored
  • the attribute "marketingType" in the price element and additionalCosts element is optional. Default is rent. If you want to POST an object with marketingType = "buy", then you must change the commercialisationType to "BUY".
  • External id which contains "/" needs to be url encoded
  • "<" and ">" are not allowed

Request

XML:

<?xml version="1.0" encoding="utf-8"?>
<realestates:apartmentRent xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>RestAPI - Immobilienscout24 Testobjekt! +++BITTE+++ NICHT kontaktieren - Wohnung Miete</title>
  <address>
    <street>Heuersdorfer Str</street>
    <houseNumber>26</houseNumber>
    <postcode>04564</postcode>
    <city>Heuersdorf</city>
  </address>
  <showAddress>false</showAddress>
  <baseRent>521.22</baseRent>
  <livingSpace>72</livingSpace>
  <numberOfRooms>3</numberOfRooms>
  <courtage>
    <hasCourtage>YES</hasCourtage>
    <courtage>7,14%</courtage>
  </courtage>
</realestates:apartmentRent>

JSON:

{
  "realestates.apartmentRent":{
    "title":"RestAPI - Immobilienscout24 Testobjekt! +++BITTE+++ NICHT kontaktieren - Wohnung Miete",
    "address":{
      "street":"Andreas Str",
      "houseNumber":"10",
      "postcode":"10243",
      "city":"Berlin",
    },
    "apiSearchData":{
      "searchField1":"search-field-1",
      "searchField2":"search-field-2",
      "searchField3":"search-field-3"
    },
    "realEstateState":"INACTIVE",
    "groupNumber":1618626835,
    "descriptionNote":"description-note",
    "furnishingNote":"furnishing-note",
    "locationNote":"location-note",
    "otherNote":"other-note",
    "attachments":[
      {
        "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/offer\/v1.0\/user\/me\/realestate\/315266813\/attachment"
      }
    ]
    ,
    "showAddress":"false",
    "common.publishChannels":[
    ]
    ,
    "apartmentType":"GROUND_FLOOR",
    "floor":4,
    "lift":"true",
    "energyCertificate":{
      "energyCertificateAvailability":"AVAILABLE",
      "energyCertificateCreationDate":"BEFORE_01_MAY_2014"
    },
    "cellar":"YES",
    "handicappedAccessible":"YES",
    "numberOfParkingSpaces":6968,
    "condition":"NEED_OF_RENOVATION",
    "lastRefurbishment":1239,
    "interiorQuality":"SIMPLE",
    "constructionYear":5875,
    "freeFrom":"Monday",
    "heatingTypeEnev2014":"WOOD_PELLET_HEATING",
    },
    "buildingEnergyRatingType":"ENERGY_REQUIRED",
    "thermalCharacteristic":191.14,
    "energyConsumptionContainsWarmWater":"NOT_APPLICABLE",
    "numberOfFloors":516,
    "usableFloorSpace":25262.89,
    "numberOfBedRooms":48,
    "numberOfBathRooms":26,
    "guestToilet":"YES",
    "parkingSpaceType":"OUTSIDE",
    "baseRent":521.22,
    "totalRent":493.69,
    "serviceCharge":64.11,
    "deposit":"maybe",
    "heatingCosts":7.29,
    "heatingCostsInServiceCharge":"YES",
    "petsAllowed":"YES",
    "parkingSpacePrice":36.56,
    "useAsFlatshareRoom":"YES",
    "livingSpace":849.74,
    "numberOfRooms":8.4,
    "energyPerformanceCertificate":"true",
    "builtInKitchen":"true",
    "balcony":"true",
    "certificateOfEligibilityNeeded":"true",
    "garden":"true",
    "courtage":{
      "hasCourtage":"YES",
      "courtage":"7,14%",
      "courtageNote":"courtage-note"
    }
  }
}

Response

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
    xmlns:xlink="http://www.w3.org/1999/xlink">
    <message>
        <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
        <message>Resource [REALESTATE] with id [123456] has been created.</message>
        <id>123456</id>
    </message>
</common:messages>

JSON:

{
  "common.messages":[
    {
      "message":{
        "messageCode":"MESSAGE_RESOURCE_CREATED",
        "message":"Resource [REALESTATE] with id [123456] has been created."
        "id":62558084
      }
    }
  ]
}