Suchprofile

Suchprofile gehören immer zu einem Kontakt und beschreiben die Art der Immobilie, die der Kontakt erwerben möchte.

get
Suchprofile lesen

https://api.propstack.de/v1/saved_queries
Suchprofile lassen sich paginieren über die Parameter page und per. Standardmäßig werden die ersten 25 Suchprofile angezeigt.
Request
Response
Request
Query Parameters
client
optional
number
ID des Kontaktes
Response
200: OK
Cake successfully retrieved.
{
"data": [
{
"id": 1,
"created_at": "2018-01-19T18:51:43.133+01:00",
"updated_at": "2018-12-07T18:34:28.075+01:00",
"broker_id": 2,
"client_id": 3,
"price": null,
"price_to": null,
"base_rent": 1520.496,
"base_rent_to": 1858.384,
"total_rent": 1815.093,
"total_rent_to": 2218.447,
"living_space": 0,
"living_space_to": null,
"number_of_rooms": 2.5,
"number_of_rooms_to": 5,
"property_status_ids": [],
"location_ids": [],
"cities": [
"Berlin",
"Frankfurt"
],
"regions": [],
"marketing_type": "RENT",
"rs_types": [],
"rs_categories": [],
"note": "Sucht sehr dringend",
"number_of_bedrooms": "",
"number_of_bedrooms_to": "",
"floor": "",
"floor_to": "",
"plot_area": "",
"plot_area_to": "",
"total_floor_space": null,
"total_floor_space_to": null,
"construction_year": null,
"construction_year_to": null,
"lift": "",
"balcony": "",
"garden": "",
"built_in_kitchen": "",
"cellar": "",
"rented": "",
"price_per_sqm": null,
"price_per_sqm_to": null,
"net_floor_space": null,
"net_floor_space_to": null,
"price_multiplier": null,
"price_multiplier_to": null,
"yield_actual": null,
"yield_actual_to": null,
"investment_category": null,
"purchase_form": null,
"industrial_area": null,
"industrial_area_to": null,
"tenant_structure": null,
"walt": null,
"single_rooms_quota": null,
"single_rooms_quota_to": null,
"occupancy_rate": null,
"occupancy_rate_to": null,
"monument": null,
"conservation_areas": null,
"condition": null,
"number_of_parking_spaces": null,
"number_of_parking_spaces_to": null,
"short_term_constructible": null,
"recommended_use_types": null,
"site_development_type": null,
"building_permission": null,
"preliminary_enquiry": null
}
]
}

post
Suchprofil erstellen

https://api.propstack.de/v1/saved_queries
Request
Response
Request
Body Parameters
saved_query
required
object
siehe alle möglichen Felder zu einem Suchprofil
Response
201: Created
Es wird die ID des angelegten Suchprofils zurückgegeben
{
"ok": true,
"id": 123
}

put
Suchprofil aktualisieren

https://api.propstack.de/v1/saved_queries/:id
Request
Response
Request
Body Parameters
saved_query
required
object
siehe alle möglichen Felder zu einem Suchprofil
Response
200: OK

delete
Suchprofil löschen

https://api.propstack.de/v1/saved_queries/:id
Request
Response
Request
Response
200: OK
{
"ok": true,
"id": 123,
}

Das Suchprofil Objekt

Attribut

Typ

Beschreibung

client_id

integer

ID des Kontaktes, zu welches das Suchprofil gehört

active

boolean

Soll das Suchprofil für das Matching von Objekten genutzt werden?

cities

string[]

Eine Liste von Städten (einfache Strings, wie Berlin oder München)

regions

string[]

Eine Liste von Regionen/Bundesländern

marketing_type

string

eines von BUY, oder RENT oder leer lassen

rs_types

string[]

eine Liste von Objektypen, siehe hier für alle möglichen Werte

rs_categories

string[]

eine Liste von Objektarten, siehe unten für mögliche Werte

group_ids

integer[]

eine Liste von Objektmerkmalen

note

string

Notizfeld für weitere Anmerkungen

Weitere Felder vom Suchprofil, die für Wohnobjekte interessant sind:

Attribut

Typ

Beschreibung

living_space

float

Mindest(wohn)fläche, die das Objekt haben muss

living_space_to

float

Maximale Fläche, die das Objekt haben kann

price

float

