Search endpoint for properties

Accepts Search parameters and returns a list of properties. Have a limitation of 50000 records that can be reached.

Filtering for empty/null values on custom fields

To filter for records where a custom field is empty or null, use the following special values:

• __empty__ - Find records where the field is null, not set, or equals an empty string
• __not_empty__ - Find records where the field exists and has a value

Examples

Find properties where custom field "flur_custom_feld" is empty: ?cf_flur_custom_feld=__empty__

Find properties where custom field "notes" has a value: ?cf_notes=__not_empty__

Multilingualism

In Propstack you can set certain texts of an object in several languages. The following fields can be translated:

1. Überschrift (title)
2. Objektbeschreibung (description_note)
3. Lagebeschreibung (location_note)
4. Ausstattung (furnishing_note)
5. Sonstiges (other_note)
6. Käuferprovision (courtage)
7. Provisionshinweis (courtage_note)

To receive the objects in a different language, enter an additional parameter locale. By default, you get the German language. Using locale=en would give you the English texts. It is also possible to obtain several languages. Example: locale=de,en

Further filter options

The following fields can also be filtered via the API using "from-to" information:

• Kaufpreis: price
• Kaltmiete: base_rent
• Warmmiete: total_rent
• Fläche: property_space_value
• Wohnfläche: living_space
• Grundstücksfläche: plot_area
• Zimmer: number_of_rooms
• Schlafzimmer: number_of_bed_rooms
• Badezimmer: number_of_bath_rooms
• Etage: floor
• Baujahr: construction_year

The parameters for this always have a _from or _to appended to determine whether it applies from this value or up to this value. Example:

?price_from=300000&price_to=350000 returns all properties with a price between €300,000 and €350,000. ?plot_area=1500 returns all properties with a plot area of more than 1,500 square metres.

Sorting options

• Auftragsnummer: exposee_id
• Baujahr: construction_year
• Einheitenummer: unit_id.raw
• Etage: floor
• Erstellungsdatum: created_at
• Fläche: property_space_value
• Grundstücksfläche: plot_area
• Kaltmiete: base_rent
• Kaufpreis: price
• Preis: object_price
• Fläche/qm: price_per_sqm
• Status: property_status_position
• Straße: street_number.raw
• Verkaufsdatum: sold_date
• Warmmiete: total_rent
• Zimmer: number_of_rooms
• Zuletzt bearbeitet: updated_at

Possible marketing type (marketing_type):

• BUY
• RENT

Possible supercategory for object types object_type:

• LIVING
• COMMERCIAL
• INVESTMENT

Possible object types rs_type:

• APARTMENT
• HOUSE
• TRADE_SITE
• GARAGE
• SHORT_TERM_ACCOMODATION
• FLAT_SHARE_ROOM
• ASSISTED_LIVING
• SENIOR_CARE
• OFFICE
• GASTRONOMY
• INDUSTRY
• STORE
• SPECIAL_PURPOSE
• INVESTMENT

(Text) fields that can be stored in different languages:

• title
• description_note
• location_note
• furnishing_note
• other_note
• long_description_note
• long_location_note
• long_furnishing_note
• long_other_note
• courtage
• courtage_note

Possible object types rs_category:

• ROOF_STOREY - Dachgeschoss
• LOFT - Loft
• MAISONETTE - Maisonette
• PENTHOUSE - Penthouse
• TERRACED_FLAT - Terrassenwohnung
• GROUND_FLOOR - Erdgeschosswohnung
• APARTMENT - Etagenwohnung
• RAISED_GROUND_FLOOR - Hochparterre
• HALF_BASEMENT - Souterrain
• OTHER - Sonstige
• SINGLE_FAMILY_HOUSE - Einfamilienhaus
• TWO_FAMILY_HOUSE - Zweifamilienhaus
• TERRACE_HOUSE - Reihenhaus
• MID_TERRACE_HOUSE - Reihenmittelhaus
• TERRACE_END_HOUSE - Reihenendhaus
• END_TERRACE_HOUSE - Reiheneckhaus
• MULTI_FAMILY_HOUSE - Mehrfamilienhaus
• TOWNHOUSE - Stadthaus
• FINCA - Finca
• BUNGALOW - Bungalow
• FARMHOUSE - Bauernhaus
• SEMIDETACHED_HOUSE - Doppelhaushälfte
• VILLA - Villa
• CASTLE_MANOR_HOUSE - Burg/Schloss
• SPECIAL_REAL_ESTATE - Besondere Immobilie
• TWIN_SINGLE_FAMILY_HOUSE - Doppeleinfamilienhaus
• GARAGE - Garage
• STREET_PARKING - Außenstellplatz
• CARPORT - Carport
• DUPLEX - Duplex
• CAR_PARK - Parkhaus
• UNDERGROUND_GARAGE - Tiefgarage
• DOUBLE_GARAGE - Doppelgarage
• NO_INFORMATION - Keine Angabe
• STUDIO - Atelier
• OFFICE - Büro
• OFFICE_FLOOR - Büroetage
• OFFICE_BUILDING - Bürohaus
• OFFICE_CENTRE - Bürozentrum
• OFFICE_STORAGE_BUILDING - Büro-/ Lagergebäude
• SURGERY - Praxis
• SURGERY_FLOOR - Praxisetage
• SURGERY_BUILDING - Praxishaus
• COMMERCIAL_CENTRE - Gewerbezentrum
• LIVING_AND_COMMERCIAL_BUILDING - Wohn- und Geschäftsgebäude
• OFFICE_AND_COMMERCIAL_BUILDING - Büro- und Geschäftsgebäude
• BAR_LOUNGE - Barbetrieb/Lounge
• CAFE - Café
• CLUB_DISCO - Club/Diskothek
• GUESTS_HOUSE - Gästehaus
• TAVERN - Gaststätte
• HOTEL - Hotel
• HOTEL_RESIDENCE - Hotelanwesen
• HOTEL_GARNI - Hotel garni
• PENSION - Pension
• RESTAURANT - Restaurant
• SHOWROOM_SPACE - Ausstellungsfläche
• SHOPPING_CENTRE - Einkaufszentrum
• FACTORY_OUTLET - Factory Outlet
• DEPARTMENT_STORE - Kaufhaus
• KIOSK - Kiosk
• STORE - Laden
• SELF_SERVICE_MARKET - SB-Markt
• SALES_AREA - Verkaufsfläche
• SALES_HALL - Verkaufshalle
• RESIDENCE - Anwesen
• FARM - Bauernhof
• HORSE_FARM - Reiterhof
• VINEYARD - Weingut
• REPAIR_SHOP - Werkstatt
• LEISURE_FACILITY - Freizeitanlage
• INDUSTRIAL_AREA - Gewerbefläche
• SPECIAL_ESTATE - Spezialobjekt
• LIVING_BUSINESS_HOUSE - Wohn- und Geschäftshaus
• HOUSING_ESTATE - Wohnanlage
• MICRO_APARTMENTS - Micro-Apartments
• COMMERCIAL_BUILDING - Geschäftshaus
• SHOP_SALES_FLOOR - Laden/Verkaufsfläche
• SUPERMARKET - Supermarkt
• RETAIL_PARK - Fachmarktzentrum
• BOARDING_HOUSE - Boarding House
• CLINIC - Klinik
• ASSISTED_LIVING - Betreutes Wohnen
• HALL_STORAGE - Halle/Logistik
• INDUSTRIAL_PROPERTY - Produktion/Fertigung