Propstack
Search…
Objekte
get
https://api.propstack.de
/v1/units?with_meta=1
Objekte lesen
Eine Excel-Datei mit allen relevanten Felder eines Objektes, gruppiert nach Objekttyp:
exposee-fields.xlsx
27KB
Binary
Objekt-Felder (für Exposés speziell)

Mehrsprachigkeit

In Propstack kann man bestimmte Texte eines Objektes in mehreren Sprachen einstellen. Folgende Felder können übersetzt werden:
  1. 1.
    Überschrift (title)
  2. 2.
    Objektbeschreibung (description_note)
  3. 3.
    Lagebeschreibung (location_note)
  4. 4.
    Ausstattung (furnishing_note)
  5. 5.
    Sonstiges (other_note)
  6. 6.
    Käuferprovision (courtage)
  7. 7.
    Provisionshinweis (courtage_note)
Um die Objekte in einer anderen Sprache zu erhalten gibt man einen weiteren Parameter locale mit. Standardmäßig erhält man die deutsche Sprache. Über locale=en würde man die englischen Texte erhalten.

Weitere Filtermöglichkeiten

Folgende Felder kann man zusätzlich über die API filtern anhand von "ab-bis" Angaben:
  • 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
Die Parameter dafür haben immer ein _from oder _to angehängt, um zu bestimmen ob es ab diesem Wert gilt oder bis zu diesem Wert. Beispiel:
?price_from=300000&price_to=350000 wirft alle Objekte aus, deren Preis zwischen 300.000 und 350.000 € liegen. ?plot_area=1500 wirft alle Objekte aus, deren Grundstücksfläche über 1.500qm beträgt.

Sortierungsmöglichkeiten

  • 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
Mögliche Vermarktungsart (marketing_type):
  1. 1.
    BUY
  2. 2.
    RENT
Mögliche Oberkategorie für Objekttypen object_type:
  1. 1.
    LIVING
  2. 2.
    COMMERCIAL
  3. 3.
    INVESTMENT
Mögliche Objekttypen (rs_type):
  1. 1.
    APARTMENT
  2. 2.
    HOUSE
  3. 3.
    TRADE_SITE
  4. 4.
    GARAGE
  5. 5.
    SHORT_TERM_ACCOMODATION
  6. 6.
    OFFICE
  7. 7.
    GASTRONOMY
  8. 8.
    INDUSTRY
  9. 9.
    STORE
  10. 10.
    SPECIAL_PURPOSE
  11. 11.
    INVESTMENT
(Text-)Felder, die in verschiedenen Sprachen hinterlegt werden können:
  • title
  • description_note
  • location_note
  • furnishing_note
  • other_note
  • long_description_note
  • long_location_note
  • long_furnishing_note
  • long_other_note
  • courtage
  • courtage_note
Mögliche Objektarten (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
  • FREEHOLD_FLAT - Eigentumswohnung
  • 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
post
https://api.propstack.de/v1
/units
Objekt anlegen

Objekt anlegen mit Eigentümer

Beim Anlegen eines Objektes kann auch gleichzeitig ein Eigentümer mitverknüpft werden. Der Payload dafür sieht wie folgt aus:
{
"property": {
"title": "Nice apartment",
// ...
"relationships_attributes": [{
"internal_name": "owner",
"related_client_id": 123
}]
}
}
Der Eigentümer muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter related_client_id mitgegeben.

Objekt anlegen mit einem verknüpften Kontakt

Beim Anlegen eines Objektes kann auch gleichzeitig ein Kontakt (Partner) mitverknüpft werden. Der Payload dafür sieht wie folgt aus:
{
"property": {
"title": "Nice apartment",
// ...
"relationships_attributes": [{
"internal_name": "partner",
"name": "Käufer",
"related_client_id": 123
}]
}
}
Der Kontakt muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter related_client_id mitgegeben.
put
https://api.propstack.de/v1
/units/:id
Objekt bearbeiten
delete
https://api.propstack.de/v1
/units/:id
Objekt löschen
get
https://api.propstack.de/v1
/units/:id?new=1
Objekt lesen
get
https://api.propstack.de
/v1/property_statuses
Objekt-Stati lesen