Docs

Objekte

Zuletzt aktualisiert: 2026-10-038 Min. Lesezeit

Drei Objekttypen (kind): property - Verkauf, rental - Miete, complex - Wohnanlage. Lesen ist kostenlos und mit jedem Schlüssel möglich; Erstellen, Ändern und Löschen brauchen den Bereich objects:write und werden ebenfalls nicht berechnet.

Liste

curl "https://developers.grem.capital/api/v1/objects?kind=property&city=Berlin&limit=20" \
  -H "Authorization: Bearer gsk_live_xxx"

GET /objects:

ParameterBeschreibung
kindPflicht: property, rental oder complex; Groß-/Kleinschreibung egal
city, countryFilter mit exakter Übereinstimmung
priceMin, priceMaxPreis in US-Dollar (nach dem normierten Preis)
areaMin, areaMaxFläche, m²
roomsZimmer (Verkauf und Miete); auch Bruchzahlen
type, residentialTypeKategorie - Codes aus den Wörterbüchern (Verkauf und Miete)
pageSeite, ab 1; ein kleinerer Wert gilt als 1
limitpro Seite, Standard 20, 1-50; ein Wert außerhalb wird in den Bereich gesetzt
sortnewest (Standard) oder oldest
scopenur Agenturschlüssel: standardmäßig die Objekte der Agentur; catalog - der öffentliche Katalog

Antwort: data - die Objekte, paginate - currentPage, totalPages, totalCount.

limit und page außerhalb des Bereichs werden in ihn gesetzt, nicht abgelehnt. Andere ungültige Werte eines bekannten Parameters (unbekannter Aufzählungswert, nicht ganzzahliges page, Text statt Zahl) werden mit 400 validation und dem Feldnamen abgelehnt.

Ein Objekt

GET /objects/{kind}/{id} - ein Objekt in derselben Form. Unbekannte ID - 404. Ein Agenturschlüssel kann scope=catalog anhängen, um die öffentliche Ansicht zu erhalten.

Form eines Objekts

FeldBeschreibung
id, kind, name, slugIdentität
statusbei einem fremden Objekt - active oder sold
typeKategorie - Code
price, currencyPreis; die Wohnanlage hat price: { from, to, currency }
constructionYearBaujahr, eine ganze Zahl oder null
addressvollständige Adresse, mit Straße und Koordinaten
nativeAreaUnitdie Einheit, in der das Objekt erfasst wurde (zur Anzeige); Flächen kommen als { "value": 50, "unit": "m2" }
photosFotos: id, isMain, mimetype, variants, ready
processingStatusready, processing oder failed - ob die Fotos fertig sind
promoteddas Objekt wird beworben
authorAgent oder Agentur des Objekts

Kategorien und andere Merkmale sind Codes; übersetzte Bezeichnungen stehen in den Wörterbüchern. Die Wohnanlage hat zusätzlich apartmentPlans (Grundrisse) und progress (Baufortschritt).

ready: false bei einem Foto bedeutet, dass die Varianten mit Wasserzeichen noch erzeugt werden. Zeigen Sie einen Platzhalter und lesen Sie das Objekt später erneut - speichern Sie kein unfertiges Bild im Cache.

Was Sie sehen: jedes Objekt - die öffentliche Karte, wie auf der Website; Ihre Objekte - die vollständige Eigentümeransicht. Niemand erhält die Kontakte des Eigentümers, Verkäuferdaten aus Importen, Moderationsnotizen oder Originale ohne Wasserzeichen.

Erstellen, ändern, löschen

AktionAnfrageAntwort
ErstellenPOST /objects/{kind}201 mit dem Objekt
ÄndernPUT /objects/{kind}/{id}das Objekt; nur der Eigentümer, sonst 404
LöschenDELETE /objects/{kind}/{id}ein Entwurf wird endgültig gelöscht, ein veröffentlichtes Objekt archiviert; ein Objekt mit laufendem Provisionsvertrag - 409 conflict
curl -X POST https://developers.grem.capital/api/v1/objects/property \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 9a1d2c3b-4e5f-4a6b-8c7d-0e1f2a3b4c5d" \
  -d '{
    "name": "2-Zimmer-Wohnung, Torstraße 12",
    "type": "Residential",
    "address": { "country": "Germany", "city": "Berlin", "street": "Torstraße", "streetNumber": "12" },
    "price": 320000, "currency": "EUR",
    "spaceAll": 64, "rooms": 2, "floor": 3, "buildingFloor": 5,
    "photos": ["https://example.com/1.jpg"],
    "publish": false
  }'
  • publish: false (Standard) - ein Entwurf, nicht im Katalog; publish: true - veröffentlicht. Zum Veröffentlichen braucht property und rental mindestens 1 Foto, complex 2.
  • Nicht jede Kontorolle darf jeden Typ anlegen - wie im Kabinett.
  • Unbekannte Felder werden ignoriert. Kategoriecodes entnehmen Sie den Wörterbüchern. Die Codes von condition, conditionType und amenities (in camelCase, etwa needsRenovation, fridge) stehen im Schreibschema selbst (die Tabellen unten und /openapi.json) - GET /dictionaries übersetzt sie nicht.
  • Flächen: eine Zahl in m² oder { "value": 700, "unit": "ft2" }.
  • PUT ohne photos behält die vorhandenen Fotos.
  • Idempotency-Key beim Erstellen verhindert ein Duplikat bei Wiederholung.

Fotos

photos ist ein Array; jedes Element ist:

  • eine öffentliche Adresse https://... - GREM lädt das Bild selbst herunter;
  • die ID einer mit POST /uploads hochgeladenen Datei (Dateien).

