Realties

List and search /objekt/list

Executes a search and returns basic information of matching realties

Parameters

limit

How many elements should be returned in the list. Max 100
Default: 10

offset

Offset of the first element in the list.
Default: 0

culture

Language for i18n fields
Default: de

orderby

Order results by specific field. Supported values are preis, plz, created_at, objektnummer, updated_at or published_at

ordertype

Order direction. Supported values are asc or desc
Default: asc

picturesize

The Picture Size to be used for picture urls. In combination with showDetails=1 it is also possible to request multiple sizes (e.g. picturesize[]=big&picturesize[]=small)

showDetails

Return all details of the realties instead of short summaries: ?showDetails=1

alleProjektObjekte

Show all realties with projects regardless of realty state: ?alleProjektObjekte=1
Default: 0

preciseAreaSearch

Search commercial realties by usable area of the sub realties: ?preciseAreaSearch=1
Default: 0

filter[preis_von]

The min price. Depending on type it is the rent or purchase price.

Example

filter[preis_bis]

The max price. Depending on type it is the rent or purchase price.

filter[price_per_m2_von]

The min price per square meter. Depending on type it is the rent or purchase price.

filter[price_per_m2_bis]

The max price per square meter. Depending on type it is the rent or purchase price.

filter[objektart_id]

The main realty type. Multiple values are supported by using an array notation: ?filter[objektart_id][]=1&filter[objektart_id][]=2

Example

filter[subobjektart_id]

The sub realty type. Multiple values are supported by using an array notation.

Example

filter[tag_name]

The name of the category assigned to real-estates.

Example

filter[plz]

The zip code. Multiple values are supported by using an array notation.

Example

filter[plz_von]

The min zip code. Does not work for non-numerical zip codes.

filter[plz_bis]

The max zip code. Does not work for non-numerical zip codes.

filter[politischer_bezirk_id]

The id of the political district. Only a single value is supported, array notation does not work.

Example

filter[zimmer_von]

The min room count.

Example

filter[zimmer_bis]

The max room count.

filter[objektnummer]

The realty number.

Example

filter[objektnummer_von]

The min realty number.

filter[objektnummer_bis]

The max realty number.

filter[sort_flaeche_von]

The min area in square meters. It refers to the area fields in this order: living area, floor area, surface area and total area.

Example

filter[sort_flaeche_bis]

The max area in square meters. It refers to the area fields in this order: living area, floor area, surface area and total area.

filter[flaeche_von]

The min area in square meters.

filter[flaeche_bis]

The max area in square meters.

filter[wohnflaeche_von]

The min living area in square meters.

filter[wohnflaeche_bis]

The max living area in square meters.

filter[nutzflaeche_von]

The min floor area in square meters.

filter[nutzflaeche_bis]

The max floor area in square meters.

filter[grundflaeche_von]

The min surface area in square meters.

filter[grundflaeche_bis]

The max surface area in square meters.

filter[anzahl_garten_von]

The min number of the gardens

filter[anzahl_garten_bis]

The max number of the gardens

filter[anzahl_balkons_von]

The min number of the balconies.

Example

filter[anzahl_balkons_bis]

The max number of the balconies

filter[anzahl_loggias_von]

The min number of the loggias

filter[anzahl_loggias_bis]

The max number of the loggias

filter[anzahl_terrassen_von]

The min number of the terraces

filter[anzahl_terrassen_bis]

The max number of the terraces

filter[anzahl_keller_von]

The min number of the cellars

Example

filter[anzahl_keller_bis]

The max number of the cellars

filter[anzahl_garagen_von]

The min number of the garages

filter[anzahl_garagen_bis]

The max number of the garages

filter[anzahl_stellplaetze_von]

The min number of the parking spots

filter[anzahl_stellplaetze_bis]

The max number of the parking spots

filter[anzahl_sep_wc_von]

The min number of the toilet rooms

filter[anzahl_sep_wc_bis]

The max number of the toilet rooms

filter[anzahl_badezimmer_von]

The min number of the bathrooms.

Example

filter[anzahl_badezimmer_bis]

