Endpoint Examples
- GETListe l'ensemble des biens d'un établissement
- GETLister les annonces actives
- GETDétails d'un bien
- GETTous les biens vendus
- POSTCréer un bien
- GETSupprimer un bien
- POSTModifier un bien
- POSTAjouter une photo à un bien
- DELSupprimer une photo d'un bien
- POSTModifier une chambre dans un bien
- POSTAffecter un commercial au bien
- DELRetirer un commercial du bien
- GETTracking de vues/partages
- GETCandidatures
- GETVisites
- GETSso
Lister les annonces actives
curl --request GET \
--url https://flatbay.fr/fr/api/search \
--header 'Content-Type: application/json' \
--data '{
"rentsellType": "property.rentsellType.rent",
"page": 0,
"etablissementId": 1,
"search": "Rue de Rivoli",
"distance": 10,
"lat": 48.8257157,
"lng": 2.2935099
}'{
"page": 123,
"nbbypage": 123,
"nb": 123,
"properties": [
"<any>"
]
}Cette route renvoie la liste des annonces qui sont activées sur le site flatbay.fr Elle ne necessite pas d’authentification puisque ces données sont de toute façon publique. ps: Cette page permet d’obtenir les mêmes résultats et donc de se familiariser avec les données https://flatbay.fr/fr/search
La pagination par defaut est à 1000.
Body
Achat / Vente:
property.rentsellType.rent - Location
property.rentsellType.sell - Vente
property.rentsellType.rent, property.rentsellType.sell "property.rentsellType.rent"
Systeme de pagination permettant d'afficher une certaine page
0
Afficher seulement les annonces d'un établissement précis
Veuillez vous rapprocher de nos developpeurs pour connaitre l'id de vos établissements
1
Mot clef permettant de filtrer parmis Adresse / Ville / Code Postal / Id / Numero de lot
"Rue de Rivoli"
Nombre de kilometre, afin de ne voir que les biens suffisamment proches (il est necessaire de fournir la latitude et la longitude pour que ce parametre marche).
10
Permet de spécifier la latitude
48.8257157
Permet de spécifier la longitude
2.2935099
Response
Présente si l'agent n'a pas caché l'adresse
Détails pour les villes avec permis de louer
Ville avec permis de louer
Lettre globale du bilan DPE/GES
A, B, C, D, E, F, G A, B, C, D, E, F, G A, B, C, D, E, F, G Code insee de la ville du bien
Date de vente d'un bien
Total des honoraires finaux de vente pour un bien vendu
Prix de vente final pour un bien vendu
URL pour une prise de visite pour ce bien (absent sur la route des biens vendus)
L'id du document
Le type du document (propertyPrincipal pour la photo principale)
document.type.propertyPrincipal, document.type.property, document.type.propertyPlan URL du document chez Flatbay
Numéro de mandat
Type du mandat
mandat.type.exclusif, mandat.type.semiexclusif, mandat.type.simple Registre du mandat
mandat.registre.location, mandat.registre.gestion, mandat.registre.locationgestion, mandat.registre.vente Statut du mandat
mandat.status.encours, mandat.status.echu, mandat.status.resilie, mandat.status.cloture Date de début du mandat
Date de fin du mandat
Le mandat est t'il clôturé
Date de clôture du mandat
curl --request GET \
--url https://flatbay.fr/fr/api/search \
--header 'Content-Type: application/json' \
--data '{
"rentsellType": "property.rentsellType.rent",
"page": 0,
"etablissementId": 1,
"search": "Rue de Rivoli",
"distance": 10,
"lat": 48.8257157,
"lng": 2.2935099
}'{
"page": 123,
"nbbypage": 123,
"nb": 123,
"properties": [
"<any>"
]
}