Biens

Trois types de biens (kind) : property - à vendre, rental - à louer, complex - résidence (programme immobilier). La lecture est gratuite et ouverte à toute clé ; la création, la modification et la suppression demandent le scope objects:write et ne sont pas facturées non plus.

Liste

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

GET /objects :

Réponse : data - les biens, paginate - currentPage, totalPages, totalCount.

limit et page hors plage sont ramenés dans la plage, pas refusés. Les autres valeurs invalides d'un paramètre connu (une valeur d'enum inconnue, un page non entier, du texte au lieu d'un nombre) sont refusées avec 400 validation qui nomme le champ.

Un bien

GET /objects/{kind}/{id} - un bien, dans le même format. Identifiant inconnu - 404. Une clé d'agence peut ajouter scope=catalog pour obtenir la vue publique.

Format d'un bien

Les catégories et les autres attributs sont des codes ; leurs libellés traduits se trouvent dans les dictionnaires. Une résidence a aussi apartmentPlans (plans des logements) et progress (avancement des travaux).

Ce que vous voyez : pour n'importe quel bien, la fiche publique, comme sur le site ; pour vos biens, la vue complète du propriétaire. Personne ne reçoit les coordonnées du propriétaire, les données du vendeur issues des imports, les notes de modération ni les originaux sans filigrane.

Créer, modifier, supprimer

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-room flat, 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 (par défaut) - un brouillon, absent du catalogue ; publish: true - publié. La publication demande au moins 1 photo pour property et rental, 2 pour complex.
• Tous les rôles de compte ne peuvent pas créer tous les types de biens - comme dans l'espace personnel.
• Les champs inconnus sont ignorés. Prenez les codes de catégorie dans les dictionnaires. Les codes de condition, conditionType et amenities (en camelCase, comme needsRenovation, fridge) sont listés dans le schéma d'écriture lui-même (les tableaux ci-dessous et /openapi.json) - GET /dictionaries ne les décode pas.
• Surfaces : un nombre en m² ou { "value": 700, "unit": "ft2" }.
• Un PUT sans photos conserve les photos existantes.
• Idempotency-Key à la création évite un doublon en cas de nouvelle tentative.

Photos

photos est un tableau ; chaque élément est :

• une adresse publique https://... - GREM télécharge l'image lui-même ;
• l'identifiant d'un fichier envoyé avec POST /uploads (Fichiers).

Une adresse impossible à télécharger est ignorée et signalée dans les warnings de la réponse. Avec strictPhotos: true, une telle requête échoue avec 422 à la place.

Champs d'un bien à vendre

Obligatoires : name, type, address, price.

Champs d'un bien à louer

Obligatoires : name, type (Residential, Commercial, Industrial), address, price. La plupart des champs sont les mêmes que pour un bien à vendre ; les champs propres à la location :

Champs d'une résidence

Obligatoires : name, address.

Le schéma complet de chaque type avec toutes les valeurs : composants ObjectWriteProperty, ObjectWriteRental, ObjectWriteComplex dans /openapi.json. Ils sont générés à partir des mêmes contrôles que ceux exécutés par le serveur.

Clé d'agence

Avec une clé personnelle, les deux répondent 403. Un bien ne peut pas passer directement d'une agence à une autre (409 conflict) - ramenez-le d'abord en personnel. Attribuer un agent à un bien personnel, ou à quelqu'un qui n'est pas membre actif de l'agence, donne aussi 409 conflict. Droits : vers l'agence - l'auteur du bien ; retour en personnel - un manager, le propriétaire de l'agence ou l'auteur ; attribuer n'importe qui - manager et au-dessus, un agent - uniquement lui-même.

Événements

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

Voir aussi

• Dictionnaires - codes des catégories et des attributs.
• Fichiers - envoi de photos.
• Supports pour les biens - page d'atterrissage et PDF d'un bien.