The max number of the bathrooms

filter[anzahl_abstellraum_von]

The min number of the storage rooms

filter[anzahl_abstellraum_bis]

The max number of the storage rooms

filter[zustand_id]

filter by condition. The id of the conditions.

Example

filter[objekt_ausstattung_list]

filter by equipments. filter by condition. The id of the features. Multiple values are supported by using an array notation.

Example

filter[barrierefrei]

filter by disability access

Example

filter[stichwort]

Keyword. Must be present in realty title, ZIP, city, street, object number or in internal description.

filter[land_id]

The id of the country. Multiple values are supported by using an array notation.

filter[bundesland_id]

The id of the federal state. Multiple values are supported by using an array notation.

filter[objekt_status_id]

The realty status. Multiple values are supported by using an array notation.

Example

filter[miete]

Set value to 1 to search for realties available for rent.

Example

filter[kauf]

Set value to 1 to search for realties available for purchase.

filter[bauart_id]

filter by old or new buildings. The possible building styles.

Example

filter[owner_id]

Id of the employee responsible for the realty

filter[projekt_id]

Id of the project the realty belongs to

filter[realty_type]

Name of the realty system type the realty belongs to

Example

filter[parent_id]

Id of the parent realty

filter[aktualisiert_am_von]

Updated at from date.

Example

filter[aktualisiert_am_bis]

Updated at to date.

filter[rent_with_purchase_option]

filter for rent realties which have the option enabled

Example

All realties for rent with a max monthly rent price of 2.000€

https://api.justimmo.at/rest/v1/objekt/list?filter[miete]=1&filter[preis_bis]=2000

<?xml version="1.0" encoding="UTF-8"?>
<justimmo>
    <query-result>
        <count>15</count>
    </query-result>
    <immobilie>
        <id>361672</id>
        <objektnummer>17</objektnummer>
        <objektkategorie>
            <nutzungsart WOHNEN="1" GEWERBE="0" ANLAGE="0"/>
            <vermarktungsart KAUF="0" MIETE_PACHT="1"/>
            <objektart>
                <wohnung wohnungtyp="ERDGESCHOSS"/>
            </objektart>
            <user_defined_simplefield feldname="objektart_id">2</user_defined_simplefield>
            <user_defined_simplefield feldname="objektart_name">Wohnung</user_defined_simplefield>
            <user_defined_simplefield feldname="sub_objektart_id">103</user_defined_simplefield>
            <user_defined_simplefield feldname="sub_objektart_name">Erdgeschoß</user_defined_simplefield>
        </objektkategorie>
        <titel>DEMOOBJEKT! Grünruhelage in den Kornkammern Wiens</titel>
        <dreizeiler></dreizeiler>
        <naehe>Donauufer</naehe>
        <objektbeschreibung>&lt;p&gt;DEMOOBJEKT! Bitte nicht anfragen!&lt;/p&gt;&#13;
            &lt;p&gt;Breitenlee: Sonnige 3 Zimmer-Wohnung inmitten der Kornkammern Wiens&lt;br /&gt;&lt;br /&gt;Die
            helle freundliche 3 Zimmer-Wohnung mit Bad (Wanne), eigenem WC, Schrankraum, Wohnküche mit Speiss,
            französichen Fenstern in allen Räumen ist süd-westl. ausgerichtet. Im Mietpreis sind die Kosten für 1
            Garagenplatz enthalten.&lt;br /&gt;5 Minuten mit dem Auto nach Breitenlee, 10 Min. zum großen Donaustädter
            Einkaufspark und in 100 Metern mitten in den Feldern! Die Haltestelle des städt. Autobuses ist vor der Türe!&lt;/p&gt;</objektbeschreibung>
        <anzahl_zimmer>3</anzahl_zimmer>
        <etage>4. Etage</etage>
        <ort>Wien</ort>
        <plz>1220</plz>
        <preis>1752</preis>
        <gesamtmiete>1818</gesamtmiete>
        <mietkauf>0</mietkauf>
        <wohnflaeche>82</wohnflaeche>
        <nutzflaeche>95</nutzflaeche>
        <anzahl_terrassen>1</anzahl_terrassen>
        <terrassen_flaeche>15</terrassen_flaeche>
        <erstes_bild>https://files.justimmo.at/public/pic/small/APRorOYjzZ.jpg</erstes_bild>
        <zweites_bild>https://files.justimmo.at/public/pic/small/APRoFdmnle.jpg</zweites_bild>
        <status>aktiv</status>
        <status_id>5</status_id>
        <erstellt_am>2014-12-03 10:21:03</erstellt_am>
        <aktualisiert_am>2016-03-04 10:44:19</aktualisiert_am>
    </immobilie>
    <!-- ..... -->
