POST
/
property
/
create
curl --request POST \
  --url https://flatbay.fr/fr/api/property/create \
  --header 'Content-Type: application/json' \
  --data '{
  "archive": true,
  "offmarket": true,
  "smartlead": true,
  "addresscache": true,
  "addressCacheRadius": 123,
  "notifPublicationProp": true,
  "address": "<string>",
  "cp": "<string>",
  "city": "<string>",
  "country": "France",
  "lng": "<string>",
  "lat": "<string>",
  "type": "property.type.maison",
  "type2": "property.type2.mono",
  "construction": "property.construction.1946",
  "rentsellType": "property.rentsellType.rent",
  "annonceTitle": "<string>",
  "etage": 123,
  "nbEtage": 123,
  "nbPiece": 123,
  "nbRoom": 123,
  "nbDouche": 123,
  "nbDetailDouche": 123,
  "nbDetailBaignoire": 123,
  "nbWc": 123,
  "frais": 123,
  "fraisLocationBailleur": 123,
  "fraisLocationBailleurApplicable": "oui",
  "fraisType": "property.fraisType.vendeur",
  "fraisRoom": 123,
  "surface": 123,
  "eautype": "property.production.collectif",
  "bailType": "property.bailType.collectif",
  "chauffagetype": "property.production.collectif",
  "description": "<string>",
  "honorairesCalcul": "property.honorairesCalcul.percent",
  "percentPrix": 123,
  "percentRemise": 123,
  "prix": 123,
  "loyer": 123,
  "depot": 123,
  "edlHonoraire": 123,
  "edlHonoraireBailleur": 123,
  "charge": 123,
  "energyBillMin": 123,
  "energyBillMax": 123,
  "foncier": 123,
  "meuble": true,
  "gardien": true,
  "video": true,
  "gli": true,
  "plaque": true,
  "four": true,
  "microonde": true,
  "frigo": true,
  "jacuzzi": true,
  "hammam": true,
  "sauna": true,
  "clim": true,
  "travaux": true,
  "ravalementDate": 123,
  "refectionDate": 123,
  "refectionCommuneDate": 123,
  "travauxDesc": "<string>",
  "laveLinge": true,
  "secheLinge": true,
  "laveVaisselle": true,
  "cafetiere": true,
  "tv": true,
  "fibre": true,
  "codeWifi": "<string>",
  "grillePain": true,
  "aspirateur": true,
  "bouilloire": true,
  "hotte": true,
  "vaisselle": true,
  "linge": true,
  "internet": true,
  "chauffage": true,
  "eauchaude": true,
  "eaufroide": true,
  "entretien": true,
  "entretienJardin": true,
  "entretienChaudiere": true,
  "ordures": true,
  "menage": true,
  "risque": true,
  "electricite": true,
  "ascenseur": true,
  "balcon": true,
  "terrasse": true,
  "parking": 123,
  "cave": 123,
  "jardin": true,
  "velo": true,
  "box": 123,
  "piscine": true,
  "sport": true,
  "cinema": true,
  "cheminee": true,
  "tennis": true,
  "barbecue": true,
  "pingpong": true,
  "interphone": true,
  "coloc": true,
  "colocOnly": true,
  "start": "<string>",
  "startRoom": true,
  "embed": "<string>",
  "isEmbed": true,
  "embed2": "<string>",
  "isEmbed2": true,
  "public": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "dbOpen": 123,
  "dbClose": 123,
  "vitrage": "property.vitrage.simple",
  "hauteur": 123,
  "exposition": "property.exposition.nord",
  "traversant": true,
  "diagnostic": "property.diagnostic.need",
  "dpe": 123,
  "dpeAt": "<string>",
  "ges": 123,
  "lot": "<string>",
  "immeubleName": "<string>",
  "periclesId": "<string>",
  "showPhone": true,
  "pinel": true,
  "digicode": "<string>",
  "batiment": "<string>",
  "escalier": "<string>",
  "porte": "<string>",
  "boiteAuxLettres": "<string>",
  "poubelles": "<string>",
  "disjoncteur": "<string>",
  "compteurElec": "<string>",
  "compteurElecId": "<string>",
  "compteurGaz": "<string>",
  "arriveeEau": "<string>",
  "compteurEauChaude": "<string>",
  "compteurEauFroide": "<string>",
  "compteurThermique": "<string>",
  "caveLocation": "<string>",
  "parkingLocation": "<string>",
  "boxLocation": "<string>",
  "commentLocation": "<string>",
  "bailDuration": "property.bailDuration.1to10month",
  "bailRight": 123,
  "terrainUsage": "property.terrainUsage.constructible",
  "terrainViable": true,
  "nbLots": 123,
  "pmr": true,
  "longueur": 123,
  "largeur": 123,
  "sousSol": true,
  "surfaceSousSol": 123,
  "vitrine": true,
  "cuisine": true,
  "encadrement": true,
  "encadrementMinm": 123,
  "encadrementMin": 123,
  "encadrementMaxm": 123,
  "encadrementMax": 123,
  "nbLotsCoproperty": 123,
  "courtProceeding": true,
  "extraction": true,
  "vueExcept": true,
  "vueMer": true,
  "surfaceTerrainBatiInclus": 123,
  "surfaces": [
    {
      "m2": 123,
      "surface": "surface.type.balcon"
    }
  ]
}'
1

