a Java client library for the REST-Webservice of ImmobilienScout24.de
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

OpenEstate-IS24-REST 0.4

OpenEstate-IS24-REST is a client library for the REST-Webservice of ImmobilienScout24.de written in Java. This library is used within OpenEstate-ImmoTool and in some of our clients projects in order to import / export their real estates to ImmobilienScout24.de.

Features

  • authentication through OAuth
  • read and write XML according to the specifications of the Webservice
  • low level functions to call Import/Export API and Geo Information Service API
  • high level functions for the export of multiple real estates (including contacts, attachments and streaming videos)
  • create real estates randomly
  • example web application for the OAuth verification process

Components

The library is splitted into different components:

How to use

Download the latest release from GitHub. The provided archive contains all required files (compiled libraries, dependencies, source code and documentations).

Alternatively you can integrate the library from Maven Central Repository into your Maven project. Just add one or more of the following dependencies to your projects pom.xml (according to your requirements):

<dependency>
  <groupId>org.openestate.is24</groupId>
  <artifactId>OpenEstate-IS24-REST</artifactId>
  <version>0.4</version>
</dependency>

<dependency>
  <groupId>org.openestate.is24</groupId>
  <artifactId>OpenEstate-IS24-REST-hc42</artifactId>
  <version>0.4</version>
</dependency>

<dependency>
  <groupId>org.openestate.is24</groupId>
  <artifactId>OpenEstate-IS24-REST-hc43</artifactId>
  <version>0.4</version>
</dependency>

You can find further informations in the project wiki or in the docs subfolder.

Requirements

Dependencies

Limitations

The use of the Webservice may be limited by ImmobilienScout24 to a maximal number of operations per day. Contact service@immobilienscout24.de if the limit is too low for your use case.

XML schemas

XML specifications for the different webservices are available at:

Changelog

Take a look at CHANGELOG.md for the full changelog.

License

This library is licensed under the terms of Apache License, Version 2.0. Take a look at LICENSE.txt for the license text.

Todo

Further informations