GET Offer

The ressource represents an offer search. This method returns a list of construction financing offers that correspond to the given financing terms query parameters.

Returns a list of resources identified by the following URL. Returns a list of resources identified by the following URL. The GET method of the offer resource is used to retrieve a list of construction financing offers according to the given financing terms query parameters.

Important: The PAngBV (Preisangabenverordnung) requires that you need to provide the following data when displaying an offer: effective and nominal interest rates, monthly rate, remaining debt after fixed interest termination (Ablauf der Sollzinsbindung), number of repayment rates, duration until repayment is complete and the total amount paid. You may only use this API if you display all this data.

 

http://rest.immobilienscout24.de/restapi/api/financing/construction/v2/offer/

Supported media types

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

Authorization requirements

  • At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

Request

Path Parameters

  • none

Query Paramters

required:

  • geocode - GeoCode of the search region
  • postalcode - the usage of geocode is preferred, usage of postalcode leadsto bad quality of the search results 

!!! you have to provide either a geocode or a postalcode

  • additional filter criteria:
  • financingtype - financing type; default: "PROPERTY_PURCHASE"
  • additionalCosts - additional costs; default: 0
  • ownfunds - own funds of the buyer; default: 50000
  • purchaseprice - purchase price of the project; default: 200000
  • remainingDebt - the remaining debt (followup financing); default:100000
  • propertyValue - the value of the property (followup financing) default:200000
  • amortizationrate - amortization rate; default: 2
  • employment - employment of the buyer; default: "EMPLOYED"
  • fixednominalinterestrate - fixed nominal interest rate; default: "TEN_YEARS"

 

There are three possible financingTypes:

  • PROPERTY_PURCHASE (Objektkauf)
  • BUILDING_FINANCING (Neubau)
  • FOLLOWUP_FINANCING (Anschlussfinanzierung)

If you search for followup financings, you need to provide remainingDebt and propertyValue instead of purchasePrice, additionalCosts and ownFunds. 

Possible employments:

  • CIVIL_SERVANT=Beamter
  • EMPLOYED=Angestellt
  • FREELANCER=Freiberufler
  • PENSIONER=Rentner
  • SELFEMPLOYED=Selbstständig
  • UNEMPLOYED=Arbeitssuchend

Response

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.

Header

No special headers.

Body

An offer allways contains a provider and its distance to the search location defined by the geoCode or the postalCode. If interest rates are found then the offer has an amortizationData object. This includes information like the remaining debt after the fixed interest rates termination, the number of monthly rates until the loan is repayed as well as the total repayment. The lastModified field contains the timestamp when the interest rates of the given provider were updated.

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:offers xmlns:ns2="http://www.w3.org/1999/xlink" xmlns:ns3="http://rest.immobilienscout24.de/schema/financing/construction/1.0">
  <offersFound>2</offersFound>
  <offer>
    <amortizationData>
      <effectiveInterestRate>2.51</effectiveInterestRate>
      <nominalInterestRate>2.18</nominalInterestRate>
      <monthlyRate>399</monthlyRate>
      <remainingDebt>143413</remainingDebt>
      <totalAmountPaid>243005</totalAmountPaid>
      <numberOfRates>255</numberOfRates>
      <lastModified>1458031579000</lastModified>
    </amortizationData>
    <mortgageProvider id="111111" ns2:href="http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/provider/111111">
      <name>The financing partner</name>
      <logo id="222222" ns2:href="http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/providerlogo/222222">
        <url>http://www.immobilienscout24.de/baufinanzierung/app/mortgageProvider/222222/1/logo.png</url>
      </logo>
      <numberOfRatings>500</numberOfRatings>
      <averageRating>4.5</averageRating>
      <contactAddressRequired>true</contactAddressRequired>
    </mortgageProvider>
  </offer>
  <offer>
    <amortizationData>
      <effectiveInterestRate>3.51</effectiveInterestRate>
      <nominalInterestRate>3.18</nominalInterestRate>
      <monthlyRate>499</monthlyRate>
      <remainingDebt>145413</remainingDebt>
      <totalAmountPaid>253005</totalAmountPaid>
      <numberOfRates>275</numberOfRates>
      <lastModified>1458031579000</lastModified>
    </amortizationData>
    <mortgageProvider id="333333" ns2:href="http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/provider/333333">
      <name>The next financing partner</name>
      <logo id="444444" ns2:href="http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/providerlogo/444444">
        <url>http://www.immobilienscout24.de/baufinanzierung/app/mortgageProvider/444444/1/logo.png</url>
      </logo>
      <numberOfRatings>900</numberOfRatings>
      <averageRating>4.6</averageRating>
      <contactAddressRequired>false</contactAddressRequired>
      <brand>
        <id>555555</id>
        <name>The brand</name>
      </brand>
    </mortgageProvider>
  </offer>
</ns3:offers>

JSON

{
  "offersFound": 2,
  "offer": [{
    "amortizationData": {
      "effectiveInterestRate": 2.51,
      "nominalInterestRate": 2.18,
      "monthlyRate": 399,
      "remainingDebt": 143413,
      "totalAmountPaid": 243005,
      "numberOfRates": 255,
      "lastModified": 1458031579000
    },
    "mortgageProvider": {
      "id": 111111,
      "href": "http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/provider/111111",
      "name": "The financing partner",
      "logo": {
        "id": 222222,
        "xLink": "http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/providerlogo/222222",
        "url": "http://www.immobilienscout24.de/baufinanzierung/app/mortgageProvider/222222/1/logo.png"
      },
      "numberOfRatings": 500,
      "averageRating": 4.5,
      "contactAddressRequired": true
    }
  }, {
    "amortizationData": {
      "effectiveInterestRate": 3.51,
      "nominalInterestRate": 3.18,
      "monthlyRate": 499,
      "remainingDebt": 145413,
      "totalAmountPaid": 253005,
      "numberOfRates": 275,
      "lastModified": 1458031579000
    },

    "mortgageProvider": {
      "id": 333333,
      "href": "http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/provider/333333",
      "name": "The next financing partner",
      "logo": {
        "id": 444444,
        "xLink": "http://rest.immobilienscout24.de/restapi/api/financing/construction/v1.0/providerlogo/444444",
        "url": "http://www.immobilienscout24.de/baufinanzierung/app/mortgageProvider/444444/1/logo.png"
      },
      "numberOfRatings": 900,
      "averageRating": 4.6,
      "contactAddressRequired": false,
      "brand": {
        "id": 555555,
        "name": "The brand"
      }
    }
  }]
}∫