il faudra que l’equipe flatbay vous fournisse une clé d’api pour utiliser cette route.

afin de publier une annonce il faut renseigner

  • start c’est “disponible a partir du”
  • public c’est “Programmer la diffusion pour le”

ensuite

  • offmarket, permet de mettre le bien en offmarket
  • ubiflow, seloger, leboncoin, permet de diffuser le bien sur les plateformes correspondantes. (des lors qu’une plateforme est activée, leboncoin ou autre, il faut mettre ubiflow=1)

Query Parameters

apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

Body

application/json
archive
boolean

Est-ce un bien archivé ?

offmarket
boolean

Est-ce un bien Off-market ?

smartlead
boolean

Les Matchs sont les utilisateurs (optin) qui recherchent un bien similaire et/ou dont le projet immobilier correspond aux critères de ce bien. Cette option permet d'envoyer le lien de l'annonce à tous les matchs par mail.

addresscache
boolean

Cacher l'adresse du bien

addressCacheRadius
integer

Rayon à afficher

notifPublicationProp
boolean

Notifier le/les propriétaire(s) de la publication de l'annonce

address
string

Adresse du bien

cp
string

Code postal

city
string

Ville

country
string

Pays

Example:

"France"

lng
string

Longitude

lat
string

Latitude

type
enum<string>

Type du bien

property.type.maison - Maison

property.type.mas - Mas

property.type.villa - Villa

property.type.chateau - Château

property.type.duplex - Duplex

property.type.triplex - Triplex

property.type.appart - Appartement

property.type.studio - Studio

property.type.parking - Place de parking

property.type.box - Box

property.type.immeuble - Immeuble

property.type.terrain - Terrain

property.type.local - Local professionnel

property.type.bureau - Bureau

Available options:
property.type.maison,
property.type.mas,
property.type.villa,
property.type.chateau,
property.type.duplex,
property.type.triplex,
property.type.appart,
property.type.studio,
property.type.parking,
property.type.box,
property.type.immeuble,
property.type.terrain,
property.type.local,
property.type.bureau
type2
enum<string>

Type de propriété

property.type2.mono - Mono-propriété

property.type2.co - Copropriété

Available options:
property.type2.mono,
property.type2.co
construction
enum<string>

Année de construction

property.construction.1946 - Avant 1946

property.construction.1970 - 1946 - 1970

property.construction.1971 - 1971 - 1990

property.construction.1990 - Après 1990

property.construction.neuf - Neuf

Available options:
property.construction.1946,
property.construction.1970,
property.construction.1971,
property.construction.1990,
property.construction.neuf
rentsellType
enum<string>

Projet

property.rentsellType.rent - Location

property.rentsellType.sell - Vente