</justimmo>

The query-result>count element contains information of total hits of the search regardless of given limit parameter.

Detail /objekt/detail

Returns detailed information of a single realty as xml loosely based on Openimmo 1.2.7. The energy certificate data is documented here.

Parameters

objekt_id

The id of the realty

culture

Language for i18n fields
Default: de

picturesize

The Picture Size to be used for picture urls. Multiple sizes can be requested using array notation (e.g. picturesize[]=big&picturesize[]=small)

Expose /objekt/expose

Returns the content of the expose pdf as a stream

Parameters

objekt_id

The id of the realty

expose

The type of the expose. A list of expose types is available here.
Default: Default

culture

Language
Default: de

Example

Get the default expose for realty 123456 in English language

https://api.justimmo.at/rest/v1/objekt/expose?objekt_id=123456&expose=DefaultNew&culture=en

Inquiry /objekt/anfrage

Create an inquiry. Justimmo will automatically create a contact and assign the inquiry to the employee of the realty. Requests missing a required parameter are rejected with 422.

Parameters

objekt_id

Id of the realty

anrede_id

Salutation of contact

titel

title of contact

vorname

Required. First name of contact

nachname

Required. Last name of contact

suffix

suffix of contact

email

Email adress of contact

tel

Phone number of contact

message

Required. Message of the inquiry

strasse

Street of contact

plz

Zip code of contact

ort

City of contact

land

Country of contact

kategorie

Name of a single marketing category the contact should be assigned to. Matched by name against the marketing-usable categories; a non-matching value is ignored. Example: "Website-Anfrage"

firma

Company of the contact

newsletter[]

An array of newsletter category ids to be assigned to the contact created by this request.

doubleoptin_completed

1 or 0. Whether double opt-in has already been completed externally or not. If not Justimmo will handle double opt-in and send an email to the contact automatically

is_realty_owner

1 or 0. Whether the inquiry comes from a realty owner. If 1, the contact is assigned to the contact category "Owner".

realty_owner_consultation_request

1 or 0. Whether the inquiry comes from a realty owner who wants a consultation from an agent. If 1, the agent will receive an email about this request for a personal consultation.

funding_inquiry *

1 or 0. Whether the inquiry comes with a funding request. If 1, the agent or the selected 3rd party will receive an email about this request for a personal consultation.

* Additional paid service that can be activated in Justimmo.

Example

Create a inquiry for contact “Test Test test@gmail.com”

https://api.justimmo.at/rest/v1/objekt/anfrage?objekt_id=123456&vorname=Test&nachname=Test&email=test%40gmail.com&tel=123456&is_realty_owner=0&realty_owner_consultation_request=0&funding_inquiry=1&message=Ich+interessiere+mich+f%C3%BCr+das+Angebot

The inquiry and contact have been created successfully, if the response code is 200.

Ids /objekt/ids

Returns ids of ALL matching real-estates as JSON. Filters and orderby/ordertype/alleProjektObjekte/preciseAreaSearch from the realty list call apply. limit, offset, picturesize, showDetails and culture have no effect here - the call is not paginated and returns ids only.

Example

All realty ids for rent with a max monthly rent price of 2.000€

https://api.justimmo.at/rest/v1/objekt/ids?filter[miete]=1&filter[preis_bis]=2000

["361672","361671","361670","361668","361667","361666","361665","131924","131923","131922","131921","131920","131919","131917","131915"]