Eine Adresse, die sich nicht herunterladen lässt, wird übersprungen und in warnings der Antwort gemeldet. Mit strictPhotos: true schlägt eine solche Anfrage stattdessen mit 422 fehl.

Felder für Verkauf

Pflicht: name, type, address, price.

FeldBeschreibung
typeResidential, Commercial, Industrial oder Land plot
residentialType, commercialType, industrialTypeUntertyp - ein Code oder ein Array von Codes
marketSegmentprimary (Neubau) oder secondary
descriptionBeschreibung, bis 5000 Zeichen
addresscountry, city (Pflicht), district, region, street, streetNumber, postalCode, location
price, currencyPreis; Währung UAH, USD, EUR, AZN, GBP, AED, CNY, TRY, GEL
constructionYearJahr, 1700 bis 2100
spaceAll, spaceLiving, spaceKitchen, effectiveArea, auxiliaryArea, landPlotAreaFlächen
rooms, bedrooms, numberOfBathrooms, balconies, numberWindows, unitsCountAnzahlen
floor, buildingFloor, ceilingHeightEtage, Geschosse, Deckenhöhe
conditionneedsRenovation, partialRenovation, renovated, designer, shellCore, newFromDeveloper
buildingTypenewBuilding, secondary, stalinka, khrushchevka, brezhnevka, czech, gostinka, prerevolutionary, townhouseRow, detached, other
wallMaterialType, constructionTech, kitchenTypeWandmaterial, Bautechnik, Küchentyp
amenities, buildingAmenitiesAusstattung der Einheit und des Gebäudes - Arrays von Codes
utilitySystem, heating, windowView, balcony, parkingVersorgung, Heizung, Aussicht, Balkon, Parken
safetyshelterNearby, powerBackup, autonomousHeating, waterReserve, starlink, gasAvailable, internetAvailable, elevatorWorks (ja/nein)
accessibilityramp, groundLevelEntrance, wideDoors, disabledParking, wheelchairElevator (ja/nein)
programseOselya, eVidnovlennya, mortgageEligible, installment
monthRentalRate, annualIncome, annualYield, paybackPeriod, propertyTax, insuranceCost, managementFee, repairsReserveInvestitionskennzahlen
commissionProvision für Agenten: payer, type, value
tour3D-Tour: kind, url
complexIddie Wohnanlage, zu der die Einheit gehört
photos, videoMedien
publish, strictPhotossiehe oben

Felder für Miete

Pflicht: name, type (Residential, Commercial, Industrial), address, price. Die meisten Felder sind wie beim Verkauf; mietspezifisch:

FeldBeschreibung
rentalTypelong - langfristig, short - tageweise
price, dayPrice, depositMiete, Tagespreis, Kaution
totalArea, totalFloors, bathroomsFläche, Geschosse, Bäder
minRentTime, minTermMonthsMindestdauer
availableFromverfügbar ab
checkIn, checkOutCheck-in- und Check-out-Zeit: from, to — Stunde des Tages (15 = 15:00 Uhr)
withChildren, withPetsKinder erlaubt; Haustiere: yes, no, with someone
furniture, furnitureListMöbel
conditionTypeZustand - dieselben Werte wie condition beim Verkauf
onsiteAmenities, internalFeatureAusstattung
utilitiesIncluded, utilitiesCostNebenkosten
checkInPay, onlinePay, bankTransfer, reportingDocumentsZahlungswege und Belege

Felder für Wohnanlagen

Pflicht: name, address.

FeldBeschreibung
description, descriptionPresentation, descriptionSocialBeschreibungen
pricefrom, to, currency
spaceFlächen der Einheiten: from, to
apartTypeTypen der Einheiten
classeconomy, comfort, comfortPlus, business, premium, elite
stageplanning, excavation, construction, finishing, commissioned, delivered
completionQuarterFertigstellungsquartal
queuesBauabschnitte: name, stage, completionQuarter
sectionsNumber, floors, apartmentsNumber, parkingSpacesAnzahlen
installment, installmentTermsRatenzahlung: downPaymentPct, termMonths, interestRate
infrastructureInfrastruktur - ein Array von Codes
territoryDescription, parkingDescription, infrastructureDescriptionBeschreibungen
apartmentPlansGrundrisse: apartType, area, price, description, photos
progressBaufortschritt: title, date, description, photos

Das vollständige Schema jedes Typs mit allen Werten - Komponenten ObjectWriteProperty, ObjectWriteRental, ObjectWriteComplex in /openapi.json. Sie werden aus denselben Prüfungen erzeugt, die der Server ausführt.

Agenturschlüssel

AnfrageWas sie tut
PATCH /objects/{kind}/{id}/agencyein Objekt in die Agentur verschieben oder zurück ins Persönliche: Body {"targetAgencyId": "<id>"} oder {"targetAgencyId": null}; ohne das Feld - in die Agentur des Schlüssels
PATCH /objects/{kind}/{id}/assigneeeinen Agenten zuweisen: {"assignTo": "<user id>"}

Mit einem persönlichen Schlüssel antworten beide mit 403. Ein Objekt kann nicht direkt von einer Agentur in eine andere wechseln (409 conflict) - zuerst ins Persönliche verschieben. Einen Agenten einem persönlichen Objekt zuzuweisen oder jemanden, der kein aktives Mitglied der Agentur ist, ergibt ebenfalls 409 conflict. Rechte: in die Agentur - der Autor des Objekts; zurück ins Persönliche - ein Manager, der Agenturinhaber oder der Autor; beliebige Zuweisung - ab Manager, ein Agent - nur sich selbst.

Ereignisse

object.created, object.updated, object.published, object.deleted - siehe Webhooks.

Verwandte Artikel

War dieser Artikel hilfreich?