Available options:
property.rentsellType.rent,
property.rentsellType.sell
annonceTitle
string

Titre de l'annonce

etage
integer

Étage

nbEtage
integer

Batiment de x étages

nbPiece
integer

Nombre de pièce(s)

nbRoom
integer

Nombre de chambre(s)

nbDouche
integer

Nombre de pièce(s)

nbDetailDouche
integer

Nombre de douche(s)

nbDetailBaignoire
integer

Nombre de baignoire(s)

nbWc
integer

Nombre de Wc

frais
number

Honoraire location TTC

fraisLocationBailleur
number

Honoraire bailleur location (€ TTC)

fraisLocationBailleurApplicable
enum<string>

Honoraires applicables ?

Available options:
oui,
non
fraisType
enum<string>

Frais à la charge de :

property.fraisType.vendeur - À la charge du vendeur

property.fraisType.acquereur - À la charge de l'acquéreur

property.fraisType.partage - Partagés entre l'acquéreur et le vendeur

Available options:
property.fraisType.vendeur,
property.fraisType.acquereur,
property.fraisType.partage
fraisRoom
number

Frais d'agence par chambre

surface
number

Surface du bien

eautype
enum<string>

Production eau chaude

property.production.collectif - Collectif

property.production.collectifElectrique - Collectif Electrique

property.production.collectifGaz - Collectif Gaz

property.production.collectifFioul - Collectif Fioul

property.production.collectifPompe - Collectif Pompe à chaleur

property.production.individuelElectrique - Individuel Électrique

property.production.individuelGaz - Individuel Gaz

property.production.individuelFioul - Individuel Fioul

property.production.individuelPompe - Individuel Pompe à chaleur

property.production.chaudiere - Chaudière

property.production.geothermie - Géothermie

property.production.absenceEa - Absence d'eau chaude

Available options:
property.production.collectif,
property.production.collectifElectrique,
property.production.collectifGaz,
property.production.collectifFioul,
property.production.collectifPompe,
property.production.individuelElectrique,
property.production.individuelGaz,
property.production.individuelFioul,
property.production.individuelPompe,
property.production.chaudiere,
property.production.geothermie,
property.production.absenceEau
bailType
enum<string>

Type de bail

property.bailType.collectif - collectif

property.bailType.individuel - individuel

Available options:
property.bailType.collectif,
property.bailType.individuel
chauffagetype
enum<string>

Production chauffage

property.production.collectif - Collectif

property.production.collectifElectrique - Collectif Electrique

property.production.collectifGaz - Collectif Gaz

property.production.collectifFioul - Collectif Fioul

property.production.collectifPompe - Collectif Pompe à chaleur

property.production.individuelElectrique - Individuel Électrique

property.production.individuelGaz - Individuel Gaz

property.production.individuelFioul - Individuel Fioul

property.production.individuelPompe - Individuel Pompe à chaleur

property.production.individuelClim - Individuel Climatisation réversible

property.production.chaudiere - Chaudière

property.production.poele - Poêle à granulés

property.production.bois - Bois

property.production.geothermie - Géothermie

property.production.absenceChauffage - Absence de chauffage

Available options:
property.production.collectif,
property.production.collectifElectrique,
property.production.collectifGaz,
property.production.collectifFioul,
property.production.collectifPompe,
property.production.individuelElectrique,
property.production.individuelGaz,
property.production.individuelFioul,
property.production.individuelPompe,
property.production.individuelClim,
property.production.chaudiere,
property.production.poele,
property.production.bois,
property.production.geothermie,
property.production.absenceChauffage
description
string

Description du bien

honorairesCalcul
enum<string>

Calcul des honoraires

property.honorairesCalcul.percent - Pourcentage du prix de vente

property.honorairesCalcul.forfait - Forfait

Available options:
property.honorairesCalcul.percent,
property.honorairesCalcul.forfait
percentPrix
number

Pourcentage

percentRemise
number

% remise

prix
number

Prix de vente hors frais d'agence

loyer
number

Loyer par mois HC