Mindestpreis des Objektes

price_to

float

Maximaler Kaufpreis, welche das Objekt haben kann

number_of_rooms

float

Mindest- Zimmeranzahl

number_of_rooms_to

float

Maximale Anzahl an Zimmer

number_of_bedrooms

float

Mindest-Schlafzimmeranzahl

number_of_bedrooms_to

float

Maximale Anzahl an Schlafzimmer

base_rent

float

Mindestkaltmiete des Objektes

base_rent_to

float

Maximale Kaltmiete des Objektes

floor

integer

Mindest Etage des Objekte (2 => ab 2. Etage)

floor_to

integer

Maximale Etage

plot_area

float

Mindest Grundstücksfläche

plot_area_to

float

Maximale Grundstücksfläche

construction_year

integer

Mindest Baujahr (z.B. 2018)

construction_year_to

integer

Maximales Baujahr

lift

string

Muss einen Fahrstuhl haben? true, false oder einfach leer lassen, wenn es egal ist

balcony

string

Muss ein Balkon haben? s. lift für mögliche Optionen

garden

string

Muss einen Garten haben? s. lift für mögliche Optionen

built_in_kitchen

string

Einbauküche? s. lift für mögliche Optionen

cellar

string

Keller? s. lift für mögliche Optionen

rented

string

Soll das Objekt vermietet sein? s. lift für mögliche Optionen

Anmerkungen

Verfügbare Objektarten (rs_categories):

{
"ROOF_STOREY": "Dachgeschoss",
"LOFT": "Loft",
"MAISONETTE": "Maisonette",
"PENTHOUSE": "Penthouse",
"TERRACED_FLAT": "Terrassenwohnung",
"GROUND_FLOOR": "Erdgeschosswohnung",
"APARTMENT": "Etagenwohnung",
"RAISED_GROUND_FLOOR": "Hochparterre",
"HALF_BASEMENT": "Souterrain",
"ATTIKA": "Attikawohnung",
"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",
"TRADE_SITE": "Grundstück",
"GARAGE": "Garage",
"STREET_PARKING": "Außenstellplatz",
"CARPORT": "Carport",
"DUPLEX": "Duplex",
"CAR_PARK": "Parkhaus",
"UNDERGROUND_GARAGE": "Tiefgarage",
"DOUBLE_GARAGE": "Doppelgarage",
"OFFICE_LOFT": "Loft",
"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äftshaus",
"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",
"COMMERCIAL_UNIT": "Gewerbeeinheit",
"INDUSTRIAL_AREA": "Gewerbefläche",
"SPECIAL_ESTATE": "Spezialobjekt",
"INVEST_FREEHOLD_FLAT": "Eigentumswohnung",
"INVEST_SINGLE_FAMILY_HOUSE": "Einfamilienhaus",
"INVEST_MULTI_FAMILY_HOUSE": "Mehrfamilienhaus",
"INVEST_LIVING_BUSINESS_HOUSE": "Wohn/Geschäftshaus",
"INVEST_HOUSING_ESTATE": "Wohnanlage",
"INVEST_MICRO_APARTMENTS": "Micro-Apartments",
"INVEST_OFFICE_BUILDING": "Bürohaus",
"INVEST_COMMERCIAL_BUILDING": "Geschäftshaus",
"INVEST_OFFICE_AND_COMMERCIAL_BUILDING": "Büro- und Geschäftshaus",
"INVEST_SHOP_SALES_FLOOR": "Laden/Verkaufsfläche",
"INVEST_SUPERMARKET": "Supermarkt",
"INVEST_SHOPPING_CENTRE": "Einkaufszentrum",
"INVEST_RETAIL_PARK": "Fachmarktzentrum",
"INVEST_HOTEL": "Hotel",
"INVEST_BOARDING_HOUSE": "Boarding House",
"INVEST_SURGERY_BUILDING": "Ärztehaus",
"INVEST_CLINIC": "Klinik",
"INVEST_ASSISTED_LIVING": "Betreutes Wohnen",
"INVEST_COMMERCIAL_CENTRE": "Gewerbepark",
"INVEST_HALL_STORAGE": "Halle/Logistik",
"INVEST_INDUSTRIAL_PROPERTY": "Produktion/Fertigung",
"INVEST_CAR_PARK": "Parkhaus"
}