Objekte
Objekte lesen
GET
https://api.propstack.de/v1/units?with_meta=1
Query Parameters
Name | Type | Description |
---|---|---|
order | string | Aufsteigend oder absteigend sortieren. Entweder |
sort_by | string | Feld wonach sortiert werden soll. Siehe unten für mögliche Optionen (Default ist |
status | string | ID des Statuses, in welchem sich das Objekt befinden muss. Mehrere Stati übergibt man kommagetrennt |
group | integer | Merkmal-ID, die das Objekt haben muss. Kommagetrennt, wenn es eines von mehreren Merkmalen haben muss |
q | string | Volltextsuche: Sucht in |
country | string | 2-stelliger ISO Code des Landes, zB |
project_id | integer | nur zu einem bestimmten Projekt die Einheiten |
marketing_type | string | ob Kauf ( |
rs_type | string | siehe unten für mögliche Werte (z.B. |
expand | number | kann jeglichen Wert haben. Wenn Parameter mitgegeben wird, sieht das Objekt zu einem Objekt genau so aus wie wenn man ein einzelnes Objekt aufrufen würde. |
archived | string | wenn |
property_ids | array | Array aus IDs, um nur die Objekte mit bestimmten Propstack-IDs aufzurufen |
include_variants | boolean | Varianten einbeziehen |
Eine Excel-Datei mit allen relevanten Felder eines Objektes, gruppiert nach Objekttyp:
Mehrsprachigkeit
In Propstack kann man bestimmte Texte eines Objektes in mehreren Sprachen einstellen. Folgende Felder können übersetzt werden:
Überschrift (title)
Objektbeschreibung (description_note)
Lagebeschreibung (location_note)
Ausstattung (furnishing_note)
Sonstiges (other_note)
Käuferprovision (courtage)
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. Es ist auch möglich, mehrere Sprachen zu erhalten. Beispiel: locale=de,en
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
):
BUY
RENT
Mögliche Oberkategorie für Objekttypen object_type
:
LIVING
COMMERCIAL
INVESTMENT
Mögliche Objekttypen (rs_type
):
APARTMENT
HOUSE
TRADE_SITE
GARAGE
SHORT_TERM_ACCOMODATION
OFFICE
GASTRONOMY
INDUSTRY
STORE
SPECIAL_PURPOSE
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
- DachgeschossLOFT
- LoftMAISONETTE
- MaisonettePENTHOUSE
- PenthouseTERRACED_FLAT
- TerrassenwohnungGROUND_FLOOR
- ErdgeschosswohnungAPARTMENT
- EtagenwohnungRAISED_GROUND_FLOOR
- HochparterreHALF_BASEMENT
- SouterrainOTHER
- SonstigeSINGLE_FAMILY_HOUSE
- EinfamilienhausTWO_FAMILY_HOUSE
- ZweifamilienhausTERRACE_HOUSE
- ReihenhausMID_TERRACE_HOUSE
- ReihenmittelhausTERRACE_END_HOUSE
- ReihenendhausEND_TERRACE_HOUSE
- ReiheneckhausMULTI_FAMILY_HOUSE
- MehrfamilienhausTOWNHOUSE
- StadthausFINCA
- FincaFREEHOLD_FLAT
- EigentumswohnungBUNGALOW
- BungalowFARMHOUSE
- BauernhausSEMIDETACHED_HOUSE
- DoppelhaushälfteVILLA
- VillaCASTLE_MANOR_HOUSE
- Burg/SchlossSPECIAL_REAL_ESTATE
- Besondere ImmobilieTWIN_SINGLE_FAMILY_HOUSE
- DoppeleinfamilienhausGARAGE
- GarageSTREET_PARKING
- AußenstellplatzCARPORT
- CarportDUPLEX
- DuplexCAR_PARK
- ParkhausUNDERGROUND_GARAGE
- TiefgarageDOUBLE_GARAGE
- DoppelgarageNO_INFORMATION
- Keine AngabeSTUDIO
- AtelierOFFICE
- BüroOFFICE_FLOOR
- BüroetageOFFICE_BUILDING
- BürohausOFFICE_CENTRE
- BürozentrumOFFICE_STORAGE_BUILDING
- Büro-/ LagergebäudeSURGERY
- PraxisSURGERY_FLOOR
- PraxisetageSURGERY_BUILDING
- PraxishausCOMMERCIAL_CENTRE
- GewerbezentrumLIVING_AND_COMMERCIAL_BUILDING
- Wohn- und GeschäftsgebäudeOFFICE_AND_COMMERCIAL_BUILDING
- Büro- und GeschäftsgebäudeBAR_LOUNGE
- Barbetrieb/LoungeCAFE
- CaféCLUB_DISCO
- Club/DiskothekGUESTS_HOUSE
- GästehausTAVERN
- GaststätteHOTEL
- HotelHOTEL_RESIDENCE
- HotelanwesenHOTEL_GARNI
- Hotel garniPENSION
- PensionRESTAURANT
- RestaurantSHOWROOM_SPACE
- AusstellungsflächeSHOPPING_CENTRE
- EinkaufszentrumFACTORY_OUTLET
- Factory OutletDEPARTMENT_STORE
- KaufhausKIOSK
- KioskSTORE
- LadenSELF_SERVICE_MARKET
- SB-MarktSALES_AREA
- VerkaufsflächeSALES_HALL
- VerkaufshalleRESIDENCE
- AnwesenFARM
- BauernhofHORSE_FARM
- ReiterhofVINEYARD
- WeingutREPAIR_SHOP
- WerkstattLEISURE_FACILITY
- FreizeitanlageINDUSTRIAL_AREA
- GewerbeflächeSPECIAL_ESTATE
- SpezialobjektLIVING_BUSINESS_HOUSE
- Wohn- und GeschäftshausHOUSING_ESTATE
- WohnanlageMICRO_APARTMENTS
- Micro-ApartmentsCOMMERCIAL_BUILDING
- GeschäftshausSHOP_SALES_FLOOR
- Laden/VerkaufsflächeSUPERMARKET
- SupermarktRETAIL_PARK
- FachmarktzentrumBOARDING_HOUSE
- Boarding HouseCLINIC
- KlinikASSISTED_LIVING
- Betreutes WohnenHALL_STORAGE
- Halle/LogistikINDUSTRIAL_PROPERTY
- Produktion/Fertigung
Objekt anlegen
POST
https://api.propstack.de/v1/units
Path Parameters
Name | Type | Description |
---|---|---|
property | object | siehe alle möglichen Werte für ein Objekt |
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:
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:
Der Kontakt muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter related_client_id
mitgegeben.
Objekt bearbeiten
PUT
https://api.propstack.de/v1/units/:id
Ein vorhandendes Objekt bearbeiten
Request Body
Name | Type | Description |
---|---|---|
property | object | siehe alle möglichen Werte für ein Objekt |
Objekt löschen
DELETE
https://api.propstack.de/v1/units/:id
Ein vorhandenes Objekt löschen
Objekt lesen
GET
https://api.propstack.de/v1/units/:id?new=1
Objekt-Stati lesen
GET
https://api.propstack.de/v1/property_statuses
Ein Objekt hat in der Regel immer einen Status, z.B. "Verfügbar" oder "Verkauft". Über diesen Endpoint kann man sich alle möglichen Objekt-Stati ziehen, die ein Objekt haben kann.
Last updated