depot
number

Dépot de garantie

edlHonoraire
number

Honoraires état des lieux TTC

edlHonoraireBailleur
number

Honoraire bailleur état des lieux

charge
number

Charges par mois

energyBillMin
number

Facture d'énergie estimée minimum (€ / an)

energyBillMax
number

Facture d'énergie estimée maximum (€ / an)

foncier
number

Montant de la taxe foncière

meuble
boolean

Bien meublé ?

gardien
boolean

Gardien

video
boolean

Vidéo surveillance

gli
boolean

Cette propriété est soumise à une GLI

plaque
boolean

Plaques de cuissson

four
boolean

Four

microonde
boolean

Micro-ondes

frigo
boolean

Frigo

jacuzzi
boolean

Jacuzzi

hammam
boolean

Hammam

sauna
boolean

Sauna

clim
boolean

Climatisation

travaux
boolean

Travaux à prévoir

ravalementDate
integer

Dernier ravalement

refectionDate
integer

Dernière réfection toiture

refectionCommuneDate
integer

Dernière réfection parties communes

travauxDesc
string

Description des travaux

laveLinge
boolean

Lave-linge

secheLinge
boolean

Seche-linge

laveVaisselle
boolean

Lave-Vaisselle

cafetiere
boolean

Cafetière

tv
boolean

Télévision

fibre
boolean

Fibre optique

codeWifi
string

Code Wifi

grillePain
boolean

Grille-Pain

aspirateur
boolean

Aspirateur

bouilloire
boolean

Bouilloire

hotte
boolean

Hotte aspirante

vaisselle
boolean

Vaisselle

linge
boolean

Linge de maison

internet
boolean

Internet

chauffage
boolean

Chauffage

eauchaude
boolean

Eau chaude

eaufroide
boolean

Eau froide

entretien
boolean

Entretien bâtiment

entretienJardin
boolean

Entretien jardin

entretienChaudiere
boolean

Entretien chaudiere

ordures
boolean

Taxe ordures ménagères

menage
boolean

Ménage

risque
boolean

Assurance risques locatifs

electricite
boolean

Electricité

ascenseur
boolean

Ascenseur

balcon
boolean

Balcon

terrasse
boolean

Terrasse

parking
integer

Nombre de Parking

cave
integer

Nombre de Cave

jardin
boolean

Jardin

velo
boolean

Local à vélo

box
integer

Nombre de box

piscine
boolean

Piscine

sport
boolean

Salle de sport

cinema
boolean

Home cinema

cheminee
boolean

Cheminée

tennis
boolean

Tennis

barbecue
boolean

Barbecue

pingpong
boolean

Ping pong

interphone
boolean

Interphone

coloc
boolean

Colocation possible ?

colocOnly
boolean

Colocation seulement ?

start
string

Disponible à partir du

startRoom
boolean

Renseigner des disponibilités différentes pour chaque chambre ?

embed
string

Lien Matterport / Envisite / Autre

isEmbed
boolean

Lien Matterport / Envisite / Autre renseigé ?

embed2
string

Lien Youtube / Dailymotion / Vimeo / Autre

isEmbed2
boolean

Lien Youtube / Dailymotion / Vimeo / Autre renseigné ?

public
string

Programmer la diffusion pour le

phone
string

Numéro de téléphone

email
string

Email de contact

dbOpen
number

Décibels fenetres OUVERTES

dbClose
number

Décibels fenetres fermées

vitrage
enum<string>

Vitrage

property.vitrage.simple - Simple

property.vitrage.double - Double

Available options:
property.vitrage.simple,
property.vitrage.double
hauteur
number

Hauteur sous plafond

exposition
enum<string>

Exposition (pièce de vie)

property.exposition.nord - Nord

property.exposition.nordEst - Nord-Est

property.exposition.est - Est

property.exposition.sudEst - Sud-Est

property.exposition.sud - Sud

property.exposition.sudOuest - Sud-Ouest

property.exposition.ouest - Ouest

property.exposition.nordOuest - Nord-Ouest

