estateSubType
subtypes to specify the selected estateType in detail
One Ofsubtypes of a house to describe the selected estate type in detail. descriptions for the enums above: - APARTMENT_HOUSE: a building containing multiple apartments
with a common entrance and sometimes services
- BUNGALOW: a house that usually has only one storey, sometimes
with an attic, with a flat or a low-pitched roof - CASTLE: a historical massive and imposing building
usually fortified, built by the nobility, royalty or
by military orders. - MANOR_HOUSE: magnificent country house, often dating from the late middle
ages, in which the landed gentry used to live. - CHALET: a wooden house with a sloping roof and widely
overhanging eaves, common in Switzerland and other Alpine
regions in Europe. - FARMHOUSE: a house attached to a farm, especially the main
house in which the farmer lives. - FINCA: spanish-style country house with a large garden in
rural environment - GARDEN_HOUSE: a small dwelling usually built of wood located
in the garden of a large property or in garden allotments - GITE: a furnished holiday home in France that is available
for rent, especially in a rural environment. - LIVING_AND_COMMERCIAL: a building that contains units for
living and for commercial, eg apartments, shops, offices - MOUNTAIN_HUT: a building located high in the mountains,
usually accessible only by foot. When they are managed, they
provide food and shelter to mountaineers - MULTI_FAMILY_HOUSE: a single building that is set up to
accommodate more than one family living separately. - RESIDENTIAL_COMPLEX: a set of buildings containing multiple apartments
often with common services, shared garden, pool, playground - RUSTICO: originally a cottage or farm building traditionally
built with granite, typical for Ticino in Switzerland - SEMIDETACHED_HOUSE: a house that is joined to another similar
house on one side by a shared wall - SINGLE_FAMILY_HOUSE: a freestanding house, with one dwelling
unit for a person, couple or a family, set alone on its own
parcel of land - SPECIAL_REAL_ESTATE: a special kind of property that can not
be listing by another subtype, eg like a church - TERRACE_HOUSE: row of similar houses joined together
by their side walls; row houses
de: Achtung! entspricht nicht einem Terrassenhaus im Deutschen! - CORNER_TERRACE_HOUSE: is located at the corner or staggered
in a row of terrace houses; one side wall is shared with
another terrace house - END_TERRACE_HOUSE: is located at the end of a row of terrace
houses, one side wall is shared with another terrace house - MID_TERRACE_HOUSE: is located in the middle of a row of
terrace houses, both side walls are shared with another
terrace house each. - TOWN_HOUSE: a tall, narrow house generally having three or
more floors, usually in a row of similar houses which are
connected together, sometimes even by a common sidewall. - VILLA: a prestigious house, that is very spacious and may
include luxurious amenities such as a pool, etc.
Allowed values:APARTMENT_HOUSEBUNGALOWCASTLEMANOR_HOUSECHALETFARMHOUSEFINCAGARDEN_HOUSEGITELIVING_AND_COMMERCIALMULTI_FAMILY_HOUSEMOUNTAIN_HUTRESIDENTIAL_COMPLEXRUSTICOSEMIDETACHED_HOUSESINGLE_FAMILY_HOUSESPECIAL_REAL_ESTATETERRACE_HOUSECORNER_TERRACE_HOUSEEND_TERRACE_HOUSEMID_TERRACE_HOUSETOWN_HOUSEVILLA
>= 1 characters<= 50 characters
Example:SINGLE_FAMILY_HOUSE
distributionType
stringthe distribution type of the property.
- BUY: regular type of property for sale
de: Kauf - RENT: regular type of property for rent
de: Miete - COMPULSORY_AUCTION: auction ordered by the courts
de: Zwangsversteigerung - BUY_AUCTION: bids for the property can be submitted within a
limited time period. The seller can accept, reject or negotiate
the bid. Most important difference to a classic auction: the
highest bid does not necessarily have to win.
de: Bieterverfahren
Allowed values:BUYRENTCOMPULSORY_AUCTIONBUY_AUCTION
>= 1 characters
location
objectgeographical information of the real estate property
postalcode or zip of the property location.
Match pattern:^[a-zA-Z0-9\s-]{3,12}$
>= 3 characters<= 12 characters
Example:22455
city where the property is located.
>= 1 characters<= 128 characters
Example:Hamburg
street where the property is located. It can also be a place name or any required neighbourhood information.
>= 1 characters<= 512 characters
Example:Hauptstrasse
house number where the property is located.
>= 1 characters<= 64 characters
Example:10
An apartment, unit, office, lot, or other secondary unit designator
>= 1 characters<= 64 characters
Example:Block C
numbered/lettered staircase
>= 1 characters<= 64 characters
Example:A
number of the floor in the building; 0 means ground floor, NOT first floor; 1 means first upper floor; -1 means first basement floor
>= -5<= 999
Example:2
numbered/lettered entrance
>= 1 characters<= 32 characters
Example:123
state within the country where the property is located
>= 1 characters<= 128 characters
Example:Bavaria
country where the property is located, using the ISO 3166-1 alpha-3 country code standard.
Allowed values:ABWAFGAGOAIAALAALBANDAREARGARMASMATAATFATGAUSAUTAZEBDIBELBENBESBFABGDBGRBHRBHSBIHBLMBLRBLZBMUBOLBRABRBBRNBTNBVTBWACAFCANCCKCHECHLCHNCIVCMRCODCOGCOKCOLCOMCPVCRICUBCUWCXRCYMCYPCZEDEUDJIDMADNKDOMDZAECUEGYERIESHESPESTETHFINFJIFLKFRAFROFSMGABGBRGEOGGYGHAGIBGINGLPGMBGNBGNQGRCGRDGRLGTMGUFGUMGUYHKGHMDHNDHRVHTIHUNIDNIMNINDIOTIRLIRNIRQISLISRITAJAMJEYJORJPNKAZKENKGZKHMKIRKNAKORKWTLAOLBNLBRLBYLCALIELKALSOLTULUXLVAMACMAFMARMCOMDAMDGMDVMEXMHLMKDMLIMLTMMRMNEMNGMNPMOZMRTMSRMTQMUSMWIMYSMYTNAMNCLNERNFKNGANICNIUNLDNORNPLNRUNZLOMNPAKPANPCNPERPHLPLWPNGPOLPRIPRKPRTPRYPSEPYFQATREUROURUSRWASAUSDNSENSGPSGSSHNSJMSLBSLESLVSMRSOMSPMSRBSSDSTPSURSVKSVNSWESWZSXMSYCSYRTCATCDTGOTHATJKTKLTKMTLSTONTTOTUNTURTUVTWNTZAUGAUKRUMIURYUSAUZBVATVCTVENVGBVIRVNMVUTWLFWSMYEMZAFZMBZWE
>= 3 characters<= 3 characters
Example:DEU
Coordinates of the property using GeoJSON Point format. WGS84 (GPS) System expected. The coordinates array must contain [longitude, latitude] in that order.
Show Child Parameters
may the complete address be visible to everyone who sees the property online? if false, street and houseNumber may not be displayed in any case!
Default:true
Example:true
additional information about the area where the property is located
Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}
Show Child Parameters
prices
objectcontains different prices and price types for a property
the currency of all prices defined below. the currency must be entered as ISO 4217 currency code. Please refer to https://www.iso.org/iso-4217-currency-codes.html Last checked: October 1st, 2021 Here are the alphabetic three-letter country codes: - AED: UAE Dirham - AFN: Afghani - ALL: Lek - AMD: Armenian Dram - ANG: Netherlands Antillean Guilder - AOA: Kwanza - ARS: Argentine Peso - AUD: Australian Dollar - AWG: Aruban Florin - AZN: Azerbaijan Manat - BAM: Convertible Mark - BBD: Barbados Dollar - BDT: Taka - BGN: Bulgarian Lev - BHD: Bahraini Dinar - BIF: Burundi Franc - BMD: Bermudian Dollar - BND: Brunei Dollar - BOB: Boliviano - BOV: Mvdol - BRL: Brazilian Real - BSD: Bahamian Dollar - BTN: Ngultrum - BWP: Pula - BYN: Belarusian Ruble - BZD: Belize Dollar - CAD: Canadian Dollar - CDF: Congolese Franc - CHE: WIR Euro - CHF: Swiss Franc - CHW: WIR Franc - CLF: Unidad de Fomento - CLP: Chilean Peso - CNY: Yuan Renminbi - COP: Colombian Peso - COU: Unidad de Valor Real - CRC: Costa Rican Colon - CUC: Peso Convertible - CUP: Cuban Peso - CVE: Cabo Verde Escudo - CZK: Czech Koruna - DJF: Djibouti Franc - DKK: Danish Krone - DOP: Dominican Peso - DZD: Algerian Dinar - EGP: Egyptian Pound - ERN: Nakfa - ETB: Ethiopian Birr - EUR: Euro - FJD: Fiji Dollar - FKP: Falkland Islands Pound - GBP: Pound Sterling - GEL: Lari - GHS: Ghana Cedi - GIP: Gibraltar Pound - GMD: Dalasi - GNF: Guinean Franc - GTQ: Quetzal - GYD: Guyana Dollar - HKD: Hong Kong Dollar - HNL: Lempira - HRK: Kuna - HTG: Gourde - HUF: Forint - IDR: Rupiah - ILS: New Israeli Sheqel - INR: Indian Rupee - IQD: Iraqi Dinar - IRR: Iranian Rial - ISK: Iceland Krona - JMD: Jamaican Dollar - JOD: Jordanian Dinar - JPY: Yen - KES: Kenyan Shilling - KGS: Som - KHR: Riel - KMF: Comorian Franc - KPW: North Korean Won - KRW: Won - KWD: Kuwaiti Dinar - KYD: Cayman Islands Dollar - KZT: Tenge - LAK: Lao Kip - LBP: Lebanese Pound - LKR: Sri Lanka Rupee - LRD: Liberian Dollar - LSL: Loti - LYD: Libyan Dinar - MAD: Moroccan Dirham - MDL: Moldovan Leu - MGA: Malagasy Ariary - MKD: Denar - MMK: Kyat - MNT: Tugrik - MOP: Pataca - MRU: Ouguiya - MUR: Mauritius Rupee - MVR: Rufiyaa - MWK: Malawi Kwacha - MXN: Mexican Peso - MXV: Mexican Unidad de Inversion (UDI) - MYR: Malaysian Ringgit - MZN: Mozambique Metical - NAD: Namibia Dollar - NGN: Naira - NIO: Cordoba Oro - NOK: Norwegian Krone - NPR: Nepalese Rupee - NZD: New Zealand Dollar - OMR: Rial Omani - PAB: Balboa - PEN: Sol - PGK: Kina - PHP: Philippine Peso - PKR: Pakistan Rupee - PLN: Zloty - PYG: Guarani - QAR: Qatari Rial - RON: Romanian Leu - RSD: Serbian Dinar - RUB: Russian Ruble - RWF: Rwanda Franc - SAR: Saudi Riyal - SBD: Solomon Islands Dollar - SCR: Seychelles Rupee - SDG: Sudanese Pound - SEK: Swedish Krona - SGD: Singapore Dollar - SHP: Saint Helena Pound - SLL: Leone - SOS: Somali Shilling - SRD: Surinam Dollar - SSP: South Sudanese Pound - STN: Dobra - SVC: El Salvador Colon - SYP: Syrian Pound - SZL: Lilangeni - THB: Baht - TJS: Somoni - TMT: Turkmenistan New Manat - TND: Tunisian Dinar - TOP: Pa’anga - TRY: Turkish Lira - TTD: Trinidad and Tobago Dollar - TWD: New Taiwan Dollar - TZS: Tanzanian Shilling - UAH: Hryvnia - UGX: Uganda Shilling - USD: US Dollar - USN: US Dollar (Next day) - UYI: Uruguay Peso en Unidades Indexadas (UI) - UYU: Peso Uruguayo - UYW: Unidad Previsional - UZS: Uzbekistan Sum - VED: Bolívar Soberano - VES: Bolívar Soberano - VND: Dong - VUV: Vatu - WST: Tala - XAF: CFA Franc BEAC - XAG: Silver - XAU: Gold - XBA: Bond Markets Unit European Composite Unit (EURCO) - XBB: Bond Markets Unit European Monetary Unit (E.M.U.-6) - XBC: Bond Markets Unit European Unit of Account 9 (E.U.A.-9) - XBD: Bond Markets Unit European Unit of Account 17 (E.U.A.-17) - XCD: East Caribbean Dollar - XDR: SDR (Special Drawing Right) - XOF: CFA Franc BCEAO - XPD: Palladium - XPF: CFP Franc - XPT: Platinum - XSU: Sucre - XTS: Codes specifically reserved for testing purposes - XUA: ADB Unit of Account - XXX: The codes assigned for transactions where no currency is involved - YER: Yemeni Rial - ZAR: Rand - ZMW: Zambian Kwacha - ZWL: Zimbabwe Dollar
Allowed values:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUYIUYUUYWUZSVEDVESVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWL
Default:EUR
Example:EUR
Show Child Parameters
rent price information
Show Child Parameters
compulsory/foreclosure auction price information.
Show Child Parameters
Bid process. The purchase is voluntarily. The minimum price is set by the offerer. Potential buyers make an offer within a particular period. The offerer decides, if he accepts the highest bid, it is not binding as in a typical auction.
Show Child Parameters
Real estate agency or broker Fee detailed information commission for the real estate agent; de: Maklerprovision fr: Frais d’agence
general setting for displaying the price on the portal/ website
Example:true
textarea for further price information, taxes or fees.
Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}
Show Child Parameters
Show Child Parameters
spaces
objectcontains different space types for a property. you can submit multiple spaces here (e.g. livingSpace, atticSpace and gardenSpace)
measure unit for the space (square meter by default).
Allowed values:SQUARE_METERSQUARE_INCHSQUARE_FOOTSQUARE_YARDHECTAREACRE
Default:SQUARE_METER
building front facade in length measure unit (meter, inch, foot, yard, …) Based on spaces.spaceMeasureUnit, so meters will be used as default if empty.
>= 0<= 99999999
Example:23
space of the kitchen
>= 0<= 99999999
total space of the property
>= 0<= 99999999
space that can be used, after deducting functional areas, stairs, etc. depending on the purpose
>= 0<= 99999999
For a catalog house or a new built house or a program, the biggest property available, built or not yet built. If a property has different units/ spaces, this is the biggest space it has
>= 0<= 99999999
For a catalog house or a new built house or a program, the smallest property available, built or not yet built. If a property has different units/ spaces, this is the smallest space it has
>= 0<= 99999999
space of the plot
>= 0<= 99999999
plot front in length measure unit (meter, inch, foot, yard, …) Based on spaces.spaceMeasureUnit, so meters will be used as default if empty.
>= 0<= 99999999
Example:60
contains all cumulated additional space from outbuilding, extended or misc places.
>= 0<= 99999999
residential / living space types with their value.
Show Child Parameters
commercial space types with their value.