Available options:
property.exposition.nord,
property.exposition.nordEst,
property.exposition.est,
property.exposition.sudEst,
property.exposition.sud,
property.exposition.sudOuest,
property.exposition.ouest,
property.exposition.nordOuest
traversant
boolean

Traversant

diagnostic
enum<string>

Diagnostic de performance énergétique

property.diagnostic.need - Soumis au DPE

property.diagnostic.ongoing - En cours

property.diagnostic.empty - Vierge

property.diagnostic.ko - Non soumis au DPE

Available options:
property.diagnostic.need,
property.diagnostic.ongoing,
property.diagnostic.empty,
property.diagnostic.ko
dpe
integer

Performance énergétique DPE

dpeAt
string

Date de réalisation du dernier DPE

ges
integer

Performance énergétique GES

lot
string

Référence interne

immeubleName
string

Immeuble

periclesId
string

Id externe

showPhone
boolean

Afficher le numéro de téléphone

pinel
boolean

Propriété Pinel/PLS (dispositif fiscal pour les logements achetés neufs)

digicode
string

Digicode(s)

batiment
string

Bâtiment

escalier
string

Escalier

porte
string

Porte

boiteAuxLettres
string

Emplacement boîte aux lettre

poubelles
string

Emplacement local poubelle

disjoncteur
string

Emplacement disjoncteur

compteurElec
string

Emplacement compteur electrique

compteurElecId
string

Identifiant compteur électrique

compteurGaz
string

Emplacement compteur de gaz

arriveeEau
string

Emplacement vanne arrivée d'eau

compteurEauChaude
string

Emplacement compteur d'eau chaude

compteurEauFroide
string

Emplacement compteur d'eau froide

compteurThermique
string

Emplacement compteur thermique

caveLocation
string

Emplacement(s) cave(s)

parkingLocation
string

Emplacement(s) parking(s)

boxLocation
string

Emplacement(s) box

commentLocation
string

Commentaire d'accès

bailDuration
enum<string>

Durée du bail

property.bailDuration.1to10month - 1 à 10 mois

property.bailDuration.9month - 9 mois

property.bailDuration.1year - 1 an

property.bailDuration.2year - 2 ans

property.bailDuration.3year - 3 ans

property.bailDuration.6year - 6 ans

property.bailDuration.9year - 9 ans

Available options:
property.bailDuration.1to10month,
property.bailDuration.9month,
property.bailDuration.1year,
property.bailDuration.2year,
property.bailDuration.3year,
property.bailDuration.6year,
property.bailDuration.9year
bailRight
integer

Droit au bail

terrainUsage
enum<string>

Usage du terrain

property.terrainUsage.constructible - Constructible

property.terrainUsage.agricole - Agricole

Available options:
property.terrainUsage.constructible,
property.terrainUsage.agricole
terrainViable
boolean

Terrain viabilisé

nbLots
integer

Nombre de lots dans la copropriété

pmr
boolean

Adapté PMR

longueur
number

Longueur

largeur
number

Largeur

sousSol
boolean

Sous-sol

surfaceSousSol
number

Surface sous-sol

vitrine
boolean

Le local possède t-il une vitrine ?

cuisine
boolean

Cuisine

encadrement
boolean

Ce bien est-il soumis à l'encadrement des loyers ?

encadrementMinm
number

Loyer de référence au m²

encadrementMin
number

Loyer de référence

encadrementMaxm
number

Loyer de référence majoré au m²

encadrementMax
number

Loyer de référence majoré

nbLotsCoproperty
integer

Nombre de lot en copropriété

courtProceeding
boolean

En cour de procédure

extraction
boolean

Le local possède-t-il une extraction ?

vueExcept
boolean

Vue exceptionelle

vueMer
boolean

Vue mer

surfaceTerrainBatiInclus
number

Surface du terrain (bâti inclus)

surfaces
object[]

Response

200
application/json
Détails de l'établissement récupérés avec succès

Identifiant du bien

Available options:
1,
3,
4,
5,
6,
7,
8,
9,
10
Example:

1