Authentification
Prérequis :
- Pour utiliser cette API, vous devez nous contacter à contact@immosquare.com. Après vérification, nous vous fournirons
apiKey et apiToken à inclure dans les headers de vos requêtes.
# POST
POST /path
Content-Type: application/json
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx
# GET
GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx
Codes HTTP
Nous utilisons des codes conventionnels de réponse HTTP pour indiquer le succès ou l'échec des requêtes.
💚 Succès (2xx)
| HTTP Statut |
Description |
| 200 - OK |
Succès de la requête |
🚫 Erreurs client (4xx)
| HTTP Statut |
Description |
| 400 - Bad Request |
Paramètres manquants ou invalides |
| 401 - Unauthorized |
API Key/token invalide |
| 402 - Request Failed |
Requête valide mais échec du traitement |
| 404 - Not Found |
Endpoint inexistant |
| 429 - Too Many Requests |
Quota de requêtes dépassé |
🔧 Erreurs serveur (5xx)
| HTTP Statut |
Description |
| 500, 502, 503, 504 - Server Errors |
Erreur technique interne |
Introduction
Afin d'optimiser les temps de chargement, les listes de propriétés ne renvoient maintenant qu'un set de datas minimum, pour obtenir le détail complet du bien, vous devrez appeler la route de récupération d'une propriété. La route de récupération d'une propriété n'est désormais plus limitée aux biens de l'agence, par contre si l'agence n'a pas le droit de récupérer ce bien vous obtiendrez une erreur.
Fonctionnement des photos/documents mlsconnect
Une photo (ou un document au sens large) a toujours la même url, si l’image de la photo est modifiée elle recevra une nouvelle url et un nouvel id, l’ancienne URL et son id sont supprimés.
Cela signifie que vous devez vous baser sur l'URL pour le ficher global ou l'id pour l'api pour déterminer si une photo est à télécharger ou pas.
Il faut savoir également que dans l’API, si l’updated_at a été modifié, seuls les attributs de la photo tel que le nom ou sa catégorie a été modifiée et non l’image en elle même, il ne faut pas retélécharger la photo, uniquement mettre à jour les attributs.
A NE PAS FAIRE :
Fichier global: si URL de la photo (ou du document) est identique à celle que vous avez, il ne faut pas faire de call (ni HEAD, ni GET) sur l'url de la photo qui aboutit au téléchargement du document sur les CDN et à une facturation de consommation de bande passante (les call HEAD sont comptabilisés de la même manière que les GET)
Api: updated_at a été modifié, cela veut dire que le nom a changé ou un autre attribut, l'image en elle même n'a pas été modifiée, il ne faut pas faire de call (ni HEAD, ni GET) sur l'url de la photo qui aboutit au téléchargement du document sur les CDN et à une facturation de consommation de bande passante (les call HEAD sont comptabilisés de la même manière que les GET)
Propriétés
Recherche
Cette route vous permet d'obtenir des propriétés selon des critères de recherche
Endpoint
GET https://app.mls-connect.com/fr/api/v3/properties/search
Query Parameters
| Parameter |
Type |
Description |
| agency |
string |
Id sécurisé de l'agence, liste séparée par une virgule. Inclut les biens en copropriété |
| agency! |
string |
Exclure les biens d'une ou plusieurs agences (ids séparés par une virgule) |
agency_active |
boolean |
Si agence active |
| adjoining |
string |
Type de mitoyenneté, liste séparée par une virgule. Voir Type de mitoyenneté
|
| adjoining! |
string |
Exclure des types de mitoyenneté (mêmes valeurs que adjoining) |
| amenity |
string |
Liste séparée par une virgule (logique ET entre les valeurs): {parking, single_storey, urgent_sale, balcony, terrace, cellar, attic, garden, alarm, interphone, digicode, air_conditioning, fireplace, elevator, last_floor, garage, handicapped_access, new_program, investor_program, possibility_of_liberal_profession, pool, tennis} |
| app |
string |
Id sécurisé de l'application, liste séparée par une virgule |
| app! |
string |
Exclure les biens d'une ou plusieurs applications (ids séparés par une virgule) |
area_balcony_terrace |
integer |
Surface balcon ou terrasse supérieure à (m²) |
area_from |
integer |
Surface habitable minimum (m²) |
area_garden |
integer |
Surface jardin supérieure à (m²) |
area_land |
integer |
Surface terrain supérieure à (m²) |
area_living_room |
integer |
Surface séjour supérieure à (m²) |
area_to |
integer |
Surface habitable maximum (m²) |
area_unit |
string |
Unité de surface personnalisée (ex: sqft). Si renseigné, les filtres area_from/area_to s'appliquent sur la surface convertie dans cette unité |
back_to_sale_date_at_gte |
date |
Date de remise en vente supérieure ou égale à (YYYY-MM-DD) |
back_to_sale_date_at_lte |
date |
Date de remise en vente inférieure ou égale à (YYYY-MM-DD) |
| bathrooms |
string |
Liste séparée par une virgule de nombre de salles de bain, ex: 1,2,3 |
| bedrooms |
string |
Liste séparée par une virgule de nombre de chambres, ex: 1,2,3,4,5 |
bedrooms_from |
integer |
Nombre de chambres supérieur à |
| bounds |
string |
Recherche par rectangle géographique. Format: sw_lat,sw_lng,ne_lat,ne_lng (coin sud-ouest puis coin nord-est). Ex: 43.0,-7.0,44.0,-6.0
|
| building |
string |
Id sécurisé de l'immeuble, liste séparée par une virgule |
| building! |
string |
Exclure des immeubles (ids séparés par une virgule) |
building_name |
string |
Recherche par nom d'immeuble (recherche partielle) |
| circle |
string |
Recherche circulaire. Format: longitude,latitude,rayon. Le rayon peut être en km (5km) ou m (500m). Peut aussi être un nom de rue pour recherche d'adresse dans un rayon de 10km. Ex: 7.272547,43.71769,20m ou 2.3522,48.8566,Avenue Champs Elysees
|
| condition |
string |
Etat du bien, liste séparée par une virgule. Voir Type état
|
| condition! |
string |
Exclure des états de bien (mêmes valeurs que condition) |
| country |
string |
Liste séparée par une virgule de codes pays ISO (fr, be, etc.) |
| country! |
string |
Exclure des pays (mêmes codes ISO) |
created_at_gt |
datetime |
Date de création supérieure à |
created_at_gte |
datetime |
Date de création supérieure ou égale à |
created_at_lt |
datetime |
Date de création inférieure à |
created_at_lte |
datetime |
Date de création inférieure ou égale à |
| currency |
string |
Code devise ISO (eur, usd, gbp, etc.). Si renseigné, les prix sont convertis dans cette devise et les filtres price_from/price_to s'appliquent sur le prix converti |
dpe_letter |
string |
Lettre du DPE, liste séparée par une virgule: {A, B, C, D, E, F, G} |
| exposition |
string |
Exposition du bien, liste séparée par une virgule. Voir Type exposition
|
| exposition! |
string |
Exclure des expositions (mêmes valeurs que exposition) |
| floor |
integer |
Etage supérieur ou égal à |
| furnished |
boolean |
Meublé |
ges_letter |
string |
Lettre du GES, liste séparée par une virgule: {A, B, C, D, E, F, G} |
| id |
string |
Ids de propriétés, liste séparée par une virgule |
| id! |
string |
Exclure des propriétés par id (liste séparée par une virgule) |
is_life_lease |
boolean |
Viager |
is_mls |
boolean |
Propriété MLS |
is_on_portal |
boolean |
Affichable sur un portail |
is_private |
boolean |
Propriété privée |
is_sold_rent |
boolean |
Vendu loué |
| keywords |
string |
Mots clés recherchés sur: référence, ville, quartier, type de bien, prix, titre |
last_price_decrease_at_gte |
date |
Date de dernière baisse de prix supérieure ou égale à (YYYY-MM-DD) |
last_price_decrease_at_lte |
date |
Date de dernière baisse de prix inférieure ou égale à (YYYY-MM-DD) |
| level |
integer |
Etage ou niveau supérieur ou égal à |
| location |
string |
Recherche par localisation hiérarchique. Voir la section Paramètre location ci-dessous pour le format détaillé |
| mandate |
string |
Type de mandat, liste séparée par une virgule. Voir Type de mandat
|
| mandate! |
string |
Exclure des types de mandat (mêmes valeurs que mandate) |
mandate_end_date_at_gt |
date |
Date de fin de mandat supérieure à (YYYY-MM-DD) |
mandate_end_date_at_gte |
date |
Date de fin de mandat supérieure ou égale à (YYYY-MM-DD) |
mandate_end_date_at_lt |
date |
Date de fin de mandat inférieure à (YYYY-MM-DD) |
mandate_end_date_at_lte |
date |
Date de fin de mandat inférieure ou égale à (YYYY-MM-DD) |
mls_board |
string |
Id du MLS, liste séparée par une virgule. Note: pour avoir toutes les options du MLS prises en compte dans votre demande, nous vous recommandons de le passer dans chacune de vos requêtes |
mls_board! |
string |
Exclure des MLS boards (ids séparés par une virgule) |
offline_at_gte |
date |
Date de mise hors ligne supérieure ou égale à (YYYY-MM-DD) |
offline_at_lte |
date |
Date de mise hors ligne inférieure ou égale à (YYYY-MM-DD) |
online_at_gte |
date |
Date de publication supérieure ou égale à (YYYY-MM-DD) |
online_at_lte |
date |
Date de publication inférieure ou égale à (YYYY-MM-DD) |
optical_fiber |
string |
Fibre optique, liste séparée par une virgule des slugs disponibles |
optical_fiber! |
string |
Exclure des types de fibre optique |
| order |
string |
Ordre du tri: {desc, asc} |
| page |
integer |
Numéro de la page |
parking_garage |
integer |
Nombre de stationnements supérieur ou égal à |
per_page |
integer |
Nombre de résultats par page (défaut 30) |
| polygon |
string |
Recherche par polygone géographique (paires longitude,latitude) ou par cercle (3 valeurs: longitude,latitude,rayon_en_km). Voir la section Recherche géographique
|
price_by_area_from |
integer |
Prix au mètre carré supérieur à |
price_by_area_to |
integer |
Prix au mètre carré inférieur à |
price_from |
integer |
Prix supérieur à |
price_to |
integer |
Prix inférieur à |
property_subtype |
string |
Sous type de bien, liste séparée par une virgule. Voir Sous type de propriété
|
property_subtype! |
string |
Exclure des sous types de bien (mêmes valeurs que property_subtype) |
property_type |
string |
Type de bien, liste séparée par une virgule. Voir Type de propriété
|
property_type! |
string |
Exclure des types de bien (mêmes valeurs que property_type) |
| reference |
string |
Référence du bien, liste séparée par une virgule (recherche partielle) |
| rooms |
string |
Liste séparée par une virgule de nombre de pièces, ex: 1,2,3,4,5 |
rooms_from |
integer |
Nombre de pièces supérieur ou égal à |
sales_agreement_date_at_gte |
date |
Date de compromis supérieure ou égale à (YYYY-MM-DD) |
sales_agreement_date_at_lte |
date |
Date de compromis inférieure ou égale à (YYYY-MM-DD) |
saved_search_id |
string |
Id sécurisé d'une recherche sauvegardée. Applique les propriétés correspondant à cette recherche comme filtre (droits supplémentaires requis) |
| showerrooms |
string |
Liste séparée par une virgule de nombre de salles d'eau, ex: 1,2 |
sold_date_at_gte |
date |
Date de vente supérieure ou égale à (YYYY-MM-DD) |
sold_date_at_lte |
date |
Date de vente inférieure ou égale à (YYYY-MM-DD) |
| sort |
string |
Tri par: {online_at, price, level, area, rooms, locality, mandate_start_date_at, parking_garage, agency, area_terrace, dpe_letter, updated_at, offline_at, area_carrez, bedrooms, last_price_decrease_at} |
transaction_type |
string |
Type de transaction, liste séparée par une virgule. Voir Type de transaction. Note: draft, estimate et validation sont des statuts internes visibles uniquement par l'agence propriétaire du bien |
transaction_type! |
string |
Exclure des types de transaction (mêmes valeurs que transaction_type) |
updated_at_gt |
datetime |
Date de mise à jour supérieure à |
updated_at_gte |
datetime |
Date de mise à jour supérieure ou égale à |
updated_at_lt |
datetime |
Date de mise à jour inférieure à |
updated_at_lte |
datetime |
Date de mise à jour inférieure ou égale à |
| user |
string |
Id sécurisé de l'utilisateur, liste séparée par une virgule. Inclut les biens en copropriété |
| user! |
string |
Exclure les biens d'un ou plusieurs utilisateurs (ids séparés par une virgule) |
user_active |
boolean |
Si utilisateur actif |
| view |
string |
Type de vue, liste séparée par une virgule. Voir Type vue
|
| view! |
string |
Exclure des types de vue (mêmes valeurs que view) |
withdrawal_type |
string |
Type de retrait, liste séparée par une virgule des slugs disponibles (ex: mandate-withdrawal) |
Paramètre location
Le paramètre location permet de filtrer les propriétés par localisation géographique hiérarchique (pays, région, département, ville, quartier). C'est le paramètre recommandé pour les recherches par zone administrative.
Format
Le format encode la hiérarchie géographique en concaténant une lettre de préfixe suivie de l'ID, séparés par des underscores :
| Préfixe |
Niveau |
Exemple |
c |
Pays (country) |
c1 |
o |
Région (area_level_1) |
o12 |
t |
Département (area_level_2) |
t6 |
l |
Ville (locality) |
l543 |
s |
Quartier (sublocality) |
s120 |
Les IDs correspondent aux identifiants retournés par les routes
Locations (pays, régions, départements, villes, quartiers).
Syntaxe
# Une localisation unique
location=c{country_id}_o{area_level_1_id}_l{locality_id}
# Plusieurs IDs au même niveau (séparés par des tirets = logique OU)
location=c1_l543-544
# Plusieurs localisations (séparées par des virgules = logique OU)
location=c1_l543,c1_l544
Exemples
# Toutes les propriétés en France (country id = 1)
location=c1
# Propriétés en Provence-Alpes-Côte d'Azur (area_level_1 id = 12)
location=c1_o12
# Propriétés à Nice (locality id = 543)
location=c1_l543
# Propriétés à Nice OU Cannes (locality ids 543 et 210)
location=c1_l543-210
# Propriétés dans les Alpes-Maritimes (area_level_2 id = 6)
location=c1_t6
# Propriétés dans le quartier Chambrun à Nice (sublocality id = 120)
location=c1_l543_s120
# Plusieurs localisations distinctes : Nice OU Paris
location=c1_l543,c1_l1234
Récupération des IDs
Pour construire le paramètre
location, vous devez d'abord récupérer les IDs via les routes de la section
Locations :
-
Pays :
GET /fr/api/v3/locations/countries → récupérer id
-
Régions :
GET /fr/api/v3/locations/administrative_area_level1?country=1 → récupérer administrative_area_level1.id
-
Départements :
GET /fr/api/v3/locations/administrative_area_level2?country=1 → récupérer administrative_area_level2.id
-
Villes :
GET /fr/api/v3/locations/localities?country=1 → récupérer locality.id
-
Quartiers :
GET /fr/api/v3/locations/sublocalities?country=1&locality=543 → récupérer sublocality.id
Note : Pour les grandes villes françaises avec arrondissements (Paris, Lyon, Marseille), rechercher la ville principale inclut automatiquement tous les arrondissements.
Recherche géographique (bounds, circle, polygon)
Les paramètres bounds, circle et polygon permettent une recherche par zone géographique dessinée sur une carte. Ces paramètres peuvent être combinés avec location pour affiner la recherche.
bounds
Rectangle géographique défini par deux coins (sud-ouest et nord-est).
# Format : sw_lat,sw_lng,ne_lat,ne_lng
bounds=43.68,7.19,43.76,7.30
circle
Recherche circulaire autour d'un point. Le rayon peut être exprimé en kilomètres ou en mètres.
# Rayon en mètres
circle=7.272547,43.71769,20m
# Rayon en kilomètres
circle=7.272547,43.71769,5km
# Recherche par nom de rue (rayon automatique de 10km)
circle=2.3522,48.8566,Avenue Champs Elysees
polygon
Deux usages possibles :
Polygone : série de paires longitude,latitude. Le polygone est fermé automatiquement (pas besoin de répéter le premier point).
polygon=7.472159,43.770355,7.471648,43.756619,7.494524,43.755913,7.503698,43.770266,7.483309,43.780109
Cercle (3 valeurs) : longitude,latitude,rayon_en_km. Raccourci pour une recherche circulaire via le paramètre polygon.
polygon=7.272547,43.71769,5
Réponse
{
"took": 2,
"pagination": {
"total": 31,
"current_page": 1,
"previous_page": null,
"next_page": 2,
"last_page": 2,
"length": 30,
"offset": 0,
"from": 1,
"to": 30,
"formatted": "1-30 sur 31"
},
"results": [
{
"id": "y34R6b",
"reference": "FR342016",
"mandate_number": "",
"is_external": false,
"ref_from_import": "",
"is_on_portal": true,
"is_mls": false,
"is_private": true,
"mls_board": {
"id": "Yv68Wm"
},
"building": {
"id": "W340gO",
"name": "VERNEUIL",
"number_of_floors": 4
},
"estimate": {
"id": null,
"active": false,
"status": 0
},
"agency": {
"id": "oPKYy0",
"name": "immosquare",
"active": true,
"blocked_by_mls": false,
"mls_status": true
},
"user": {
"id": "Mg890k",
"name": "Agent immosquare",
"active": true
},
"price": 990.0,
"price_by_area": 15.71,
"fees": 12004.3,
"fee_type": {
"slug": "acquereur",
"fr": "Acquéreur",
"en": "Acquéreur",
"es": "Acquéreur",
"it": "Acquéreur",
"nl": null,
"pt": null,
"de": null,
"ru": null
},
"sold_price": 990.0,
"currency": "eur",
"currency_sym": "€",
"price_formatted": {
"fr": "990 €/mois",
"en": "€990/month"
},
"dates_formatted": {
"mandate_end_date_at": {
"fr": "04/09/17",
"en": "04/09/17"
},
"mandate_start_date_at": {
"fr": "05/09/16",
"en": "05/09/16"
},
"sold_date_at": {
"fr": "12/08/19",
"en": "12/08/19"
},
"sales_agreement_date_at": {
"fr": "05/09/16",
"en": "05/09/16"
},
"last_price_decrease_at": {
"fr": null,
"en": null
}
},
"cover_url": "https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"assets": [
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg"
],
"area": 63,
"area_carrez": 63,
"area_unit": "m2",
"area_land": 0.0,
"area_garden": 0.0,
"area_living_room": 0.0,
"area_terrace": 0.0,
"area_balcony": 0.0,
"area_formatted": "63 m<sup>2</sup>",
"created_at": "2016-09-05T15:43:51.740+02:00",
"updated_at": "2021-12-14T12:05:19.495+01:00",
"online": true,
"online_at": "2021-09-27T11:49:52.000+02:00",
"offline_at": "2025-01-20T15:08:10.127831+01:00",
"offline_reason": {
"slug": "removed-by-gateway",
"fr": "Bien retiré de la passerelle",
"en": "Removed by gateway"
},
"mandate_end_date_at": "2017-09-04",
"mandate_start_date_at": "2016-09-05",
"back_to_sale_date_at": null,
"sold_date_at": "2019-08-12",
"sales_agreement_date_at": "2016-09-05",
"last_price_decrease_at": null,
"ongoing_offer_number": 0,
"level": null,
"floor": 3,
"parking_garage": null,
"balcony_number": 1,
"terrace_number": null,
"rooms": 3,
"bedrooms": 0,
"bathrooms": 0,
"urgent_sale": false,
"house_name": "",
"address": "2 Impasse des Noisetiers 06100 NICE",
"address_short": "2 Impasse des Noisetiers",
"address_allowed_to_display": true,
"zipcode": "06100",
"amenties": [
"balcony",
"cellar",
"elevator"
],
"condition": null,
"view": null,
"exposition": null,
"adjoining": null,
"optical_fiber": null,
"last_floor": false,
"is_life_lease": false,
"is_sold_rent": false,
"furnished": false,
"dpe_setuped": true,
"energy_reference_letter": null,
"consumption_reference_letter": null,
"country_detail": {
"fr": {
"dpe": {
"dpe_letter": "D",
"dpe_value": 164.0,
"ges_letter": "E",
"ges_value": 38.0,
"dpe_no_subject_to": false,
"date_start": "2024-08-12"
}
},
"be": null,
"it": null
},
"country": {
"iso_code": "fr",
"slug": "france",
"name": "France"
},
"area_level_1": {
"iso_code": "PAC",
"slug": "provence-alpes-cote-d-azur",
"name": "Provence-Alpes-Côte D'azur"
},
"area_level_2": {
"iso_code": "06",
"slug": "alpes-maritimes",
"name": "Alpes-Maritimes"
},
"locality": {
"slug": "nice",
"name": "Nice"
},
"sublocality": {
"slug": "chambrun",
"name": "Chambrun"
},
"geocodable_type": "precise",
"geocodable": true,
"location_geohash": "spv0tr3xp",
"location": {
"lat": 43.7227,
"lon": 7.26433
},
"geocodable_false": true,
"location_geohash_false": "spv0tr9h6",
"location_false": {
"lat": 43.7236,
"lon": 7.26343
},
"transaction_type": {
"slug": "rent",
"fr": "Loué",
"en": "Rent"
},
"property_type": {
"slug": "appartment",
"fr": "Appartement",
"en": "Appartment"
},
"property_subtype": {
"slug": null,
"fr": null,
"en": null
},
"property_status": {
"slug": "active",
"fr": "Actif",
"en": "Active"
},
"mandate": {
"slug": "exclusive",
"fr": "Exclusif",
"en": "Exclusive"
},
"title": {
"fr": "<span class=\"fw-semibold\">Appartement</span> 3 pièces 63.0 m2 - <span class=\"fw-semibold\">990 €/mois</span> - Loué ",
"en": "<span class=\"fw-semibold\">Appartment</span> 3 rooms 63.0 m2 - <span class=\"fw-semibold\">€990/month</span> - Rent "
},
"description": {
"fr": "Nice Nord : 3 Pièces de 63 m², calme et lumineux situé impasse des Noisetiers. Ce bien est composé d'un salon, de deux chambres, d'une cuisine séparée, d'une salle de bain, WC indépendant et balcons. Il comporte une cave et un parking en sous sol.",
"en": ""
},
"description_short": {
"fr": "Nice Nord : 3 Pièces de 63 m², calme et lumineux situé impasse des Noisetiers.",
"en": null
}
}
]
}Paramétres de la réponse
| Node |
Type |
Nullable |
Description |
| id |
string |
Non |
ID du bien |
| reference |
string |
Non |
Référence du bien |
| mandate_number |
string |
Oui |
Numéro de mandat du bien |
| is_external |
bool |
Oui |
Si le bien est externe |
ref_from_import |
string |
Oui |
Référence de la source d'import |
is_on_portal |
boolean |
Oui |
Affichable sur un portail |
is_mls |
boolean |
Oui |
Propriété MLS |
is_private |
boolean |
Oui |
Propriété privée |
| cover_url |
string |
Oui |
Lien de l'image de couverture |
| assets |
array |
Oui |
Tableau clé / valeurs de string contenant les url d'images du bien |
| area |
integer |
Oui |
Surface du bien |
| area_carrez |
integer |
Oui |
Surface du bien loi Carrez |
| area_unit |
string |
Oui |
Unité utilisé pour la surface du bien |
| area_land |
integer |
Oui |
Surface du terrain du bien |
| area_garden |
integer |
Oui |
Surface du jardin du bien |
area_living_room |
integer |
Oui |
Surface du salon |
| area_terrace |
integer |
Oui |
Surface de la terrasse |
| area_balcony |
integer |
Oui |
Surface du balcon |
| area_formatted |
integer |
Oui |
Surface formaté avec l'unité |
| created_at |
string |
Oui |
Date de création du bien |
| updated_at |
string |
Oui |
Date de dernière modification du bien |
| online_at |
string |
Oui |
Date de mise en ligne du bien |
mandate_end_date_at |
string |
Oui |
Date de fin du mandat du bien AAAA-MM-JJ
|
back_to_sale_date_at |
string |
Oui |
Date du retour à la vente du bien AAAA-MM-JJ
|
back_to_sale_date_at |
string |
Oui |
Date du retour à la vente du bien AAAA-MM-JJ
|
sold_date_at |
string |
Oui |
Date de vente du bien AAAA-MM-JJ
|
sales_agreement_date_at |
string |
Oui |
Date de l'accord de vente du bien AAAA-MM-JJ
|
last_price_decrease_at |
integer |
Oui |
Dernier prix en décroissance formatée du bien AAAA-MM-JJ
|
| level |
float |
Oui |
Nombre de niveau du bien |
| floor |
float |
Oui |
Numéro de l'étage où se situe le bien |
| parking_garage |
integer |
Oui |
1 pour parking, 2 pour garage, 3 pour les deux |
| balcony_number |
integer |
Oui |
Nombre de balcons du bien |
| terrace_number |
integer |
Oui |
Nombre de terrasses du bien |
| rooms |
integer |
Oui |
Nombre de pièces du bien |
| bedrooms |
integer |
Oui |
Nombre de chambres du bien |
| bathrooms |
integer |
Oui |
Nombre de salle de bains du bien |
| urgent_sale |
bool |
Oui |
S'il y a une vente urgente |
| house_name |
string |
Oui |
Nom de la maison |
| address |
string |
Oui |
Adresse postale de la propriété |
| address_short |
string |
Oui |
Adresse de la propriété raccourcis |
address_allowed_to_display |
boolean |
Oui |
Autorisé à afficher l'adresse |
| zipcode |
string |
Oui |
Téléphone mobile du négociateur |
| amenties |
string |
Oui |
Tableau clé / valeurs de string contenant les aménagements de l'appartement |
| exposition |
string |
Oui |
Exposition |
| view |
string |
Oui |
Vue |
| adjoining_building |
string |
Oui |
Mitoyenneté |
| optical_fiber |
string |
Oui |
Fibre optique |
| last_floor |
bool |
Oui |
Si bien en dernier étage |
is_life_lease |
bool |
Oui |
Si le bien est en viager |
is_sold_rent |
bool |
Oui |
Si vendu loué |
| furnished |
bool |
Oui |
Si meublé |
| dpe_setuped |
bool |
Non |
Si diagnostic de performance énergétique |
| dpe_letter |
string |
Oui |
Lettre du diagnostic de performance énergétique |
| ges_letter |
string |
Oui |
Lettre émission Gaz à Effet de Serre du bien |
| country_detail |
|
|
|
| fr |
string |
Non |
Dpe pour la france |
| dpe_letter |
string |
Non |
Lettre du diagnostic de performance énergétique |
| dpe_value |
flaot |
Non |
Valeur du diagnostic de performance énergétique |
| ges_letter |
string |
Non |
Lettre émission Gaz à Effet de Serre du bien |
| ges_value |
float |
Non |
Valeur émission Gaz à Effet de Serre du bien |
dpe_no_subject_to |
boolean |
Oui |
Soumis au dpe |
| date_start |
date |
Non |
Date de réalisation du dpe |
| be |
string |
Non |
Dpe pour la Belgique |
| it |
string |
Non |
Dpe pour l'Italie |
| geocodable_type |
string |
Oui |
Type du geocodable |
| geocodable |
bool |
Oui |
Si geocodable |
| location_geohash |
string |
Oui |
Hash du geocodable |
| geocodable_false |
bool |
Oui |
Si geocodable false |
location_geohash_false |
bool |
Oui |
Hash du geocodable false |
| mls_board |
|
|
|
| id |
string |
Non |
ID du board MLS |
| building |
|
|
|
| id |
string |
Oui |
ID de l'immeuble |
| name |
string |
Oui |
Nom de l'immeuble |
number_of_floors |
integer |
Oui |
Nombre d'étages de l'immeuble |
| estimate |
|
|
|
| id |
string |
Oui |
ID de l'estimation |
| active |
bool |
Oui |
Si l'estimation est actif |
| status |
integer |
Oui |
Statut de l'estimation : 1 pour convertie, 0 pour non convertie |
| agency |
|
|
|
| id |
string |
Non |
ID de l'agence |
| name |
string |
Oui |
Nom de l'agence |
| active |
bool |
Non |
Si l'agence est actif |
| user |
|
|
|
| id |
string |
Non |
ID de l'utilisateur |
| name |
string |
Oui |
Nom de l'agence |
| active |
bool |
Non |
Si l'utilisateur est actif |
| general |
|
|
|
| price |
integer |
Non |
Prix HAI ou Loyer CC |
price_by_area |
float |
Oui |
Prix de la surface en m2 |
| sold_price |
integer |
Oui |
Prix de la mensualité |
| currency |
string |
Non |
Devise utilisée |
| currency_sym |
string |
Non |
Symbole de la devise utilisée |
| fees |
float |
Oui |
Honoraires totaux |
| fee_type |
|
|
|
| slug |
string |
Oui |
Slug du type d'honoraire |
| fr |
string |
Non |
Nom français du type d'honoraire |
| en |
string |
Non |
Nom anglais du type d'honoraire |
| price_formatted |
ui |
|
|
| fr |
string |
Non |
Prix de la mensualité formatée pour le français |
| en |
string |
Non |
Prix de la mensualité formatée pour l'anglais |
| dates_formatted |
|
|
|
mandate_end_date_at |
node |
Oui |
Date de fin de mandat formatée dans un champ correspondant aux langues disponibles dans l'application |
mandate_start_date_at |
node |
Oui |
Date de début de mandat formatée dans un champ aux langues disponibles dans l'application |
sold_date_at |
node |
Oui |
Date de vente formatée dans un champ aux langues disponibles dans l'application |
sales_agreement_date_at |
node |
Oui |
Date de l'accord de vente formatée dans un champ aux langues disponibles dans l'application |
last_price_decrease_at |
node |
Oui |
Dernier prix en décroissance formatée dans un champ aux langues disponibles dans l'application |
| sublocality |
|
|
|
| id |
integer |
Oui |
ID du quartier |
| slug |
string |
Oui |
Slug du quartier |
| name |
string |
Oui |
Nom du quartier |
| locality |
Oui |
|
|
| id |
integer |
Non |
ID de la ville |
| slug |
string |
Non |
Slug de la ville |
| name |
string |
Non |
Nom de la ville |
| area_level_2 |
|
|
|
| id |
integer |
Non |
ID du département |
| slug |
string |
Non |
Slug du département |
| name |
string |
Non |
Nom du département |
| area_level_1 |
|
|
|
| id |
integer |
Non |
ID de la région |
| slug |
string |
Non |
Slug de la région |
| name |
string |
Non |
Nom de la région |
| country |
|
|
|
| id |
integer |
Non |
ID du pays |
| slug |
string |
Non |
Slug du pays |
| name |
slug |
Non |
Nom du pays |
| location |
|
|
|
| lat |
float |
Non |
Position en latitude du bien |
| long |
float |
Non |
Position en longitude du bien |
| transaction_type |
|
|
|
| slug |
string |
Non |
Slug de la transaction |
| fr |
string |
Non |
Nom français de la transaction |
| en |
string |
Non |
Nom anglais de la transaction |
| property_type |
|
|
|
| slug |
string |
Non |
Slug du type de la propriété |
| fr |
string |
Non |
Nom français du type de la propriété |
| en |
string |
Non |
Nom anglais du type de la propriété |
| property_subtype |
|
|
|
| slug |
string |
Oui |
Slug du type de la sous propriété |
| fr |
string |
Oui |
Nom français du type de la sous propriété |
| en |
string |
Oui |
Nom anglais du type de la sous propriété |
| property_status |
|
|
|
| slug |
string |
Non |
Slug du statut de la sous propriété |
| fr |
string |
Non |
Nom français du statut de la sous propriété |
| en |
string |
Non |
Nom anglais du statut de la sous propriété |
| mandate |
|
|
|
| slug |
string |
Non |
Slug du mandat de la sous propriété |
| fr |
string |
Non |
Nom français du mandat de la sous propriété |
| en |
string |
Non |
Nom anglais du mandat de la sous propriété |
| title |
|
|
|
| fr |
string |
Oui |
Titre du bien traduit en français |
| en |
string |
Oui |
Titre du bien traduit en anglais |
| descriptions |
|
|
|
| fr |
string |
Oui |
Description traduite en français |
| en |
string |
Oui |
Description traduite en anglais |
| descriptions_short |
|
|
|
| fr |
string |
Oui |
Description courte traduite en français |
| en |
string |
Oui |
Description courte traduite en anglais |
Détail
Cette route vous permet d'obtenir les informations complètes d'une propriété
Endpoint
GET https://app.mls-connect.com/fr/api/v3/properties/search/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de la propriété |
Réponse
{
"id": "b1eMQv",
"uid": null,
"reference": "MLS236053",
"online_at": "2023-11-28T17:15:08.000+01:00",
"created_at": "2024-06-04T13:32:02.840+02:00",
"updated_at": "2024-06-04T13:32:02.840+02:00",
"offline_at": null,
"is_on_portal": true,
"is_mls": false,
"is_private": true,
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
},
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387XXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
}
},
"user": {
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Someone",
"last_name": "XXXXX",
"full_name": "Someone XXXXX",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "xxx@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406+02:00",
"updated_at": "2024-06-18T11:34:30.089+02:00"
},
"mandate": {
"cadastre": "",
"number": "1345",
"co_ownership": true,
"lot_number": "100",
"lot_number_secondary": "S100, A985, P789",
"start_date": "2023-11-28",
"end_date": "2024-11-28",
"effect_date": "2023-11-28",
"urgency_sale": true,
"slug": "exclusive",
"name": {
"fr": "Exclusif",
"en": "Exclusive",
"es": "En Exclusiva",
"it": "Esclusivo",
"nl": "Exclusief",
"pt": null,
"de": null
}
},
"property_type": {
"slug": "house",
"name": {
"fr": "Maison",
"en": "House",
"es": "Chalet",
"it": "Casa",
"nl": "Huis",
"pt": null,
"de": null
},
"sub_type": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"transaction_type": {
"slug": "under-offer",
"name": {
"fr": "Sous offre",
"en": "Under offer",
"es": "En venta",
"it": "In vendita",
"nl": "Onder voorstellen",
"pt": null,
"de": null
}
},
"transaction_status": {
"slug": "for-sale",
"name": {
"fr": "A vendre",
"en": "For sale",
"es": "En venta",
"it": "In vendita",
"nl": "Te koop",
"pt": "",
"de": "",
"ru": ""
},
"sub_status": {
"end_market_date": null,
"offer_accepted_date": null,
"compromise_date": null,
"sold_or_rent_date": null,
"withdrawal_date": null,
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"lease": {
"is_sold_with_tenant": true,
"availability_date": "2024-03-21",
"slug": "professional",
"name": {
"fr": "Professionnel",
"en": "Professional",
"es": "Profesional",
"it": "Professionista",
"nl": "Professioneel",
"pt": null,
"de": null
}
},
"life_lease": {
"is_life_lease": false,
"venal_value": null,
"life_annuity": null,
"life_lease_type": {
"slug": "free",
"name": {
"fr": "Viager libre ",
"fr-BE": "Viager libre ",
"fr-CA": "Viager libre ",
"en": "Free ",
"es": "Viager libre ",
"es-LA": "Viager libre ",
"it": "Viager libre ",
"nl": "Viager vrij",
"pt": "Viager libre ",
"pt-BR": "Viager libre ",
"de": "Viager libre ",
"ru": "Viager libre "
}
}
},
"pictures": [
{
"url": "https://xxxx.com/name.jpg",
"name": "name.jpg",
"order": 1,
"allowed_to_display": true
},
{
"url": "https://xxxx.com/name.png",
"name": "name.jpg",
"order": 2,
"allowed_to_display": true
}
],
"documents": [
{
"id": "x5zjX8",
"name": "name.pdf",
"title": null,
"url": "https://xxxx.com/name.pdf",
"order": 1,
"file_size": "1012168",
"document_type": "plans",
"content_type": "application/pdf",
"allowed_to_display": true
},
{
"id": "JYdlK8",
"name": "name.png",
"title": null,
"url": "https://xxxx.com/name.png",
"order": 2,
"file_size": "49786",
"document_type": "",
"content_type": "image/png",
"allowed_to_display": true
}
],
"virtual_visits": [],
"address": {
"allowed_to_display": true,
"address_formatted": "310 Avenue de Provence, 83600 Fréjus",
"street_number": "310",
"street_name": "Avenue de Provence",
"zipcode": "83600",
"locality": "Frejus",
"sublocality": "Frejus Plage",
"latitude": 43.4279,
"longitude": 6.74036,
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Var",
"country": "France",
"country_iso_code": "fr"
},
"country_detail": {
"fr": {
"dpe": {
"date_start": "2024-02-08",
"date_end": null,
"dpe_letter": "C",
"dpe_value": 130.0,
"ges_letter": "C",
"ges_value": 21.0,
"dpe_lower_price": null,
"dpe_higher_price": null,
"dpe_year_reference": null,
"dpe_url": null
},
"alur": {
"procedure_in_progress": false,
"procedure_details": "",
"number_of_lots": 100
}
},
"be": {
"peb": {
"date_start": "2025-03-12",
"peb_letter": "B",
"peb_number": "1487596",
"peb_energy_value": 256.0,
"peb_emission_value": 356.0,
"peb_consumption_total": 1500.0
},
"diagnosis": {
"electrical_inspection": "compliant",
"electrical_inspection_date": "2025-03-14",
"electrical_wiring_diagrams": true,
"gas_inspection": "requested",
"gas_inspection_date": "2025-03-13",
"certibeau_date": "2025-03-13",
"certibeau_number": "Test certibeau",
"tank_type": "mazout",
"tank_date": "2025-03-12",
"tank_number": "A7895",
"tank_color": "orange",
"class_three_declaration_date": "2025-03-13",
"class_three_declaration_object": "Classe3",
"class_three_declaration_note": "Note classe 3",
"abestos_type": "none",
"abestos_date": "2025-03-13"
},
"urbanism": {
"zoning_plan": null,
"territorial_development_plan": null,
"intermunicipal_development_plan": null,
"intermunicipal_development_plan_note": null,
"local_interpretation_plan": null,
"local_interpretation_plan_note": null,
"regional_guide": null,
"regional_guide_note": null,
"municipal_development_plan": null,
"municipal_development_plan_note": null,
"municipal_guide": null,
"municipal_guide_note": null,
"soil_condition_database": null,
"flood_prone_area_due_to_overflow": null,
"flood_prone_area_due_to_runoff": null,
"runoff_concentration_axes": null,
"cu1_urban_planning_information": null,
"cu1_urban_planning_information_date": null,
"cu2": null,
"building_permit_date": null,
"building_permit_note": null,
"urbanization_permit_date": "2025-03-13",
"urbanization_permit_note": "permis d'urbanisation",
"operating_permit_date": "2025-03-21",
"operating_permit_note": "permis d'exploiter",
"rent_permit_date": "2025-03-20",
"rent_permit_note": "permis de location",
"regional_land_use_plan": "none",
"master_development_plan": true,
"master_development_plan_note": "Test PAD",
"regional_urban_planning_regulations": "",
"zoned_regional_urban_planning_regulations": true,
"zoned_regional_urban_planning_regulations_note": "Test RRUZ",
"municipal_land_use_plan": true,
"municipal_land_use_plan_note": "Test PCD",
"zoned_municipal_land_use_plan": true,
"zoned_municipal_land_use_plan_note": "TEST PPAS",
"specific_municipal_urban_planning_regulation": true,
"specific_municipal_urban_planning_regulation_note": "Test RCUS",
"zoned_specific_municipal_urban_planning_regulation": true,
"zoned_specific_municipal_urban_planning_regulation_note": "Test RCUSZ",
"inventory_of_soil_condition": "none",
"heritage_protection": true,
"heritage_protection_note": "Test protection patrimoine",
"preemption_right": true,
"preemption_right_note": "Test droit de préemption",
"summary_description_date": "2025-03-12",
"summary_description_note": null,
"urban_planning_information_date_of_request": "2025-03-06",
"urban_planning_information_date_of_extraction": "2025-03-04",
"infractions_or_sanctions": true,
"infractions_or_sanctions_note": "Test infractions",
"flood_zone": "medium",
"arbitration_plan": null,
"grup": null,
"prup": null,
"structure_plan": null,
"structure_plan_note": null,
"zoning_plan_flandres": null,
"zoning_plan_flandres_note": null,
"urban_planning_information": null,
"urban_planning_information_date": null,
"floor_plan_test": null,
"floor_plan_test_note": null,
"flood_zones_runoff_zones": null,
"flood_zones_runoff_zones_note": null,
"cadastrale_locality": null,
"cadastrale_division": null,
"cadastrale_section": null,
"cadastrale_parcel_number": null
}
},
"it": null
},
"title": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"visit_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"agency_confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"url_more_infos": "https://www.test.com",
"surface_areas": {
"area_unit": "m2",
"area_total": 140.0,
"area_carrez_law": 140.0,
"area_living_room": 34.0,
"area_terrace": 3.0,
"area_garden": 786.0,
"area_land": 123.0,
"area_storeroom": null,
"area_ground": null,
"area_land_registry": 1.0,
"area_balcony": 3.0,
"area_floor": 64.0,
"area_ces": 76.0,
"formatted": {
"area_total": "140 m<sup>2</sup>",
"area_carrez_law": "140 m<sup>2</sup>",
"area_living_room": "34 m<sup>2</sup>",
"area_terrace": "3 m<sup>2</sup>",
"area_garden": "786 m<sup>2</sup>",
"area_land": "123 m<sup>2</sup>",
"area_storeroom": null,
"area_ground": null,
"area_land_registry": "1 m<sup>2</sup>",
"area_balcony": "3 m<sup>2</sup>",
"area_floor": "64 m<sup>2</sup>",
"area_ces": "76 m<sup>2</sup>"
}
},
"rooms": {
"rooms": 7,
"bedrooms": 4,
"bathrooms": 0,
"half_bathrooms": 2,
"toilets": 2,
"maid_rooms": 8
},
"general": {
"new_program": true,
"new_program_delivery": "2024-03-28",
"garage": 2,
"outside": 2,
"underground": 1,
"location_number": "",
"visitor": 1,
"parkings_nearby": true,
"floor": 0,
"level": 0,
"cellar": 2,
"loggia": false,
"attic": 1,
"convertible_attic": true,
"high_ceilings": 233.0,
"minimum_division": 0.0,
"shop_window_width": 0.0,
"quiet_property": true,
"shared_services": null,
"last_floor": false,
"key_at_agency": true,
"building_permit": true,
"building_permit_date": "2024-03-22",
"private_garden": null,
"air_conditioning": true,
"partition": null,
"conduit": null,
"investor_program": true,
"furnished": true,
"fireplace": true,
"construction_date": "2024-03-07",
"outbuildings": "Grange jardin",
"activities": "",
"authorized_activities": "",
"house_name": "",
"school_nearby": true,
"convenient_store_nearby": true,
"transports_nearby": true,
"viabilisation": null,
"facades_number": 0,
"alarm": true,
"possibility_of_liberal_profession": true,
"vehicle_number": null,
"park": null,
"pool": true,
"tennis": true,
"elevator": true,
"handicapped_access": true,
"single_storey": true,
"interphone": true,
"digicode": true,
"balcony": null,
"terrace": null
},
"characteristics": {
"access": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"adjoining_building": {
"slug": "detached",
"name": {
"fr": "Individuelle",
"en": "Detached",
"es": "Individual",
"it": "Individuale",
"nl": "Open bebouwing",
"pt": null,
"de": null
}
},
"closure": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"condition": {
"slug": "excellent-condition",
"name": {
"fr": "Très bon état",
"en": "Excellent condition",
"es": "Excellent état",
"it": "Ottimo stato",
"nl": "Excellent état",
"pt": null,
"de": null
}
},
"configuration": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"exposition": {
"slug": "north-east",
"name": {
"fr": "Nord-Est",
"en": "North-East",
"es": "Nor-Este",
"it": "Nord-Est",
"nl": "Noord-Oost",
"pt": null,
"de": null
}
},
"external_wall": {
"slug": "crepis",
"name": {
"fr": "Crépis",
"en": "Crépis",
"es": "Crépis",
"it": "Crépis",
"nl": null,
"pt": null,
"de": null
}
},
"legal_status": {
"slug": "free-property",
"name": {
"fr": "Nue-propriété",
"en": "Bare property",
"es": "Propiedad compartida",
"it": "Indivisa",
"nl": "Indivision",
"pt": null,
"de": null
}
},
"floor": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"flooring": {
"slug": "woog",
"name": {
"fr": "Bois",
"en": "Woog",
"es": "Madera",
"it": "Legno",
"nl": "Hout",
"pt": null,
"de": null
}
},
"garage_status": {
"slug": "excluded",
"name": {
"fr": "En sus",
"en": "Excluded",
"es": "Excluidos",
"it": "Esclusi",
"nl": "Uitgesloten",
"pt": null,
"de": null
}
},
"glazing": {
"slug": "double",
"name": {
"fr": "Double vitrage",
"en": "Double glazing",
"es": "Doble",
"it": "Doppi",
"nl": "Dubbele",
"pt": null,
"de": null
}
},
"heating": {
"slug": "electric-radiator",
"name": {
"fr": "Convecteur",
"en": "Electric radiator",
"es": "Convecteur",
"it": "Convettori",
"nl": "Convector",
"pt": null,
"de": null
}
},
"heating_method": {
"slug": "climatisation",
"name": {
"fr": "Climatisation",
"en": "Climatisation",
"es": "Climatisation",
"it": "Climatizzazione",
"nl": "Climatisation",
"pt": null,
"de": null
}
},
"hot_water": {
"slug": "fuel",
"name": {
"fr": "Fioul",
"en": "Fuel",
"es": "Gasoil",
"it": "Gasolio",
"nl": "Stookolie",
"pt": null,
"de": null
}
},
"kitchen": {
"slug": "full-equiped",
"name": {
"fr": "Equipée",
"en": "Full equiped",
"es": "Equipada",
"it": "Attrezzata",
"nl": "Volledig ingericht",
"pt": null,
"de": null
}
},
"roof": {
"slug": "thatch",
"name": {
"fr": "Chaume",
"en": "Thatch",
"es": "Paja",
"it": "Paglia",
"nl": "Riet",
"pt": null,
"de": null
}
},
"sanitation": {
"slug": "sewer",
"name": {
"fr": "Egout",
"en": "Sewer",
"es": "Canal Reglamentario",
"it": "Fogna",
"nl": "Riool",
"pt": null,
"de": null
}
},
"shutter": {
"slug": "electric",
"name": {
"fr": "Roulants électriques",
"en": "Electric roller blind",
"es": "Roulants élec.",
"it": "Tapparelle elec.",
"nl": "Elektrisch",
"pt": null,
"de": null
}
},
"standing": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"style": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"surroundings": {
"slug": "city-houses",
"name": {
"fr": "Pavillonnaire",
"en": "City houses",
"es": "Urbanizacion de chalets",
"it": "Residenziale",
"nl": "Pavillonnaire",
"pt": null,
"de": null
}
},
"transferred_element": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"vegetation": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"view_principal": {
"slug": "panoramic",
"name": {
"fr": "Panoramique",
"en": "Panoramic",
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null,
"ru": null
}
},
"view": {
"slug": "sea",
"name": {
"fr": "Mer",
"en": "Sea",
"es": "Mar",
"it": "Mare",
"nl": "Zee",
"pt": null,
"de": null
}
},
"woodwork": {
"slug": "mixt",
"name": {
"fr": "Mixte",
"en": "Mixt",
"es": "Mixte",
"it": "Mixte",
"nl": "Mixte",
"pt": null,
"de": null
}
},
"optical_fiber": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
},
"financial": {
"currency": "eur",
"price": 13890000.0,
"tax1_annual": 6754.0,
"tax2_annual": 7890.0,
"fees_annual": 1200.0,
"offer_from": false,
"tax_system": {
"slug": "vat",
"name": {
"fr": "TVA",
"fr-BE": "TVAC",
"fr-CA": "TVA",
"en": "VAT",
"es": "IVA",
"es-LA": "IVA",
"it": "IVA",
"nl": "TVA",
"pt": "TVA",
"pt-BR": "TVA",
"de": "TVA",
"ru": "TVA"
}
},
"honorary": {
"honorary": 800000.0,
"honorary_buyer": 0.0,
"honorary_seller": 800000.0,
"honorary_rate": 5.75,
"honorary_rate_buyer": 0.0,
"honorary_rate_seller": 5.75,
"fee_type": {
"slug": "vendeur",
"name": {
"fr": "Vendeur",
"en": "Vendeur",
"es": "Vendeur",
"it": "Vendeur",
"nl": null,
"pt": null,
"de": null
}
},
"honorary_visit": 0.0,
"honorary_inventories": 0.0
},
"rental": {
"is_student_rental": false,
"is_seasonal_rental": false,
"rent": 1300.0,
"rent_frequency": "monthly",
"income_annual": 0.0,
"charge": 0.0,
"charge_frequency": "monthly",
"charge_included": true,
"security_deposit": 0.0,
"charge_modality": {
"slug": "forfaitaires-mensuelles",
"name": {
"fr": "Forfaitaires mensuelles",
"en": "Forfaitaires mensuelles",
"es": "Forfaitaires mensuelles",
"it": "Forfaitaires mensuelles",
"nl": null,
"pt": null,
"de": null
}
}
},
"formatted": {
"european_format": {
"price": "13 890 000 €",
"tax1_annual": "6 754 €",
"tax2_annual": "7 890 €",
"fees_annual": "1 200 €",
"honorary": {
"honorary": "800 000 €",
"honorary_buyer": "",
"honorary_seller": "800 000 €",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "1 300 €",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
},
"american_format": {
"price": "€13,890,000",
"tax1_annual": "€6,754",
"tax2_annual": "€7,890",
"fees_annual": "€1,200",
"honorary": {
"honorary": "€800,000",
"honorary_buyer": "",
"honorary_seller": "€800,000",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "€1,300",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
}
}
},
"building": {
"name": "Boulevard Saint-Roch (15 Bis)",
"elevator": true,
"pool": true,
"tennis": false,
"park": false,
"number_of_floors": 4,
"number_of_lots": null,
"last_renovating_facade": "2014-05-21",
"outbuildings": null,
"period": "1950",
"caretaker": true,
"garden": false,
"secure_access": false,
"private_garden": false,
"handicapped_access": false,
"parking_lot": true,
"works_planned": false,
"children_playground": false,
"bike_storage": true,
"laundry": false,
"sports_hall": true,
"surveillance": true,
"interphone": true,
"videophone": false,
"digicode": true,
"created_at": "2021-09-27T15:40:42.908094+02:00",
"updated_at": "2023-07-07T16:08:49.960744+02:00",
"characteristics": {
"construction": {
"slug": "concrete",
"name": {
"fr": "Béton",
"fr-BE": "Béton",
"fr-CA": "Béton",
"en": "Concrete",
"es": "Hormigón",
"es-LA": "Hormigón",
"it": "Cemento",
"nl": "",
"pt": "Béton",
"pt-BR": "Béton",
"de": "Béton",
"ru": "Béton"
}
},
"heating": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"hot_water": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"standing": {
"slug": "good",
"name": {
"fr": "Standing",
"fr-BE": "Standing",
"fr-CA": "Standing",
"en": "Good",
"es": "Standing Medio",
"es-LA": "Standing Medio",
"it": "Livello Medio",
"nl": "Standing",
"pt": "Standing",
"pt-BR": "Standing",
"de": "Standing",
"ru": "Standing"
}
}
}
},
"open_doors": [
{
"id": "dXAMXj",
"date": "2023-12-23",
"start_time": "2000-01-01T16:00:00.000000+01:00",
"end_time": "2000-01-01T19:00:00.000000+01:00",
"informations": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
{
"id": "yQY35l",
"date": "2023-11-15",
"start_time": "2000-01-01T15:50:00.000000+01:00",
"end_time": "2000-01-01T17:50:00.000000+01:00",
"informations": "LOrem ipsum"
},
{
"id": "zQ4x0Q",
"date": "2024-01-19",
"start_time": "2000-01-01T10:27:00.000000+01:00",
"end_time": "2000-01-01T10:27:00.000000+01:00",
"informations": "Lorem"
},
{
"id": "VvgDP5",
"date": "2025-05-31",
"start_time": "2000-01-01T10:00:00.000000+01:00",
"end_time": "2000-01-01T12:00:00.000000+01:00",
"informations": "Lorem ipsum dolor sit amet"
}
],
"price_evolutions": [
{
"date": "2024-06-10T19:42:40.145317+02:00",
"old_price": 150000.0,
"new_price": 152000.0,
"price_evolution_type": {
"slug": "price_increase",
"name": {
"fr": "Hausse de prix",
"fr-BE": "Hausse de prix",
"fr-CA": "Hausse de prix",
"en": "Price increase",
"es": "Hausse de prix",
"es-LA": "Hausse de prix",
"it": "Hausse de prix",
"nl": "Hausse de prix",
"pt": "Hausse de prix",
"pt-BR": "Hausse de prix",
"de": "Hausse de prix",
"ru": "Hausse de prix"
}
}
}
],
"rooms_details": [],
"lot_details": []
}Paramétres de la réponse
| Node |
Type |
Nullable |
Description |
| id |
string |
Non |
ID du bien |
| uid |
string |
Oui |
Référence de la source d'import |
| reference |
string |
Non |
Référence interne de la propriété |
| online_at |
datetime |
Oui |
Date de publication |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| offline_at |
datetime |
Oui |
Date du retrait de la propriété (prochainement) |
is_on_portal |
boolean |
Oui |
Affichable sur un portail |
is_mls |
boolean |
Oui |
Propriété MLS |
is_private |
boolean |
Oui |
Propriété privée |
| mls_board |
|
|
|
| id |
string |
Non |
ID du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso de la langue par défaut |
| agency |
Oui |
|
|
| id |
string |
Non |
ID de l'agence |
| name |
string |
Non |
Nom de l'agence |
| mls_status |
boolean |
Non |
Statut MLS |
| email |
string |
Oui |
Email de l'agence |
| licence |
string |
Oui |
RCS / SIREN de l'agence |
| registration_number |
string |
Oui |
Numéro de carte professionnelle |
| user |
Oui |
|
|
| id |
string |
Non |
ID de l'utilisateur |
| full_name |
string |
Oui |
Nom complet de l'utilisateur |
| first_name |
string |
Oui |
Prénom de l'utilisateur |
| last_name |
string |
Oui |
Nom de l'utilisateur |
| licence |
string |
Oui |
Carte professionnelle de l'utilisateur |
| email |
string |
Oui |
Email de l'utilisateur |
| phone |
string |
Oui |
Téléphone de l'utilisateur |
| mandate |
Oui |
|
|
| cadastre |
string |
Oui |
Référence cadastrale |
| number |
string |
Oui |
Numéro de mandat |
| co_ownership |
boolean |
Oui |
Si en copropriété |
| start_date |
datetime |
Oui |
Date de début de mandat |
| end_date |
datetime |
Oui |
Date de fin de mandat |
| effect_date |
datetime |
Oui |
Date d'effet |
| urgency_sale |
boolean |
Oui |
Vente urgente |
| slug |
string |
Oui |
slug du type de mandat |
| name |
array |
Oui |
Nom du type de mandat dans les différentes langues disponibles |
| property_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de propriété |
| name |
array |
Non |
Nom du type de propriété dans les différentes langues disponibles |
| sub_type |
Oui |
|
|
| slug |
string |
Oui |
slug du sous type de propriété |
| name |
array |
Oui |
Nom du sous type de propriété dans les différentes langues disponibles |
| transaction_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de transaction |
| name |
array |
Non |
Nom du type de transaction dans les différentes langues disponibles |
| transaction_status |
Oui |
|
|
| slug |
string |
Non |
slug du type de statut original de transaction |
| name |
array |
Non |
Nom du type de statut otiginal de transaction dans les différentes langues disponibles |
| sub_status |
Oui |
|
|
end_market_date |
datetime |
Oui |
Date de retrait du marché |
offer_accepted_date |
datetime |
Oui |
Date acceptation de l'offre |
| compromise_date |
datetime |
Oui |
Date sous compromis |
sold_or_rent_date |
datetime |
Oui |
Date vendu ou loué |
| withdrawal_date |
datetime |
Oui |
Date de passage en retiré |
| slug |
string |
Oui |
slug du statut |
| name |
array |
Oui |
Nom du statut dans les différentes langues disponibles |
| lease |
Oui |
|
|
is_sold_with_tenant |
boolean |
Oui |
Vendu occupé |
| availability_date |
datetime |
Oui |
Date de disponibilité |
| slug |
string |
Oui |
slug du type de bail |
| name |
array |
Oui |
Nom du type de bail dans les différentes langues disponibles |
| life_lease |
Oui |
|
|
is_life_lease |
boolean |
Oui |
Viager oui/non |
| venal_value |
float |
Oui |
Valeur vénale |
| life_annuity |
float |
Oui |
Rente annuelle |
life_lease_type |
array |
Oui |
Type de viager |
| slug |
string |
Oui |
slug du type de viager |
| name |
array |
Oui |
Nom du type de viager dans les différentes langues disponibles |
| pictures |
|
|
|
| url |
string |
Oui |
Url de la photo |
| name |
string |
Oui |
Nom de la photo |
| order |
string |
Oui |
Position de la photo |
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| documents |
|
|
|
| id |
string |
Non |
Id du document |
| name |
string |
Oui |
Nom du document |
| url |
string |
Non |
Url du document |
| order |
string |
Non |
Position du document |
| file_size |
string |
Non |
Taille du document |
| document_type |
string |
Non |
Type du document |
| content_type |
string |
Non |
|
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| virtual_visits |
|
|
|
| id |
string |
Oui |
Id de la visite virtuelle |
| name |
string |
Oui |
Nom de la visite virtuelle |
| url |
string |
Oui |
Url de la visite virtuelle |
| address |
|
|
|
allowed_to_display |
boolean |
Non |
Autorisé à être affiché |
address_formatted |
string |
Non |
Adresse formatée |
| street_number |
string |
Oui |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postale |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Non |
Quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
administrative_area_level1 |
string |
Non |
Région |
administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
country_iso_code |
string |
Non |
Code ISO du pays |
| country_detail |
Oui |
|
|
| fr |
Oui |
|
|
| dpe |
Oui |
|
|
| dpe_number |
string |
Oui |
Numéro du DPE |
| date_start |
datetime |
Oui |
Date de début du DPE |
| date_end |
datetime |
Oui |
Date de fin de validité du DPE |
| dpe_letter |
string |
Oui |
Lettre DPE (A à G) |
| dpe_value |
float |
Oui |
Valeur DPE (kWh/m²/an) |
| ges_letter |
string |
Oui |
Lettre GES (A à G) |
| ges_value |
float |
Oui |
Valeur GES (kg CO2/m²/an) |
dpe_lower_price |
float |
Oui |
Estimation basse des dépenses énergétiques annuelles |
dpe_higher_price |
float |
Oui |
Estimation haute des dépenses énergétiques annuelles |
dpe_year_reference |
date |
Oui |
Année de référence du DPE |
| dpe_url |
string |
Oui |
URL du document DPE |
| dpenosubject_to |
boolean |
Oui |
Non soumis au DPE |
| alur |
|
|
|
procedure_in_progress |
boolean |
Oui |
Procédure en cours sur la copropriété |
procedure_details |
string |
Oui |
Détails de la procédure |
number_of_lots |
integer |
Oui |
Nombre de lots |
| be |
Oui |
|
|
| peb |
Oui |
|
|
| date_start |
datetime |
Oui |
Date du certicat |
| peb_letter |
string |
Oui |
Lettre PEB |
| peb_number |
string |
Oui |
Numéro PEB |
| pebenergyvalue |
float |
Oui |
Performance énérgétique (en kWh/h/an) |
| pebemissionvalue |
float |
Oui |
Emission CO2 (en m2/an) |
| pebconsumptiontotal |
float |
Oui |
Consommation totale (en kWh/h/an) |
| diagnosis |
Oui |
|
|
| electrical_inspection |
string |
Oui |
Contrôle électrique |
| electricalinspectiondate |
date |
Oui |
Date du contrôle électrique |
| electricalwiringdiagrams |
boolean |
Oui |
Schémas filaires |
| gas_inspection |
string |
Oui |
Contrôle gaz |
| gasinspectiondate |
date |
Oui |
Date du contrôle gaz |
| certibeau_date |
date |
Oui |
Date du certibeau |
| certibeau_number |
string |
Oui |
Numéro du certibeau |
| tank_type |
string |
Oui |
Type de citerne |
| tank_date |
date |
Oui |
Date |
| tank_number |
string |
Oui |
Numéro |
| tank_color |
string |
Oui |
Couleur |
| classthreedeclaration_date |
date |
Oui |
Date déclaration de classe 3 |
| classthreedeclaration_object |
string |
Oui |
Objet déclaration de classe 3 |
| classthreedeclaration_note |
string |
Oui |
Note déclaration de classe 3 |
| abestos_type |
string |
Oui |
Type amiante |
| abestos_date |
date |
Oui |
Date du test d'amiante |
| urbanism |
Oui |
|
|
| zoning_plan |
string |
Oui |
Wallonie - Plan de secteur |
| territorialdevelopmentplan |
string |
Oui |
Wallonie - Schéma de développement du territoire (SDT) |
| intermunicipaldevelopmentplan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| intermunicipaldevelopmentplan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| localinterpretationplan |
boolean |
Oui |
Wallonie - Schéma d'orientation local (SOL) |
| localinterpretationplan_note |
string |
Oui |
Wallonie - Zone SOL |
| regional_guide |
boolean |
Oui |
Wallonie - Guide régional |
| regionalguidenote |
string |
Oui |
Wallonie - Objet guide régional |
| municipaldevelopmentplan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| municipaldevelopmentplan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| municipal_guide |
boolean |
Oui |
Wallonie - Guide communal |
| municipalguidenote |
string |
Oui |
Wallonie - Zone de guide communal |
| soilconditiondatabase |
string |
Oui |
Wallonie - Banque de données de l'état du sol (BDES) |
| floodproneareadueto_overflow |
string |
Oui |
Wallonie - Zone inondable par débordement |
| floodproneareadueto_runoff |
string |
Oui |
Wallonie - Zone inondable par ruissellement |
| cu2 |
boolean |
Oui |
Wallonie - CU2 |
| cu1urbanplanning_information |
boolean |
Oui |
Wallonie - CU1 / renseignements urbanistiques |
| cu1urbanplanninginformationdate |
date |
Oui |
Wallonie - Date CU1 / renseignements urbanistiques |
| buildingpermitdate |
date |
Oui |
Wallonie - Flandres - Date du permis de contruire |
| buildingpermitnote |
string |
Oui |
Wallonie - Flandres - Permis de construire |
| urbanizationpermitdate |
date |
Oui |
Wallonie - Bruxelles - Date permis d'urbanisation |
| urbanizationpermitnote |
string |
Oui |
Wallonie - Bruxelles - Permis d'urbanisation |
| operatingpermitdate |
date |
Oui |
Wallonie - Bruxelles - Date permis d'exploiter |
| operatingpermitnote |
string |
Oui |
Wallonie - Bruxelles - Permis d'exploiter |
| rentpermitdate |
date |
Oui |
Wallonie - Bruxelles - Flandres - Date permis de location |
| rentpermitnote |
string |
Oui |
Wallonie - Bruxelles - Flandres - Note permis de location |
| regionallanduse_plan |
string |
Oui |
Bruxelles - Plan régional d'affectation (PRAS) |
| regionalurbanplanning_regulations |
string |
Oui |
Bruxelles - Règlement régional d'urbanisme (RRU) |
| masterdevelopmentplan |
boolean |
Oui |
Bruxelles - Plan d'aménagement directeur (PAD) |
| masterdevelopmentplan_note |
string |
Oui |
Bruxelles - Zone PAD |
| zonedregionalurbanplanningregulations |
boolean |
Oui |
Bruxelles - Règlement régional d'urbanisme zoné (RRUZ) |
| zonedregionalurbanplanningregulations_note |
string |
Oui |
Bruxelles - Zone RRUZ |
| municipallanduse_plan |
boolean |
Oui |
Bruxelles - Plan communal de développement (PCD) |
| municipallanduseplannote |
string |
Oui |
Bruxelles - Zone PCD |
| zonedmunicipallanduseplan |
boolean |
Oui |
Bruxelles - Plan d'anénagement du sol (PPAS) |
| zonedmunicipallanduseplan_note |
string |
Oui |
Bruxelles - Zone PPAS |
| specificmunicipalurbanplanningregulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme spécifique (RCUS) |
| specificmunicipalurbanplanningregulation_note |
string |
Oui |
Bruxelles - Zone/affectation RCUS |
| zonedspecificmunicipalurbanplanning_regulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme zoné (RCUZ) |
| zonedspecificmunicipalurbanplanningregulationnote |
string |
Oui |
Bruxelles - Zone/affectation RCUZ |
| inventoryofsoil_condition |
string |
Oui |
Bruxelles - Inventaire de l'état du sol |
| heritage_protection |
boolean |
Oui |
Bruxelles - Protection du patrimoine |
| heritageprotectionnote |
string |
Oui |
Bruxelles - Zone protection du patrimoine |
| preemption_right |
boolean |
Oui |
Bruxelles - Flandres - Droit de préemption |
| preemptionrightnote |
string |
Oui |
Bruxelles - Flandres - Objet droit de préemption |
| summarydescriptiondate |
date |
Oui |
Bruxelles - Date descriptif sommaire |
| summarydescriptionnote |
string |
Oui |
Bruxelles - Note descriptif sommaire |
| urbanplanninginformationdateof_request |
date |
Oui |
Bruxelles - Date demande renseignements urbanistiques |
| urbanplanninginformationdateof_extraction |
date |
Oui |
Bruxelles - Date extrait renseignements urbanistiques |
| infractionsorsanctions |
boolean |
Oui |
Bruxelles - Infractions et/ou sanctions |
| infractionsorsanctions_note |
string |
Oui |
Bruxelles - Détails infractions et/ou sanctions |
| flood_zone |
string |
Oui |
Bruxelles - Zone inondable |
| arbitration_plan |
string |
Oui |
Flandres - Zone plan d'arbitrage |
| grup |
string |
Oui |
Flandres - Zone GRUP |
| prup |
string |
Oui |
Flandres - Zone PRUP |
| structure_plan |
boolean |
Oui |
Flandres - Plan de structure |
| structureplannote |
string |
Oui |
Flandres - Zone plan de structure |
| zoningplanflandres |
boolean |
Oui |
Flandres - Plan de zonage |
| zoningplanflandres_note |
string |
Oui |
Flandres - Zone plan de zonage |
| urbanplanninginformation |
boolean |
Oui |
Flandres - Informations sur l'urbanisme |
| urbanplanninginformation_date |
date |
Oui |
Flandres - Date informations sur l'urbanisme |
| floorplantest |
boolean |
Oui |
Flandres - Test du tapis de sol |
| floorplantest_note |
string |
Oui |
Flandres - Mesures du tapis de so |
| floodzonesrunoff_zones |
boolean |
Oui |
Flandres - Zones inondables/zones de ruissellement |
| floodzonesrunoffzonesnote |
string |
Oui |
Flandres - Risques zones inondables/zones de ruissellement |
| title |
|
|
|
| title |
array |
Oui |
Titre dans les différentes langues disponibles |
| description |
|
|
|
| description |
array |
Oui |
Description dans les différentes langues disponibles |
| confidential_information |
|
|
|
| confidential_information |
array |
Oui |
Informations confidentielles dans les différentes langues disponibles |
| visit_information |
|
|
|
| visit_information |
array |
Oui |
Informations de visites dans les différentes langues disponibles |
| agencyconfidentialinformation |
|
|
|
agency_confidential_information |
array |
Oui |
Informations confidentielles agence dans les différentes langues disponibles |
| surface_areas |
|
|
|
| area_unit |
string |
Oui |
Unité de surface |
| area_total |
float |
Oui |
Surface habitable indicative |
area_carrez_law |
float |
Oui |
Surface loi Carrez |
| area_land |
float |
Oui |
Surface du terrain |
| area_garden |
float |
Oui |
Surface du jardin |
area_living_room |
float |
Oui |
Surface du salon |
| area_terrace |
float |
Oui |
Surface du ou des terrasses |
| area_balcony |
float |
Oui |
Surface du ou des balcons |
| area_formatted |
float |
Oui |
Surface formaté avec l'unité |
| area_storeroom |
float |
Oui |
Surface de la réserve |
| area_ground |
float |
Oui |
Surface au sol |
area_land_registry |
float |
Oui |
Surface cadastrale |
| area_floor |
float |
Oui |
Surface plancher autorisée |
| area_ces |
float |
Oui |
Coefficient d'emprise au sol (CES) |
| formatted |
array |
Oui |
Surfaces formatées |
| rooms |
|
|
|
| rooms |
integer |
Oui |
Nombre de pièces |
| bedrooms |
integer |
Oui |
Nombre de chambres |
| bathrooms |
integer |
Oui |
Nombre de salle de bains |
| half_bathrooms |
integer |
Oui |
Nombre de salles d'eau |
| toilets |
integer |
Oui |
Nombre de WC |
| maid_rooms |
integer |
Oui |
Nombre de chambres de service |
| general |
|
|
|
| new_program |
boolean |
Oui |
Programme neuf |
new_program_delivery |
date |
Oui |
Date de livraison du programme neuf |
| garage |
integer |
Oui |
Nombre de garage / parking |
| outside |
integer |
Oui |
Nombre de parking extérieur |
| underground |
integer |
Oui |
Nombre de parkings en sous sol |
| location_number |
integer |
Oui |
Numéros de stationnements |
| visitor |
integer |
Oui |
Nombre de parking visiteurs |
| parkings_nearby |
boolean |
Oui |
Parkings proches |
| floor |
integer |
Oui |
Etage |
| level |
integer |
Oui |
Nombre de niveau |
| cellar |
integer |
Oui |
Nombres de caves |
| loggia |
integer |
Oui |
Nombres de loggias |
| attic |
integer |
Oui |
Nombre de greniers |
| convertible_attic |
boolean |
Oui |
Grenier aménageable |
| high_ceilings |
float |
Oui |
Hauteur sous plafond |
| minimum_division |
float |
Oui |
Division minimum |
shop_window_width |
float |
Oui |
Largeur vitrine |
| quiet_property |
boolean |
Oui |
Calme |
| shared_services |
boolean |
Oui |
Services communs |
| last_floor |
boolean |
Oui |
Dernier étage |
key_at_agency |
boolean |
Oui |
Clé à l'agence |
| building_permit |
boolean |
Oui |
Permis de construire |
building_permit_date |
date |
Oui |
Date du permis de construite |
| private_garden |
boolean |
Oui |
Jardin privatif |
| air_conditioning |
boolean |
Oui |
Climatisation |
| partition |
boolean |
Oui |
Cloisons |
| conduit |
boolean |
Oui |
Goulottes |
| investor_program |
boolean |
Oui |
Programme investisseur |
| furnished |
boolean |
Oui |
Meublé |
| fireplace |
boolean |
Oui |
Cheminée |
| construction_date |
date |
Oui |
Date de construction |
| outbuildings |
string |
Oui |
Dépendances |
| activities |
string |
Oui |
Activités |
| authorized_activities |
string |
Oui |
Activités autorisées |
| house_name |
string |
Oui |
Nom maison |
| school_nearby |
boolean |
Oui |
Ecoles proches |
convenient_store_nearby |
boolean |
Oui |
Commerces proches |
| transports_nearby |
boolean |
Oui |
Transports proches |
| viabilisation |
boolean |
Oui |
Viabilisation |
| facades_number |
integer |
Oui |
Nombre de façades |
| alarm |
boolean |
Oui |
Alarme |
possibility_of_liberal_profession |
boolean |
Oui |
Professionel autorisé |
| vehicle_number |
integer |
Oui |
Nombre de véhicules |
| park |
boolean |
Oui |
Parc |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| elevator |
boolean |
Oui |
Ascenseur |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| single_storey |
boolean |
Oui |
Plain-pied |
| interphone |
boolean |
Oui |
Interphone |
| digicode |
boolean |
Oui |
Digicode |
| characteristics |
|
|
|
| access |
|
|
|
| slug |
string |
Oui |
slug du type d'accès |
| name |
array |
Oui |
Nom du type d'accès dans les différentes langues disponibles |
| adjoining_building |
|
|
|
| slug |
string |
Oui |
slug du type de mitoyenneté |
| name |
array |
Oui |
Nom du type de mitoyenneté dans les différentes langues disponibles |
| closure |
|
|
|
| slug |
string |
Oui |
slug du type de fermetures |
| name |
array |
Oui |
Nom du type de fermetures dans les différentes langues disponibles |
| condition |
|
|
|
| slug |
string |
Oui |
slug du type état |
| name |
array |
Oui |
Nom du type état dans les différentes langues disponibles |
| configuration |
|
|
|
| slug |
string |
Oui |
slug du type de configuration |
| name |
array |
Oui |
Nom du type de configuration dans les différentes langues disponibles |
| exposition |
|
|
|
| slug |
string |
Oui |
slug du type d'exposition principale |
| name |
array |
Oui |
Nom du type d'exposition principale dans les différentes langues disponibles |
| external_wall |
|
|
|
| slug |
string |
Oui |
slug du type de murs extérieurs |
| name |
array |
Oui |
Nom du type de murs extérieurs dans les différentes langues disponibles |
| legal_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut juridique |
| name |
array |
Oui |
Nom du type de statut juridique dans les différentes langues disponibles |
| floor |
|
|
|
| slug |
string |
Oui |
slug du type de revêtement sol |
| name |
array |
Oui |
Nom du type de revêtement sol dans les différentes langues disponibles |
| flooring |
|
|
|
| slug |
string |
Oui |
slug du type de plancher |
| name |
array |
Oui |
Nom du type de plancher dans les différentes langues disponibles |
| garage_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut des garages |
| name |
array |
Oui |
Nom du type de statut des garages dans les différentes langues disponibles |
| glazing |
|
|
|
| slug |
string |
Oui |
slug du type de vitrage |
| name |
array |
Oui |
Nom du type de vitrage dans les différentes langues disponibles |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| name |
array |
Oui |
Nom du type de chauffage dans les différentes langues disponibles |
| heating_method |
|
|
|
| slug |
string |
Oui |
slug du type d'énergie chauffage |
| name |
array |
Oui |
Nom du type d'énergie chauffage dans les différentes langues disponibles |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| name |
array |
Oui |
Nom du type d'eau chaude dans les différentes langues disponibles |
| kitchen |
|
|
|
| slug |
string |
Oui |
slug du type de cuisine |
| name |
array |
Oui |
Nom du type de cuisine dans les différentes langues disponibles |
| roof |
|
|
|
| slug |
string |
Oui |
slug du type de toiture |
| name |
array |
Oui |
Nom du type de toiture dans les différentes langues disponibles |
| sanitation |
|
|
|
| slug |
string |
Oui |
slug du type d'assainissement |
| name |
array |
Oui |
Nom du type d'assainissement dans les différentes langues disponibles |
| shutter |
|
|
|
| slug |
string |
Oui |
slug du type de volets |
| name |
array |
Oui |
Nom du type de volets dans les différentes langues disponibles |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| name |
array |
Oui |
Nom du type de standing dans les différentes langues disponibles |
| style |
|
|
|
| slug |
string |
Oui |
slug du type de style |
| name |
array |
Oui |
Nom du type de style dans les différentes langues disponibles |
| surroundings |
|
|
|
| slug |
string |
Oui |
slug du type d'environnement |
| name |
array |
Oui |
Nom du type d'environnement dans les différentes langues disponibles |
| transferred_element |
|
|
|
| slug |
string |
Oui |
slug du type d'éléments céder |
| name |
array |
Oui |
Nom du type d'éléments céder dans les différentes langues disponibles |
| vegetation |
|
|
|
| slug |
string |
Oui |
slug du type de végétation |
| name |
array |
Oui |
Nom du type de végétation dans les différentes langues disponibles |
| view_principal |
|
|
|
| slug |
string |
Oui |
slug du type de vue principale |
| name |
array |
Oui |
Nom du type de vue principale dans les différentes langues disponibles |
| view |
|
|
|
| slug |
string |
Oui |
slug du type de vue |
| name |
array |
Oui |
Nom du type de vue dans les différentes langues disponibles |
| woodwork |
|
|
|
| slug |
string |
Oui |
slug du type de menuiserie |
| name |
array |
Oui |
Nom du type de menuiserie dans les différentes langues disponibles |
| optical_fiber |
|
|
|
| slug |
string |
Oui |
slug du type de fibre optique |
| name |
array |
Oui |
Nom du type de fibre optique dans les différentes langues disponibles |
| financial |
|
|
|
| currency |
string |
Oui |
Unité monétaire |
| price |
float |
Oui |
Prix / Loyer |
| tax1_annual |
float |
Oui |
Taxe foncière |
| tax2_annual |
float |
Oui |
Taxe d'habitation |
| fees_annual |
float |
Oui |
Charges annuelles de copropriétés |
| honorary |
|
|
|
| honorary |
float |
Oui |
Honoraires |
| honorary_buyer |
float |
Oui |
Honoraires à la charge de l'aquéreur |
| honorary_seller |
float |
Oui |
Honoraires à la charge du vendeur |
| honorary_rate |
float |
Oui |
% d'honoraires |
honorary_rate_buyer |
float |
Oui |
% d'hHonoraires à la charge du vendeur |
honorary_rate_seller |
float |
Oui |
% d'hHonoraires à la charge de l'aquéreur |
| fee_type |
array |
Oui |
Type d'honoraires |
| slug |
string |
Oui |
slug du type d'honoraires |
| name |
string |
Oui |
nom du type d'honoraires dans les différentes langues disponibles |
| honorary_visit |
float |
Oui |
Honaires de visites |
| honorary_inventories |
float |
Oui |
Honoraire sde réalisation de l'état des lieux |
| rental |
|
|
|
is_student_rental |
boolean |
Oui |
Location étudiante |
is_seasonal_rental |
boolean |
Oui |
Location saisonnière |
| rent |
float |
Oui |
Loyer |
| rent_frequency |
string |
Oui |
Fréquence du loyer |
| income_annual |
float |
Oui |
Revenu annuel |
| charge |
float |
Oui |
Charges |
| charge_frequency |
string |
Oui |
Fréquence des charges |
| charge_included |
string |
Oui |
Charges incluses |
| security_deposit |
float |
Oui |
Dépot de garantie |
| charge_modality |
array |
Oui |
Modalités des charges |
| slug |
string |
Oui |
slug des modalités des charges |
| name |
string |
Oui |
slug des modalités des charges |
| formatted |
array |
Oui |
Prix et taxes formatés |
| building |
|
|
|
| elevator |
boolean |
Oui |
Ascenseur |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| park |
boolean |
Oui |
Parc |
| numberoffloors |
integer |
Oui |
Nombre d'étages |
| numberoflots |
integer |
Oui |
Nombre de lots |
| last_renovating_facade |
date |
Oui |
Date du dernier ravalement de façade |
| outbuildings |
string |
Oui |
Dépendances |
| period |
string |
Oui |
Période |
| caretaker |
boolean |
Oui |
Concierge |
| garden |
boolean |
Oui |
Jardin |
| secure_access |
boolean |
Oui |
Accès sécurisé |
| private_garden |
boolean |
Oui |
Jardin privatif |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| parking_lot |
boolean |
Oui |
Parking collectif |
| works_planned |
boolean |
Oui |
Travaux prévu |
| children_playground |
boolean |
Oui |
Jardin d'enfants |
| bike_storage |
boolean |
Oui |
Local à vélo |
| laundry |
boolean |
Oui |
Buanderie |
| sports_hall |
boolean |
Oui |
Salle de sport |
| surveillance |
boolean |
Oui |
Surveillance 24/24 |
| interphone |
boolean |
Oui |
Interphone |
| videophone |
boolean |
Oui |
Vidéophone |
| digicode |
boolean |
Oui |
Digicode |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| characteristics |
|
|
|
| construction |
|
|
|
| slug |
string |
Oui |
slug du type de construction |
| name |
array |
Oui |
Nom du type de construction dans les différentes langues disponibles |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| name |
array |
Oui |
Nom du type de chauffage dans les différentes langues disponibles |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| name |
array |
Oui |
Nom du type d'eau chaude dans les différentes langues disponibles |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| name |
array |
Oui |
Nom du type de standing dans les différentes langues disponibles |
| open_doors |
|
|
|
| id |
integer |
Non |
id de la visite libre |
| date |
date |
Non |
Date |
| start_time |
time |
Non |
Heure de début |
| end_time |
time |
Non |
Heure de fin |
| informations |
string |
Oui |
Informations |
| price_evolutions |
|
|
|
| date |
date |
Non |
Date de l'évolution du prix |
| old_price |
float |
Non |
Ancien prix |
| new_price |
float |
Non |
Nouveau prix |
| price_evolution_type |
array |
Oui |
Type d'évolution |
| slug |
string |
Oui |
Slug |
| name |
string |
Oui |
Nom du type d'évolution |
| rooms_details |
|
|
|
| id |
integer |
Oui |
id de la pièce |
| floor |
string |
Oui |
Sol |
| wall |
string |
Oui |
Murs |
| storage |
boolean |
Oui |
Placard |
| balcony |
boolean |
Oui |
Balcon |
| terrace |
boolean |
Oui |
Terrasse |
| garden |
boolean |
Oui |
Jardin |
| name |
string |
Oui |
Nom de la pièce |
| air_conditioning |
boolean |
Oui |
Climatisation |
| comments |
string |
Oui |
Commentaires |
| level |
integer |
Oui |
Niveau |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
string |
Oui |
Surface formatée |
| lots_details |
|
|
|
| lot_number |
string |
Oui |
Numéro du lot |
| lot_number_seconadry |
string |
Oui |
Numéro des lots secondaire |
| id |
integer |
Oui |
Id du lot |
| is_rent |
boolean |
Oui |
Loué |
| rent |
float |
Oui |
Loyer |
lease_end_date |
date |
Oui |
Fin du bail |
| lease_type |
array |
Oui |
Type de bail |
| slug |
string |
Oui |
Slug du type de bail |
| name |
string |
Oui |
Nom du type de bail |
| lot_type |
array |
Oui |
Type de lot |
| slug |
string |
Oui |
Slug |
| name |
string |
Oui |
Nom du type de lot |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
array |
Oui |
Surface formatée |
| description |
array |
Oui |
Description dans les langues disponibles |
| confidential_information |
array |
Oui |
|
| urlmoreinfos |
string |
Oui |
URL vers la page publique de la propriété renseignée par l'utilisateur |
Création (Droits supplémentaires requis)
Cette route vous permet de créer une propriété
Endpoint
POST https://app.mls-connect.com/fr/api/v3/properties
JSON parameters
| Node |
Type |
Nullable |
Description |
| uid |
string |
Oui |
Référence de la source d'import |
| mls_board |
|
|
|
| id |
string |
Non |
ID du MLS |
| agency |
Oui |
|
|
| id |
string |
Non |
ID de l'agence |
| user |
Oui |
|
|
| id |
string |
Non |
ID de l'utilisateur |
| mandate |
Oui |
|
|
| cadastre |
string |
Oui |
Référence cadastrale |
| number |
string |
Oui |
Numéro de mandat |
| co_ownership |
boolean |
Oui |
Si en copropriété |
| start_date |
datetime |
Oui |
Date de début de mandat |
| end_date |
datetime |
Oui |
Date de fin de mandat |
| effect_date |
datetime |
Oui |
Date d'effet |
| urgency_sale |
boolean |
Oui |
Vente urgente |
| slug |
string |
Oui |
slug du type de mandat |
| property_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de propriété |
| sub_type |
Oui |
|
|
| slug |
string |
Oui |
slug du sous type de propriété |
| transaction_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de transaction |
| transaction_status |
Oui |
|
|
| slug |
string |
Non |
slug du type de statut original de transaction |
| sub_status |
Oui |
|
|
end_market_date |
datetime |
Oui |
Date de retrait du marché |
offer_accepted_date |
datetime |
Oui |
Date acceptation de l'offre |
| compromise_date |
datetime |
Oui |
Date sous compromis |
sold_or_rent_date |
datetime |
Oui |
Date vendu ou loué |
| withdrawal_date |
datetime |
Oui |
Date de passage en retiré |
| slug |
string |
Oui |
slug du statut |
| lease |
Oui |
|
|
is_sold_with_tenant |
boolean |
Oui |
Vendu occupé |
| availability_date |
datetime |
Oui |
Date de disponibilité |
| slug |
string |
Oui |
slug du type de bail |
| life_lease |
Oui |
|
|
is_life_lease |
boolean |
Oui |
Viager oui/non |
| venal_value |
float |
Oui |
Valeur vénale |
| life_annuity |
float |
Oui |
Rente annuelle |
life_lease_type |
array |
Oui |
Type de viager |
| slug |
string |
Oui |
slug du type de viager |
| pictures |
|
|
|
| url |
string |
Oui |
Url de la photo |
| name |
string |
Oui |
Nom de la photo |
| order |
string |
Oui |
Position de la photo |
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| documents |
|
|
|
| name |
string |
Oui |
Nom du document |
| url |
string |
Non |
Url du document |
| order |
string |
Non |
Position du document |
| file_size |
string |
Non |
Taille du document |
| document_type |
string |
Non |
Type du document |
| content_type |
string |
Non |
|
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| virtual_visits |
|
|
|
| name |
string |
Oui |
Nom de la visite virtuelle |
| url |
string |
Oui |
Url de la visite virtuelle |
| address |
|
|
|
allowed_to_display |
boolean |
Non |
Autorisé à être affiché |
address_formatted |
string |
Non |
Adresse formatée |
| street_number |
string |
Oui |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postale |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Non |
Quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
administrative_area_level1 |
string |
Non |
Région |
administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
country_iso_code |
string |
Non |
Code ISO du pays |
| country_detail |
Oui |
|
|
| fr |
Oui |
|
|
| dpe |
Oui |
|
|
| dpe_number |
string |
Oui |
Numéro du DPE |
| date_start |
datetime |
Oui |
Date de début du DPE |
| date_end |
datetime |
Oui |
Date de fin de validité du DPE |
| dpe_letter |
string |
Oui |
Lettre DPE (A à G) |
| dpe_value |
float |
Oui |
Valeur DPE (kWh/m²/an) |
| ges_letter |
string |
Oui |
Lettre GES (A à G) |
| ges_value |
float |
Oui |
Valeur GES (kg CO2/m²/an) |
dpe_lower_price |
float |
Oui |
Estimation basse des dépenses énergétiques annuelles |
dpe_higher_price |
float |
Oui |
Estimation haute des dépenses énergétiques annuelles |
dpe_year_reference |
date |
Oui |
Année de référence du DPE |
| dpe_url |
string |
Oui |
URL du document DPE |
| dpenosubject_to |
boolean |
Oui |
Non soumis au DPE |
| alur |
|
|
|
procedure_in_progress |
boolean |
Oui |
Procédure en cours sur la copropriété |
procedure_details |
string |
Oui |
Détails de la procédure |
number_of_lots |
integer |
Oui |
Nombre de lots |
| be |
Oui |
|
|
| peb |
Oui |
|
|
| date_start |
datetime |
Oui |
Date du certicat |
| peb_letter |
string |
Oui |
Lettre PEB |
| peb_number |
string |
Oui |
Numéro PEB |
| peb_energy_value |
float |
Oui |
Performance énérgétique (en kWh/h/an) |
| peb_emission_value |
float |
Oui |
Emission CO2 (en m2/an) |
| peb_consumption_total |
float |
Oui |
Consommation totale (en kWh/h/an) |
| diagnosis |
Oui |
|
|
| electrical_inspection |
string |
Oui |
Contrôle électrique |
| electrical_inspection_date |
date |
Oui |
Date du contrôle électrique |
| electrical_wiring_diagrams |
boolean |
Oui |
Schémas filaires |
| gas_inspection |
string |
Oui |
Contrôle gaz |
| gas_inspection_date |
date |
Oui |
Date du contrôle gaz |
| certibeau_date |
date |
Oui |
Date du certibeau |
| certibeau_number |
string |
Oui |
Numéro du certibeau |
| tank_type |
string |
Oui |
Type de citerne |
| tank_date |
date |
Oui |
Date |
| tank_number |
string |
Oui |
Numéro |
| tank_color |
string |
Oui |
Couleur |
| class_three_declaration_date |
date |
Oui |
Date déclaration de classe 3 |
| class_three_declaration_object |
string |
Oui |
Objet déclaration de classe 3 |
| class_three_declaration_note |
string |
Oui |
Note déclaration de classe 3 |
| abestos_type |
string |
Oui |
Type amiante |
| abestos_date |
date |
Oui |
Date du test d'amiante |
| urbanism |
Oui |
|
|
| zoning_plan |
string |
Oui |
Wallonie - Plan de secteur |
| territorial_development_plan |
string |
Oui |
Wallonie - Schéma de développement du territoire (SDT) |
| intermunicipal_development_plan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| intermunicipal_development_plan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| local_interpretation_plan |
boolean |
Oui |
Wallonie - Schéma d'orientation local (SOL) |
| local_interpretation_plan_note |
string |
Oui |
Wallonie - Zone SOL |
| regional_guide |
boolean |
Oui |
Wallonie - Guide régional |
| regional_guide_note |
string |
Oui |
Wallonie - Objet guide régional |
| municipal_development_plan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| municipal_development_plan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| municipal_guide |
boolean |
Oui |
Wallonie - Guide communal |
| municipal_guide_note |
string |
Oui |
Wallonie - Zone de guide communal |
| soil_condition_database |
string |
Oui |
Wallonie - Banque de données de l'état du sol (BDES) |
| flood_prone_area_due_to_overflow |
string |
Oui |
Wallonie - Zone inondable par débordement |
| flood_prone_area_due_to_runoff |
string |
Oui |
Wallonie - Zone inondable par ruissellement |
| cu2 |
boolean |
Oui |
Wallonie - CU2 |
| cu1_urban_planning_information |
boolean |
Oui |
Wallonie - CU1 / renseignements urbanistiques |
| cu1_urban_planning_information_date |
date |
Oui |
Wallonie - Date CU1 / renseignements urbanistiques |
| building_permit_date |
date |
Oui |
Wallonie - Flandres - Date du permis de contruire |
| building_permit_note |
string |
Oui |
Wallonie - Flandres - Permis de construire |
| urbanization_permit_date |
date |
Oui |
Wallonie - Bruxelles - Date permis d'urbanisation |
| urbanization_permit_note |
string |
Oui |
Wallonie - Bruxelles - Permis d'urbanisation |
| operating_permit_date |
date |
Oui |
Wallonie - Bruxelles - Date permis d'exploiter |
| operating_permit_note |
string |
Oui |
Wallonie - Bruxelles - Permis d'exploiter |
| rent_permit_date |
date |
Oui |
Wallonie - Bruxelles - Flandres - Date permis de location |
| rent_permit_note |
string |
Oui |
Wallonie - Bruxelles - Flandres - Note permis de location |
| regional_land_use_plan |
string |
Oui |
Bruxelles - Plan régional d'affectation (PRAS) |
| regional_urban_planning_regulations |
string |
Oui |
Bruxelles - Règlement régional d'urbanisme (RRU) |
| master_development_plan |
boolean |
Oui |
Bruxelles - Plan d'aménagement directeur (PAD) |
| master_development_plan_note |
string |
Oui |
Bruxelles - Zone PAD |
| zoned_regional_urban_planning_regulations |
boolean |
Oui |
Bruxelles - Règlement régional d'urbanisme zoné (RRUZ) |
| zoned_regional_urban_planning_regulations_note |
string |
Oui |
Bruxelles - Zone RRUZ |
| municipal_land_use_plan |
boolean |
Oui |
Bruxelles - Plan communal de développement (PCD) |
| municipal_land_use_plan_note |
string |
Oui |
Bruxelles - Zone PCD |
| zoned_municipal_land_use_plan |
boolean |
Oui |
Bruxelles - Plan d'anénagement du sol (PPAS) |
| zoned_municipal_land_use_plan_note |
string |
Oui |
Bruxelles - Zone PPAS |
| specific_municipal_urban_planning_regulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme spécifique (RCUS) |
| specific_municipal_urban_planning_regulation_note |
string |
Oui |
Bruxelles - Zone/affectation RCUS |
| zoned_specific_municipal_urban_planning_regulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme zoné (RCUZ) |
| zoned_specific_municipal_urban_planning_regulation_note |
string |
Oui |
Bruxelles - Zone/affectation RCUZ |
| inventory_of_soil_condition |
string |
Oui |
Bruxelles - Inventaire de l'état du sol |
| heritage_protection |
boolean |
Oui |
Bruxelles - Protection du patrimoine |
| heritage_protection_note |
string |
Oui |
Bruxelles - Zone protection du patrimoine |
| preemption_right |
boolean |
Oui |
Bruxelles - Flandres - Droit de préemption |
| preemption_right_note |
string |
Oui |
Bruxelles - Flandres - Objet droit de préemption |
| summary_description_date |
date |
Oui |
Bruxelles - Date descriptif sommaire |
| summary_description_note |
string |
Oui |
Bruxelles - Note descriptif sommaire |
| urban_planning_information_date_of_request |
date |
Oui |
Bruxelles - Date demande renseignements urbanistiques |
| urban_planning_information_date_of_extraction |
date |
Oui |
Bruxelles - Date extrait renseignements urbanistiques |
| infractions_or_sanctions |
boolean |
Oui |
Bruxelles - Infractions et/ou sanctions |
| infractions_or_sanctions_note |
string |
Oui |
Bruxelles - Détails infractions et/ou sanctions |
| flood_zone |
string |
Oui |
Bruxelles - Zone inondable |
| arbitration_plan |
string |
Oui |
Flandres - Zone plan d'arbitrage |
| grup |
string |
Oui |
Flandres - Zone GRUP |
| prup |
string |
Oui |
Flandres - Zone PRUP |
| structure_plan |
boolean |
Oui |
Flandres - Plan de structure |
| structure_plan_note |
string |
Oui |
Flandres - Zone plan de structure |
| zoningplanflandres |
boolean |
Oui |
Flandres - Plan de zonage |
| zoning_plan_flandres_note |
string |
Oui |
Flandres - Zone plan de zonage |
| urban_planning_information |
boolean |
Oui |
Flandres - Informations sur l'urbanisme |
| urban_planning_information_date |
date |
Oui |
Flandres - Date informations sur l'urbanisme |
| floor_plan_test |
boolean |
Oui |
Flandres - Test du tapis de sol |
| floor_plan_test_note |
string |
Oui |
Flandres - Mesures du tapis de so |
| flood_zones_runoff_zones |
boolean |
Oui |
Flandres - Zones inondables/zones de ruissellement |
| flood_zones_runoff_zones_note |
string |
Oui |
Flandres - Risques zones inondables/zones de ruissellement |
| title |
|
|
|
| title |
array |
Oui |
Titre dans les différentes langues disponibles |
| description |
|
|
|
| description |
array |
Oui |
Description dans les différentes langues disponibles |
| confidential_information |
|
|
|
| confidential_information |
array |
Oui |
Informations confidentielles dans les différentes langues disponibles |
| visit_information |
|
|
|
| visit_information |
array |
Oui |
Informations de visites dans les différentes langues disponibles |
| agency_confidential_information |
|
|
|
| agency_confidential_information |
array |
Oui |
Informations confidentielles agence dans les différentes langues disponibles |
| surface_areas |
|
|
|
| area_unit |
string |
Oui |
Unité de surface |
| area_total |
float |
Oui |
Surface habitable indicative |
area_carrez_law |
float |
Oui |
Surface loi Carrez |
| area_land |
float |
Oui |
Surface du terrain |
| area_garden |
float |
Oui |
Surface du jardin |
area_living_room |
float |
Oui |
Surface du salon |
| area_terrace |
float |
Oui |
Surface du ou des terrasses |
| area_balcony |
float |
Oui |
Surface du ou des balcons |
| area_formatted |
float |
Oui |
Surface formaté avec l'unité |
| area_storeroom |
float |
Oui |
Surface de la réserve |
| area_ground |
float |
Oui |
Surface au sol |
area_land_registry |
float |
Oui |
Surface cadastrale |
| area_floor |
float |
Oui |
Surface plancher autorisée |
| area_ces |
float |
Oui |
Coefficient d'emprise au sol (CES) |
| formatted |
array |
Oui |
Surfaces formatées |
| rooms |
|
|
|
| rooms |
integer |
Oui |
Nombre de pièces |
| bedrooms |
integer |
Oui |
Nombre de chambres |
| bathrooms |
integer |
Oui |
Nombre de salle de bains |
| half_bathrooms |
integer |
Oui |
Nombre de salles d'eau |
| toilets |
integer |
Oui |
Nombre de WC |
| maid_rooms |
integer |
Oui |
Nombre de chambres de service |
| general |
|
|
|
| new_program |
boolean |
Oui |
Programme neuf |
new_program_delivery |
date |
Oui |
Date de livraison du programme neuf |
| garage |
integer |
Oui |
Nombre de garage / parking |
| outside |
integer |
Oui |
Nombre de parking extérieur |
| underground |
integer |
Oui |
Nombre de parkings en sous sol |
| location_number |
integer |
Oui |
Numéros de stationnements |
| visitor |
integer |
Oui |
Nombre de parking visiteurs |
| parkings_nearby |
boolean |
Oui |
Parkings proches |
| floor |
integer |
Oui |
Etage |
| level |
integer |
Oui |
Nombre de niveau |
| cellar |
integer |
Oui |
Nombres de caves |
| loggia |
integer |
Oui |
Nombres de loggias |
| attic |
integer |
Oui |
Nombre de greniers |
| convertible_attic |
boolean |
Oui |
Grenier aménageable |
| high_ceilings |
float |
Oui |
Hauteur sous plafond |
| minimum_division |
float |
Oui |
Division minimum |
shop_window_width |
float |
Oui |
Largeur vitrine |
| quiet_property |
boolean |
Oui |
Calme |
| shared_services |
boolean |
Oui |
Services communs |
| last_floor |
boolean |
Oui |
Dernier étage |
key_at_agency |
boolean |
Oui |
Clé à l'agence |
| building_permit |
boolean |
Oui |
Permis de construire |
building_permit_date |
date |
Oui |
Date du permis de construite |
| private_garden |
boolean |
Oui |
Jardin privatif |
| air_conditioning |
boolean |
Oui |
Climatisation |
| partition |
boolean |
Oui |
Cloisons |
| conduit |
boolean |
Oui |
Goulottes |
| investor_program |
boolean |
Oui |
Programme investisseur |
| furnished |
boolean |
Oui |
Meublé |
| fireplace |
boolean |
Oui |
Cheminée |
| construction_date |
date |
Oui |
Date de construction |
| outbuildings |
string |
Oui |
Dépendances |
| activities |
string |
Oui |
Activités |
| authorized_activities |
string |
Oui |
Activités autorisées |
| house_name |
string |
Oui |
Nom maison |
| school_nearby |
boolean |
Oui |
Ecoles proches |
convenient_store_nearby |
boolean |
Oui |
Commerces proches |
| transports_nearby |
boolean |
Oui |
Transports proches |
| viabilisation |
boolean |
Oui |
Viabilisation |
| facades_number |
integer |
Oui |
Nombre de façades |
| alarm |
boolean |
Oui |
Alarme |
possibility_of_liberal_profession |
boolean |
Oui |
Professionel autorisé |
| vehicle_number |
integer |
Oui |
Nombre de véhicules |
| park |
boolean |
Oui |
Parc |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| elevator |
boolean |
Oui |
Ascenseur |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| single_storey |
boolean |
Oui |
Plain-pied |
| interphone |
boolean |
Oui |
Interphone |
| digicode |
boolean |
Oui |
Digicode |
| characteristics |
|
|
|
| access |
|
|
|
| slug |
string |
Oui |
slug du type d'accès |
| adjoining_building |
|
|
|
| slug |
string |
Oui |
slug du type de mitoyenneté |
| closure |
|
|
|
| slug |
string |
Oui |
slug du type de fermetures |
| condition |
|
|
|
| slug |
string |
Oui |
slug du type état |
| configuration |
|
|
|
| slug |
string |
Oui |
slug du type de configuration |
| exposition |
|
|
|
| slug |
string |
Oui |
slug du type d'exposition principale |
| external_wall |
|
|
|
| slug |
string |
Oui |
slug du type de murs extérieurs |
| legal_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut juridique |
| floor |
|
|
|
| slug |
string |
Oui |
slug du type de revêtement sol |
| flooring |
|
|
|
| slug |
string |
Oui |
slug du type de plancher |
| garage_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut des garages |
| glazing |
|
|
|
| slug |
string |
Oui |
slug du type de vitrage |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| heating_method |
|
|
|
| slug |
string |
Oui |
slug du type d'énergie chauffage |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| kitchen |
|
|
|
| slug |
string |
Oui |
slug du type de cuisine |
| roof |
|
|
|
| slug |
string |
Oui |
slug du type de toiture |
| sanitation |
|
|
|
| slug |
string |
Oui |
slug du type d'assainissement |
| shutter |
|
|
|
| slug |
string |
Oui |
slug du type de volets |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| style |
|
|
|
| slug |
string |
Oui |
slug du type de style |
| surroundings |
|
|
|
| slug |
string |
Oui |
slug du type d'environnement |
| transferred_element |
|
|
|
| slug |
string |
Oui |
slug du type d'éléments céder |
| vegetation |
|
|
|
| slug |
string |
Oui |
slug du type de végétation |
| view_principal |
|
|
|
| slug |
string |
Oui |
slug du type de vue principale |
| view |
|
|
|
| slug |
string |
Oui |
slug du type de vue |
| woodwork |
|
|
|
| slug |
string |
Oui |
slug du type de menuiserie |
| optical_fiber |
|
|
|
| slug |
string |
Oui |
slug du type de fibre optique |
| financial |
|
|
|
| currency |
string |
Oui |
Unité monétaire |
| price |
float |
Oui |
Prix / Loyer |
| tax1_annual |
float |
Oui |
Taxe foncière |
| tax2_annual |
float |
Oui |
Taxe d'habitation |
| fees_annual |
float |
Oui |
Charges annuelles de copropriétés |
| honorary |
|
|
|
| honorary |
float |
Oui |
Honoraires |
| honorary_buyer |
float |
Oui |
Honoraires à la charge de l'aquéreur |
| honorary_seller |
float |
Oui |
Honoraires à la charge du vendeur |
| honorary_rate |
float |
Oui |
% d'honoraires |
honorary_rate_buyer |
float |
Oui |
% d'hHonoraires à la charge du vendeur |
honorary_rate_seller |
float |
Oui |
% d'hHonoraires à la charge de l'aquéreur |
| fee_type |
array |
Oui |
Type d'honoraires |
| slug |
string |
Oui |
slug du type d'honoraires |
| honorary_visit |
float |
Oui |
Honaires de visites |
| honorary_inventories |
float |
Oui |
Honoraire sde réalisation de l'état des lieux |
| rental |
|
|
|
is_student_rental |
boolean |
Oui |
Location étudiante |
is_seasonal_rental |
boolean |
Oui |
Location saisonnière |
| rent |
float |
Oui |
Loyer |
| rent_frequency |
string |
Oui |
Fréquence du loyer |
| income_annual |
float |
Oui |
Revenu annuel |
| charge |
float |
Oui |
Charges |
| charge_frequency |
string |
Oui |
Fréquence des charges |
| charge_included |
string |
Oui |
Charges incluses |
| security_deposit |
float |
Oui |
Dépot de garantie |
| charge_modality |
array |
Oui |
Modalités des charges |
| slug |
string |
Oui |
slug des modalités des charges |
| building |
|
|
|
| elevator |
boolean |
Oui |
Ascenseur |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| park |
boolean |
Oui |
Parc |
| numberoffloors |
integer |
Oui |
Nombre d'étages |
| numberoflots |
integer |
Oui |
Nombre de lots |
| last_renovating_facade |
date |
Oui |
Date du dernier ravalement de façade |
| outbuildings |
string |
Oui |
Dépendances |
| period |
string |
Oui |
Période |
| caretaker |
boolean |
Oui |
Concierge |
| garden |
boolean |
Oui |
Jardin |
| secure_access |
boolean |
Oui |
Accès sécurisé |
| private_garden |
boolean |
Oui |
Jardin privatif |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| parking_lot |
boolean |
Oui |
Parking collectif |
| works_planned |
boolean |
Oui |
Travaux prévu |
| children_playground |
boolean |
Oui |
Jardin d'enfants |
| bike_storage |
boolean |
Oui |
Local à vélo |
| laundry |
boolean |
Oui |
Buanderie |
| sports_hall |
boolean |
Oui |
Salle de sport |
| surveillance |
boolean |
Oui |
Surveillance 24/24 |
| interphone |
boolean |
Oui |
Interphone |
| videophone |
boolean |
Oui |
Vidéophone |
| digicode |
boolean |
Oui |
Digicode |
| characteristics |
|
|
|
| construction |
|
|
|
| slug |
string |
Oui |
slug du type de construction |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| open_doors |
|
|
|
| date |
date |
Non |
Date |
| start_time |
time |
Non |
Heure de début |
| end_time |
time |
Non |
Heure de fin |
| informations |
string |
Oui |
Informations |
| price_evolutions |
|
|
|
| date |
date |
Non |
Date de l'évolution du prix |
| old_price |
float |
Non |
Ancien prix |
| new_price |
float |
Non |
Nouveau prix |
| price_evolution_type |
array |
Oui |
Type d'évolution |
| slug |
string |
Oui |
Slug |
| rooms_details |
|
|
|
| floor |
string |
Oui |
Sol |
| wall |
string |
Oui |
Murs |
| storage |
boolean |
Oui |
Placard |
| balcony |
boolean |
Oui |
Balcon |
| terrace |
boolean |
Oui |
Terrasse |
| garden |
boolean |
Oui |
Jardin |
| name |
string |
Oui |
Nom de la pièce |
| air_conditioning |
boolean |
Oui |
Climatisation |
| comments |
string |
Oui |
Commentaires |
| level |
integer |
Oui |
Niveau |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
string |
Oui |
Surface formatée |
| lots_details |
|
|
|
| lot_number |
string |
Oui |
Numéro du lot |
| lot_number_seconadry |
string |
Oui |
Numéro des lots secondaire |
| is_rent |
boolean |
Oui |
Loué |
| rent |
float |
Oui |
Loyer |
lease_end_date |
date |
Oui |
Fin du bail |
| lease_type |
array |
Oui |
Type de bail |
| slug |
string |
Oui |
Slug du type de bail |
| name |
string |
Oui |
Nom du type de bail |
| lot_type |
array |
Oui |
Type de lot |
| slug |
string |
Oui |
Slug |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
array |
Oui |
Surface formatée |
| description |
array |
Oui |
Description dans les langues disponibles |
| confidential_information |
array |
Oui |
|
Réponse
{
"id": "b1eMQv",
"uid": null,
"reference": "MLS236053",
"online_at": "2023-11-28T17:15:08.000+01:00",
"created_at": "2024-06-04T13:32:02.840+02:00",
"updated_at": "2024-06-04T13:32:02.840+02:00",
"offline_at": null,
"is_on_portal": true,
"is_mls": false,
"is_private": true,
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
},
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387XXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
}
},
"user": {
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Someone",
"last_name": "XXXXX",
"full_name": "Someone XXXXX",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "xxx@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406+02:00",
"updated_at": "2024-06-18T11:34:30.089+02:00"
},
"mandate": {
"cadastre": "",
"number": "1345",
"co_ownership": true,
"lot_number": "100",
"lot_number_secondary": "S100, A985, P789",
"start_date": "2023-11-28",
"end_date": "2024-11-28",
"effect_date": "2023-11-28",
"urgency_sale": true,
"slug": "exclusive",
"name": {
"fr": "Exclusif",
"en": "Exclusive",
"es": "En Exclusiva",
"it": "Esclusivo",
"nl": "Exclusief",
"pt": null,
"de": null
}
},
"property_type": {
"slug": "house",
"name": {
"fr": "Maison",
"en": "House",
"es": "Chalet",
"it": "Casa",
"nl": "Huis",
"pt": null,
"de": null
},
"sub_type": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"transaction_type": {
"slug": "under-offer",
"name": {
"fr": "Sous offre",
"en": "Under offer",
"es": "En venta",
"it": "In vendita",
"nl": "Onder voorstellen",
"pt": null,
"de": null
}
},
"transaction_status": {
"slug": "for-sale",
"name": {
"fr": "A vendre",
"en": "For sale",
"es": "En venta",
"it": "In vendita",
"nl": "Te koop",
"pt": "",
"de": "",
"ru": ""
},
"sub_status": {
"end_market_date": null,
"offer_accepted_date": null,
"compromise_date": null,
"sold_or_rent_date": null,
"withdrawal_date": null,
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"lease": {
"is_sold_with_tenant": true,
"availability_date": "2024-03-21",
"slug": "professional",
"name": {
"fr": "Professionnel",
"en": "Professional",
"es": "Profesional",
"it": "Professionista",
"nl": "Professioneel",
"pt": null,
"de": null
}
},
"life_lease": {
"is_life_lease": false,
"venal_value": null,
"life_annuity": null,
"life_lease_type": {
"slug": "free",
"name": {
"fr": "Viager libre ",
"fr-BE": "Viager libre ",
"fr-CA": "Viager libre ",
"en": "Free ",
"es": "Viager libre ",
"es-LA": "Viager libre ",
"it": "Viager libre ",
"nl": "Viager vrij",
"pt": "Viager libre ",
"pt-BR": "Viager libre ",
"de": "Viager libre ",
"ru": "Viager libre "
}
}
},
"pictures": [
{
"url": "https://xxxx.com/name.jpg",
"name": "name.jpg",
"order": 1,
"allowed_to_display": true
},
{
"url": "https://xxxx.com/name.png",
"name": "name.jpg",
"order": 2,
"allowed_to_display": true
}
],
"documents": [
{
"id": "x5zjX8",
"name": "name.pdf",
"title": null,
"url": "https://xxxx.com/name.pdf",
"order": 1,
"file_size": "1012168",
"document_type": "plans",
"content_type": "application/pdf",
"allowed_to_display": true
},
{
"id": "JYdlK8",
"name": "name.png",
"title": null,
"url": "https://xxxx.com/name.png",
"order": 2,
"file_size": "49786",
"document_type": "",
"content_type": "image/png",
"allowed_to_display": true
}
],
"virtual_visits": [],
"address": {
"allowed_to_display": true,
"address_formatted": "310 Avenue de Provence, 83600 Fréjus",
"street_number": "310",
"street_name": "Avenue de Provence",
"zipcode": "83600",
"locality": "Frejus",
"sublocality": "Frejus Plage",
"latitude": 43.4279,
"longitude": 6.74036,
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Var",
"country": "France",
"country_iso_code": "fr"
},
"country_detail": {
"fr": {
"dpe": {
"date_start": "2024-02-08",
"date_end": null,
"dpe_letter": "C",
"dpe_value": 130.0,
"ges_letter": "C",
"ges_value": 21.0,
"dpe_lower_price": null,
"dpe_higher_price": null,
"dpe_year_reference": null,
"dpe_url": null
},
"alur": {
"procedure_in_progress": false,
"procedure_details": "",
"number_of_lots": 100
}
},
"be": {
"peb": {
"date_start": "2025-03-12",
"peb_letter": "B",
"peb_number": "1487596",
"peb_energy_value": 256.0,
"peb_emission_value": 356.0,
"peb_consumption_total": 1500.0
},
"diagnosis": {
"electrical_inspection": "compliant",
"electrical_inspection_date": "2025-03-14",
"electrical_wiring_diagrams": true,
"gas_inspection": "requested",
"gas_inspection_date": "2025-03-13",
"certibeau_date": "2025-03-13",
"certibeau_number": "Test certibeau",
"tank_type": "mazout",
"tank_date": "2025-03-12",
"tank_number": "A7895",
"tank_color": "orange",
"class_three_declaration_date": "2025-03-13",
"class_three_declaration_object": "Classe3",
"class_three_declaration_note": "Note classe 3",
"abestos_type": "none",
"abestos_date": "2025-03-13"
},
"urbanism": {
"zoning_plan": null,
"territorial_development_plan": null,
"intermunicipal_development_plan": null,
"intermunicipal_development_plan_note": null,
"local_interpretation_plan": null,
"local_interpretation_plan_note": null,
"regional_guide": null,
"regional_guide_note": null,
"municipal_development_plan": null,
"municipal_development_plan_note": null,
"municipal_guide": null,
"municipal_guide_note": null,
"soil_condition_database": null,
"flood_prone_area_due_to_overflow": null,
"flood_prone_area_due_to_runoff": null,
"runoff_concentration_axes": null,
"cu1_urban_planning_information": null,
"cu1_urban_planning_information_date": null,
"cu2": null,
"building_permit_date": null,
"building_permit_note": null,
"urbanization_permit_date": "2025-03-13",
"urbanization_permit_note": "permis d'urbanisation",
"operating_permit_date": "2025-03-21",
"operating_permit_note": "permis d'exploiter",
"rent_permit_date": "2025-03-20",
"rent_permit_note": "permis de location",
"regional_land_use_plan": "none",
"master_development_plan": true,
"master_development_plan_note": "Test PAD",
"regional_urban_planning_regulations": "",
"zoned_regional_urban_planning_regulations": true,
"zoned_regional_urban_planning_regulations_note": "Test RRUZ",
"municipal_land_use_plan": true,
"municipal_land_use_plan_note": "Test PCD",
"zoned_municipal_land_use_plan": true,
"zoned_municipal_land_use_plan_note": "TEST PPAS",
"specific_municipal_urban_planning_regulation": true,
"specific_municipal_urban_planning_regulation_note": "Test RCUS",
"zoned_specific_municipal_urban_planning_regulation": true,
"zoned_specific_municipal_urban_planning_regulation_note": "Test RCUSZ",
"inventory_of_soil_condition": "none",
"heritage_protection": true,
"heritage_protection_note": "Test protection patrimoine",
"preemption_right": true,
"preemption_right_note": "Test droit de préemption",
"summary_description_date": "2025-03-12",
"summary_description_note": null,
"urban_planning_information_date_of_request": "2025-03-06",
"urban_planning_information_date_of_extraction": "2025-03-04",
"infractions_or_sanctions": true,
"infractions_or_sanctions_note": "Test infractions",
"flood_zone": "medium",
"arbitration_plan": null,
"grup": null,
"prup": null,
"structure_plan": null,
"structure_plan_note": null,
"zoning_plan_flandres": null,
"zoning_plan_flandres_note": null,
"urban_planning_information": null,
"urban_planning_information_date": null,
"floor_plan_test": null,
"floor_plan_test_note": null,
"flood_zones_runoff_zones": null,
"flood_zones_runoff_zones_note": null,
"cadastrale_locality": null,
"cadastrale_division": null,
"cadastrale_section": null,
"cadastrale_parcel_number": null
}
},
"it": null
},
"title": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"visit_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"agency_confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"url_more_infos": "https://www.test.com",
"surface_areas": {
"area_unit": "m2",
"area_total": 140.0,
"area_carrez_law": 140.0,
"area_living_room": 34.0,
"area_terrace": 3.0,
"area_garden": 786.0,
"area_land": 123.0,
"area_storeroom": null,
"area_ground": null,
"area_land_registry": 1.0,
"area_balcony": 3.0,
"area_floor": 64.0,
"area_ces": 76.0,
"formatted": {
"area_total": "140 m<sup>2</sup>",
"area_carrez_law": "140 m<sup>2</sup>",
"area_living_room": "34 m<sup>2</sup>",
"area_terrace": "3 m<sup>2</sup>",
"area_garden": "786 m<sup>2</sup>",
"area_land": "123 m<sup>2</sup>",
"area_storeroom": null,
"area_ground": null,
"area_land_registry": "1 m<sup>2</sup>",
"area_balcony": "3 m<sup>2</sup>",
"area_floor": "64 m<sup>2</sup>",
"area_ces": "76 m<sup>2</sup>"
}
},
"rooms": {
"rooms": 7,
"bedrooms": 4,
"bathrooms": 0,
"half_bathrooms": 2,
"toilets": 2,
"maid_rooms": 8
},
"general": {
"new_program": true,
"new_program_delivery": "2024-03-28",
"garage": 2,
"outside": 2,
"underground": 1,
"location_number": "",
"visitor": 1,
"parkings_nearby": true,
"floor": 0,
"level": 0,
"cellar": 2,
"loggia": false,
"attic": 1,
"convertible_attic": true,
"high_ceilings": 233.0,
"minimum_division": 0.0,
"shop_window_width": 0.0,
"quiet_property": true,
"shared_services": null,
"last_floor": false,
"key_at_agency": true,
"building_permit": true,
"building_permit_date": "2024-03-22",
"private_garden": null,
"air_conditioning": true,
"partition": null,
"conduit": null,
"investor_program": true,
"furnished": true,
"fireplace": true,
"construction_date": "2024-03-07",
"outbuildings": "Grange jardin",
"activities": "",
"authorized_activities": "",
"house_name": "",
"school_nearby": true,
"convenient_store_nearby": true,
"transports_nearby": true,
"viabilisation": null,
"facades_number": 0,
"alarm": true,
"possibility_of_liberal_profession": true,
"vehicle_number": null,
"park": null,
"pool": true,
"tennis": true,
"elevator": true,
"handicapped_access": true,
"single_storey": true,
"interphone": true,
"digicode": true,
"balcony": null,
"terrace": null
},
"characteristics": {
"access": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"adjoining_building": {
"slug": "detached",
"name": {
"fr": "Individuelle",
"en": "Detached",
"es": "Individual",
"it": "Individuale",
"nl": "Open bebouwing",
"pt": null,
"de": null
}
},
"closure": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"condition": {
"slug": "excellent-condition",
"name": {
"fr": "Très bon état",
"en": "Excellent condition",
"es": "Excellent état",
"it": "Ottimo stato",
"nl": "Excellent état",
"pt": null,
"de": null
}
},
"configuration": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"exposition": {
"slug": "north-east",
"name": {
"fr": "Nord-Est",
"en": "North-East",
"es": "Nor-Este",
"it": "Nord-Est",
"nl": "Noord-Oost",
"pt": null,
"de": null
}
},
"external_wall": {
"slug": "crepis",
"name": {
"fr": "Crépis",
"en": "Crépis",
"es": "Crépis",
"it": "Crépis",
"nl": null,
"pt": null,
"de": null
}
},
"legal_status": {
"slug": "free-property",
"name": {
"fr": "Nue-propriété",
"en": "Bare property",
"es": "Propiedad compartida",
"it": "Indivisa",
"nl": "Indivision",
"pt": null,
"de": null
}
},
"floor": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"flooring": {
"slug": "woog",
"name": {
"fr": "Bois",
"en": "Woog",
"es": "Madera",
"it": "Legno",
"nl": "Hout",
"pt": null,
"de": null
}
},
"garage_status": {
"slug": "excluded",
"name": {
"fr": "En sus",
"en": "Excluded",
"es": "Excluidos",
"it": "Esclusi",
"nl": "Uitgesloten",
"pt": null,
"de": null
}
},
"glazing": {
"slug": "double",
"name": {
"fr": "Double vitrage",
"en": "Double glazing",
"es": "Doble",
"it": "Doppi",
"nl": "Dubbele",
"pt": null,
"de": null
}
},
"heating": {
"slug": "electric-radiator",
"name": {
"fr": "Convecteur",
"en": "Electric radiator",
"es": "Convecteur",
"it": "Convettori",
"nl": "Convector",
"pt": null,
"de": null
}
},
"heating_method": {
"slug": "climatisation",
"name": {
"fr": "Climatisation",
"en": "Climatisation",
"es": "Climatisation",
"it": "Climatizzazione",
"nl": "Climatisation",
"pt": null,
"de": null
}
},
"hot_water": {
"slug": "fuel",
"name": {
"fr": "Fioul",
"en": "Fuel",
"es": "Gasoil",
"it": "Gasolio",
"nl": "Stookolie",
"pt": null,
"de": null
}
},
"kitchen": {
"slug": "full-equiped",
"name": {
"fr": "Equipée",
"en": "Full equiped",
"es": "Equipada",
"it": "Attrezzata",
"nl": "Volledig ingericht",
"pt": null,
"de": null
}
},
"roof": {
"slug": "thatch",
"name": {
"fr": "Chaume",
"en": "Thatch",
"es": "Paja",
"it": "Paglia",
"nl": "Riet",
"pt": null,
"de": null
}
},
"sanitation": {
"slug": "sewer",
"name": {
"fr": "Egout",
"en": "Sewer",
"es": "Canal Reglamentario",
"it": "Fogna",
"nl": "Riool",
"pt": null,
"de": null
}
},
"shutter": {
"slug": "electric",
"name": {
"fr": "Roulants électriques",
"en": "Electric roller blind",
"es": "Roulants élec.",
"it": "Tapparelle elec.",
"nl": "Elektrisch",
"pt": null,
"de": null
}
},
"standing": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"style": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"surroundings": {
"slug": "city-houses",
"name": {
"fr": "Pavillonnaire",
"en": "City houses",
"es": "Urbanizacion de chalets",
"it": "Residenziale",
"nl": "Pavillonnaire",
"pt": null,
"de": null
}
},
"transferred_element": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"vegetation": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"view_principal": {
"slug": "panoramic",
"name": {
"fr": "Panoramique",
"en": "Panoramic",
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null,
"ru": null
}
},
"view": {
"slug": "sea",
"name": {
"fr": "Mer",
"en": "Sea",
"es": "Mar",
"it": "Mare",
"nl": "Zee",
"pt": null,
"de": null
}
},
"woodwork": {
"slug": "mixt",
"name": {
"fr": "Mixte",
"en": "Mixt",
"es": "Mixte",
"it": "Mixte",
"nl": "Mixte",
"pt": null,
"de": null
}
},
"optical_fiber": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
},
"financial": {
"currency": "eur",
"price": 13890000.0,
"tax1_annual": 6754.0,
"tax2_annual": 7890.0,
"fees_annual": 1200.0,
"offer_from": false,
"tax_system": {
"slug": "vat",
"name": {
"fr": "TVA",
"fr-BE": "TVAC",
"fr-CA": "TVA",
"en": "VAT",
"es": "IVA",
"es-LA": "IVA",
"it": "IVA",
"nl": "TVA",
"pt": "TVA",
"pt-BR": "TVA",
"de": "TVA",
"ru": "TVA"
}
},
"honorary": {
"honorary": 800000.0,
"honorary_buyer": 0.0,
"honorary_seller": 800000.0,
"honorary_rate": 5.75,
"honorary_rate_buyer": 0.0,
"honorary_rate_seller": 5.75,
"fee_type": {
"slug": "vendeur",
"name": {
"fr": "Vendeur",
"en": "Vendeur",
"es": "Vendeur",
"it": "Vendeur",
"nl": null,
"pt": null,
"de": null
}
},
"honorary_visit": 0.0,
"honorary_inventories": 0.0
},
"rental": {
"is_student_rental": false,
"is_seasonal_rental": false,
"rent": 1300.0,
"rent_frequency": "monthly",
"income_annual": 0.0,
"charge": 0.0,
"charge_frequency": "monthly",
"charge_included": true,
"security_deposit": 0.0,
"charge_modality": {
"slug": "forfaitaires-mensuelles",
"name": {
"fr": "Forfaitaires mensuelles",
"en": "Forfaitaires mensuelles",
"es": "Forfaitaires mensuelles",
"it": "Forfaitaires mensuelles",
"nl": null,
"pt": null,
"de": null
}
}
},
"formatted": {
"european_format": {
"price": "13 890 000 €",
"tax1_annual": "6 754 €",
"tax2_annual": "7 890 €",
"fees_annual": "1 200 €",
"honorary": {
"honorary": "800 000 €",
"honorary_buyer": "",
"honorary_seller": "800 000 €",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "1 300 €",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
},
"american_format": {
"price": "€13,890,000",
"tax1_annual": "€6,754",
"tax2_annual": "€7,890",
"fees_annual": "€1,200",
"honorary": {
"honorary": "€800,000",
"honorary_buyer": "",
"honorary_seller": "€800,000",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "€1,300",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
}
}
},
"building": {
"name": "Boulevard Saint-Roch (15 Bis)",
"elevator": true,
"pool": true,
"tennis": false,
"park": false,
"number_of_floors": 4,
"number_of_lots": null,
"last_renovating_facade": "2014-05-21",
"outbuildings": null,
"period": "1950",
"caretaker": true,
"garden": false,
"secure_access": false,
"private_garden": false,
"handicapped_access": false,
"parking_lot": true,
"works_planned": false,
"children_playground": false,
"bike_storage": true,
"laundry": false,
"sports_hall": true,
"surveillance": true,
"interphone": true,
"videophone": false,
"digicode": true,
"created_at": "2021-09-27T15:40:42.908094+02:00",
"updated_at": "2023-07-07T16:08:49.960744+02:00",
"characteristics": {
"construction": {
"slug": "concrete",
"name": {
"fr": "Béton",
"fr-BE": "Béton",
"fr-CA": "Béton",
"en": "Concrete",
"es": "Hormigón",
"es-LA": "Hormigón",
"it": "Cemento",
"nl": "",
"pt": "Béton",
"pt-BR": "Béton",
"de": "Béton",
"ru": "Béton"
}
},
"heating": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"hot_water": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"standing": {
"slug": "good",
"name": {
"fr": "Standing",
"fr-BE": "Standing",
"fr-CA": "Standing",
"en": "Good",
"es": "Standing Medio",
"es-LA": "Standing Medio",
"it": "Livello Medio",
"nl": "Standing",
"pt": "Standing",
"pt-BR": "Standing",
"de": "Standing",
"ru": "Standing"
}
}
}
},
"open_doors": [
{
"id": "dXAMXj",
"date": "2023-12-23",
"start_time": "2000-01-01T16:00:00.000000+01:00",
"end_time": "2000-01-01T19:00:00.000000+01:00",
"informations": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
{
"id": "yQY35l",
"date": "2023-11-15",
"start_time": "2000-01-01T15:50:00.000000+01:00",
"end_time": "2000-01-01T17:50:00.000000+01:00",
"informations": "LOrem ipsum"
},
{
"id": "zQ4x0Q",
"date": "2024-01-19",
"start_time": "2000-01-01T10:27:00.000000+01:00",
"end_time": "2000-01-01T10:27:00.000000+01:00",
"informations": "Lorem"
},
{
"id": "VvgDP5",
"date": "2025-05-31",
"start_time": "2000-01-01T10:00:00.000000+01:00",
"end_time": "2000-01-01T12:00:00.000000+01:00",
"informations": "Lorem ipsum dolor sit amet"
}
],
"price_evolutions": [
{
"date": "2024-06-10T19:42:40.145317+02:00",
"old_price": 150000.0,
"new_price": 152000.0,
"price_evolution_type": {
"slug": "price_increase",
"name": {
"fr": "Hausse de prix",
"fr-BE": "Hausse de prix",
"fr-CA": "Hausse de prix",
"en": "Price increase",
"es": "Hausse de prix",
"es-LA": "Hausse de prix",
"it": "Hausse de prix",
"nl": "Hausse de prix",
"pt": "Hausse de prix",
"pt-BR": "Hausse de prix",
"de": "Hausse de prix",
"ru": "Hausse de prix"
}
}
}
],
"rooms_details": [],
"lot_details": []
}Mise à jour (Droits supplémentaires requis)
Cette route vous permet de mettre à jour une propriété
Endpoint
PATCH https://app.mls-connect.com/fr/api/v3/properties/:id
JSON parameters
| Node |
Type |
Nullable |
Description |
| uid |
string |
Oui |
Référence de la source d'import |
| mls_board |
|
|
|
| id |
string |
Non |
ID du MLS |
| agency |
Oui |
|
|
| id |
string |
Non |
ID de l'agence |
| user |
Oui |
|
|
| id |
string |
Non |
ID de l'utilisateur |
| mandate |
Oui |
|
|
| cadastre |
string |
Oui |
Référence cadastrale |
| number |
string |
Oui |
Numéro de mandat |
| co_ownership |
boolean |
Oui |
Si en copropriété |
| start_date |
datetime |
Oui |
Date de début de mandat |
| end_date |
datetime |
Oui |
Date de fin de mandat |
| effect_date |
datetime |
Oui |
Date d'effet |
| urgency_sale |
boolean |
Oui |
Vente urgente |
| slug |
string |
Oui |
slug du type de mandat |
| property_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de propriété |
| sub_type |
Oui |
|
|
| slug |
string |
Oui |
slug du sous type de propriété |
| transaction_type |
Oui |
|
|
| slug |
string |
Non |
slug du type de transaction |
| transaction_status |
Oui |
|
|
| slug |
string |
Non |
slug du type de statut original de transaction |
| sub_status |
Oui |
|
|
end_market_date |
datetime |
Oui |
Date de retrait du marché |
offer_accepted_date |
datetime |
Oui |
Date acceptation de l'offre |
| compromise_date |
datetime |
Oui |
Date sous compromis |
sold_or_rent_date |
datetime |
Oui |
Date vendu ou loué |
| withdrawal_date |
datetime |
Oui |
Date de passage en retiré |
| slug |
string |
Oui |
slug du statut |
| lease |
Oui |
|
|
is_sold_with_tenant |
boolean |
Oui |
Vendu occupé |
| availability_date |
datetime |
Oui |
Date de disponibilité |
| slug |
string |
Oui |
slug du type de bail |
| life_lease |
Oui |
|
|
is_life_lease |
boolean |
Oui |
Viager oui/non |
| venal_value |
float |
Oui |
Valeur vénale |
| life_annuity |
float |
Oui |
Rente annuelle |
life_lease_type |
array |
Oui |
Type de viager |
| slug |
string |
Oui |
slug du type de viager |
| pictures |
|
|
|
| url |
string |
Oui |
Url de la photo |
| name |
string |
Oui |
Nom de la photo |
| order |
string |
Oui |
Position de la photo |
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| documents |
|
|
|
| name |
string |
Oui |
Nom du document |
| url |
string |
Non |
Url du document |
| order |
string |
Non |
Position du document |
| file_size |
string |
Non |
Taille du document |
| document_type |
string |
Non |
Type du document |
| content_type |
string |
Non |
|
allowed_to_display |
boolean |
Oui |
Autorisé à être affiché |
| virtual_visits |
|
|
|
| name |
string |
Oui |
Nom de la visite virtuelle |
| url |
string |
Oui |
Url de la visite virtuelle |
| address |
|
|
|
allowed_to_display |
boolean |
Non |
Autorisé à être affiché |
address_formatted |
string |
Non |
Adresse formatée |
| street_number |
string |
Oui |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postale |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Non |
Quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
administrative_area_level1 |
string |
Non |
Région |
administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
country_iso_code |
string |
Non |
Code ISO du pays |
| country_detail |
Oui |
|
|
| fr |
Oui |
|
|
| dpe |
Oui |
|
|
| dpe_number |
string |
Oui |
Numéro du DPE |
| date_start |
datetime |
Oui |
Date de début du DPE |
| date_end |
datetime |
Oui |
Date de fin de validité du DPE |
| dpe_letter |
string |
Oui |
Lettre DPE (A à G) |
| dpe_value |
float |
Oui |
Valeur DPE (kWh/m²/an) |
| ges_letter |
string |
Oui |
Lettre GES (A à G) |
| ges_value |
float |
Oui |
Valeur GES (kg CO2/m²/an) |
dpe_lower_price |
float |
Oui |
Estimation basse des dépenses énergétiques annuelles |
dpe_higher_price |
float |
Oui |
Estimation haute des dépenses énergétiques annuelles |
dpe_year_reference |
date |
Oui |
Année de référence du DPE |
| dpe_url |
string |
Oui |
URL du document DPE |
| dpenosubject_to |
boolean |
Oui |
Non soumis au DPE |
| alur |
|
|
|
procedure_in_progress |
boolean |
Oui |
Procédure en cours sur la copropriété |
procedure_details |
string |
Oui |
Détails de la procédure |
number_of_lots |
integer |
Oui |
Nombre de lots |
| be |
Oui |
|
|
| peb |
Oui |
|
|
| date_start |
datetime |
Oui |
Date du certicat |
| peb_letter |
string |
Oui |
Lettre PEB |
| peb_number |
string |
Oui |
Numéro PEB |
| peb_energy_value |
float |
Oui |
Performance énérgétique (en kWh/h/an) |
| peb_emission_value |
float |
Oui |
Emission CO2 (en m2/an) |
| peb_consumption_total |
float |
Oui |
Consommation totale (en kWh/h/an) |
| diagnosis |
Oui |
|
|
| electrical_inspection |
string |
Oui |
Contrôle électrique |
| electrical_inspection_date |
date |
Oui |
Date du contrôle électrique |
| electrical_wiring_diagrams |
boolean |
Oui |
Schémas filaires |
| gas_inspection |
string |
Oui |
Contrôle gaz |
| gas_inspection_date |
date |
Oui |
Date du contrôle gaz |
| certibeau_date |
date |
Oui |
Date du certibeau |
| certibeau_number |
string |
Oui |
Numéro du certibeau |
| tank_type |
string |
Oui |
Type de citerne |
| tank_date |
date |
Oui |
Date |
| tank_number |
string |
Oui |
Numéro |
| tank_color |
string |
Oui |
Couleur |
| class_three_declaration_date |
date |
Oui |
Date déclaration de classe 3 |
| class_three_declaration_object |
string |
Oui |
Objet déclaration de classe 3 |
| class_three_declaration_note |
string |
Oui |
Note déclaration de classe 3 |
| abestos_type |
string |
Oui |
Type amiante |
| abestos_date |
date |
Oui |
Date du test d'amiante |
| urbanism |
Oui |
|
|
| zoning_plan |
string |
Oui |
Wallonie - Plan de secteur |
| territorial_development_plan |
string |
Oui |
Wallonie - Schéma de développement du territoire (SDT) |
| intermunicipal_development_plan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| intermunicipal_development_plan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| local_interpretation_plan |
boolean |
Oui |
Wallonie - Schéma d'orientation local (SOL) |
| local_interpretation_plan_note |
string |
Oui |
Wallonie - Zone SOL |
| regional_guide |
boolean |
Oui |
Wallonie - Guide régional |
| regional_guide_note |
string |
Oui |
Wallonie - Objet guide régional |
| municipal_development_plan |
boolean |
Oui |
Wallonie - Schéma de développement Pluricommunal (SDP) |
| municipal_development_plan_note |
string |
Oui |
Wallonie - Zone/Affectation SDP |
| municipal_guide |
boolean |
Oui |
Wallonie - Guide communal |
| municipal_guide_note |
string |
Oui |
Wallonie - Zone de guide communal |
| soil_condition_database |
string |
Oui |
Wallonie - Banque de données de l'état du sol (BDES) |
| flood_prone_area_due_to_overflow |
string |
Oui |
Wallonie - Zone inondable par débordement |
| flood_prone_area_due_to_runoff |
string |
Oui |
Wallonie - Zone inondable par ruissellement |
| cu2 |
boolean |
Oui |
Wallonie - CU2 |
| cu1_urban_planning_information |
boolean |
Oui |
Wallonie - CU1 / renseignements urbanistiques |
| cu1_urban_planning_information_date |
date |
Oui |
Wallonie - Date CU1 / renseignements urbanistiques |
| building_permit_date |
date |
Oui |
Wallonie - Flandres - Date du permis de contruire |
| building_permit_note |
string |
Oui |
Wallonie - Flandres - Permis de construire |
| urbanization_permit_date |
date |
Oui |
Wallonie - Bruxelles - Date permis d'urbanisation |
| urbanization_permit_note |
string |
Oui |
Wallonie - Bruxelles - Permis d'urbanisation |
| operating_permit_date |
date |
Oui |
Wallonie - Bruxelles - Date permis d'exploiter |
| operating_permit_note |
string |
Oui |
Wallonie - Bruxelles - Permis d'exploiter |
| rent_permit_date |
date |
Oui |
Wallonie - Bruxelles - Flandres - Date permis de location |
| rent_permit_note |
string |
Oui |
Wallonie - Bruxelles - Flandres - Note permis de location |
| regional_land_use_plan |
string |
Oui |
Bruxelles - Plan régional d'affectation (PRAS) |
| regional_urban_planning_regulations |
string |
Oui |
Bruxelles - Règlement régional d'urbanisme (RRU) |
| master_development_plan |
boolean |
Oui |
Bruxelles - Plan d'aménagement directeur (PAD) |
| master_development_plan_note |
string |
Oui |
Bruxelles - Zone PAD |
| zoned_regional_urban_planning_regulations |
boolean |
Oui |
Bruxelles - Règlement régional d'urbanisme zoné (RRUZ) |
| zoned_regional_urban_planning_regulations_note |
string |
Oui |
Bruxelles - Zone RRUZ |
| municipal_land_use_plan |
boolean |
Oui |
Bruxelles - Plan communal de développement (PCD) |
| municipal_land_use_plan_note |
string |
Oui |
Bruxelles - Zone PCD |
| zoned_municipal_land_use_plan |
boolean |
Oui |
Bruxelles - Plan d'anénagement du sol (PPAS) |
| zoned_municipal_land_use_plan_note |
string |
Oui |
Bruxelles - Zone PPAS |
| specific_municipal_urban_planning_regulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme spécifique (RCUS) |
| specific_municipal_urban_planning_regulation_note |
string |
Oui |
Bruxelles - Zone/affectation RCUS |
| zoned_specific_municipal_urban_planning_regulation |
boolean |
Oui |
Bruxelles - Règlement communal d'urbanisme zoné (RCUZ) |
| zoned_specific_municipal_urban_planning_regulation_note |
string |
Oui |
Bruxelles - Zone/affectation RCUZ |
| inventory_of_soil_condition |
string |
Oui |
Bruxelles - Inventaire de l'état du sol |
| heritage_protection |
boolean |
Oui |
Bruxelles - Protection du patrimoine |
| heritage_protection_note |
string |
Oui |
Bruxelles - Zone protection du patrimoine |
| preemption_right |
boolean |
Oui |
Bruxelles - Flandres - Droit de préemption |
| preemption_right_note |
string |
Oui |
Bruxelles - Flandres - Objet droit de préemption |
| summary_description_date |
date |
Oui |
Bruxelles - Date descriptif sommaire |
| summary_description_note |
string |
Oui |
Bruxelles - Note descriptif sommaire |
| urban_planning_information_date_of_request |
date |
Oui |
Bruxelles - Date demande renseignements urbanistiques |
| urban_planning_information_date_of_extraction |
date |
Oui |
Bruxelles - Date extrait renseignements urbanistiques |
| infractions_or_sanctions |
boolean |
Oui |
Bruxelles - Infractions et/ou sanctions |
| infractions_or_sanctions_note |
string |
Oui |
Bruxelles - Détails infractions et/ou sanctions |
| flood_zone |
string |
Oui |
Bruxelles - Zone inondable |
| arbitration_plan |
string |
Oui |
Flandres - Zone plan d'arbitrage |
| grup |
string |
Oui |
Flandres - Zone GRUP |
| prup |
string |
Oui |
Flandres - Zone PRUP |
| structure_plan |
boolean |
Oui |
Flandres - Plan de structure |
| structure_plan_note |
string |
Oui |
Flandres - Zone plan de structure |
| zoningplanflandres |
boolean |
Oui |
Flandres - Plan de zonage |
| zoning_plan_flandres_note |
string |
Oui |
Flandres - Zone plan de zonage |
| urban_planning_information |
boolean |
Oui |
Flandres - Informations sur l'urbanisme |
| urban_planning_information_date |
date |
Oui |
Flandres - Date informations sur l'urbanisme |
| floor_plan_test |
boolean |
Oui |
Flandres - Test du tapis de sol |
| floor_plan_test_note |
string |
Oui |
Flandres - Mesures du tapis de so |
| flood_zones_runoff_zones |
boolean |
Oui |
Flandres - Zones inondables/zones de ruissellement |
| flood_zones_runoff_zones_note |
string |
Oui |
Flandres - Risques zones inondables/zones de ruissellement |
| title |
|
|
|
| title |
array |
Oui |
Titre dans les différentes langues disponibles |
| description |
|
|
|
| description |
array |
Oui |
Description dans les différentes langues disponibles |
| confidential_information |
|
|
|
| confidential_information |
array |
Oui |
Informations confidentielles dans les différentes langues disponibles |
| visit_information |
|
|
|
| visit_information |
array |
Oui |
Informations de visites dans les différentes langues disponibles |
| agency_confidential_information |
|
|
|
| agency_confidential_information |
array |
Oui |
Informations confidentielles agence dans les différentes langues disponibles |
| surface_areas |
|
|
|
| area_unit |
string |
Oui |
Unité de surface |
| area_total |
float |
Oui |
Surface habitable indicative |
area_carrez_law |
float |
Oui |
Surface loi Carrez |
| area_land |
float |
Oui |
Surface du terrain |
| area_garden |
float |
Oui |
Surface du jardin |
area_living_room |
float |
Oui |
Surface du salon |
| area_terrace |
float |
Oui |
Surface du ou des terrasses |
| area_balcony |
float |
Oui |
Surface du ou des balcons |
| area_formatted |
float |
Oui |
Surface formaté avec l'unité |
| area_storeroom |
float |
Oui |
Surface de la réserve |
| area_ground |
float |
Oui |
Surface au sol |
area_land_registry |
float |
Oui |
Surface cadastrale |
| area_floor |
float |
Oui |
Surface plancher autorisée |
| area_ces |
float |
Oui |
Coefficient d'emprise au sol (CES) |
| formatted |
array |
Oui |
Surfaces formatées |
| rooms |
|
|
|
| rooms |
integer |
Oui |
Nombre de pièces |
| bedrooms |
integer |
Oui |
Nombre de chambres |
| bathrooms |
integer |
Oui |
Nombre de salle de bains |
| half_bathrooms |
integer |
Oui |
Nombre de salles d'eau |
| toilets |
integer |
Oui |
Nombre de WC |
| maid_rooms |
integer |
Oui |
Nombre de chambres de service |
| general |
|
|
|
| new_program |
boolean |
Oui |
Programme neuf |
new_program_delivery |
date |
Oui |
Date de livraison du programme neuf |
| garage |
integer |
Oui |
Nombre de garage / parking |
| outside |
integer |
Oui |
Nombre de parking extérieur |
| underground |
integer |
Oui |
Nombre de parkings en sous sol |
| location_number |
integer |
Oui |
Numéros de stationnements |
| visitor |
integer |
Oui |
Nombre de parking visiteurs |
| parkings_nearby |
boolean |
Oui |
Parkings proches |
| floor |
integer |
Oui |
Etage |
| level |
integer |
Oui |
Nombre de niveau |
| cellar |
integer |
Oui |
Nombres de caves |
| loggia |
integer |
Oui |
Nombres de loggias |
| attic |
integer |
Oui |
Nombre de greniers |
| convertible_attic |
boolean |
Oui |
Grenier aménageable |
| high_ceilings |
float |
Oui |
Hauteur sous plafond |
| minimum_division |
float |
Oui |
Division minimum |
shop_window_width |
float |
Oui |
Largeur vitrine |
| quiet_property |
boolean |
Oui |
Calme |
| shared_services |
boolean |
Oui |
Services communs |
| last_floor |
boolean |
Oui |
Dernier étage |
key_at_agency |
boolean |
Oui |
Clé à l'agence |
| building_permit |
boolean |
Oui |
Permis de construire |
building_permit_date |
date |
Oui |
Date du permis de construite |
| private_garden |
boolean |
Oui |
Jardin privatif |
| air_conditioning |
boolean |
Oui |
Climatisation |
| partition |
boolean |
Oui |
Cloisons |
| conduit |
boolean |
Oui |
Goulottes |
| investor_program |
boolean |
Oui |
Programme investisseur |
| furnished |
boolean |
Oui |
Meublé |
| fireplace |
boolean |
Oui |
Cheminée |
| construction_date |
date |
Oui |
Date de construction |
| outbuildings |
string |
Oui |
Dépendances |
| activities |
string |
Oui |
Activités |
| authorized_activities |
string |
Oui |
Activités autorisées |
| house_name |
string |
Oui |
Nom maison |
| school_nearby |
boolean |
Oui |
Ecoles proches |
convenient_store_nearby |
boolean |
Oui |
Commerces proches |
| transports_nearby |
boolean |
Oui |
Transports proches |
| viabilisation |
boolean |
Oui |
Viabilisation |
| facades_number |
integer |
Oui |
Nombre de façades |
| alarm |
boolean |
Oui |
Alarme |
possibility_of_liberal_profession |
boolean |
Oui |
Professionel autorisé |
| vehicle_number |
integer |
Oui |
Nombre de véhicules |
| park |
boolean |
Oui |
Parc |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| elevator |
boolean |
Oui |
Ascenseur |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| single_storey |
boolean |
Oui |
Plain-pied |
| interphone |
boolean |
Oui |
Interphone |
| digicode |
boolean |
Oui |
Digicode |
| characteristics |
|
|
|
| access |
|
|
|
| slug |
string |
Oui |
slug du type d'accès |
| adjoining_building |
|
|
|
| slug |
string |
Oui |
slug du type de mitoyenneté |
| closure |
|
|
|
| slug |
string |
Oui |
slug du type de fermetures |
| condition |
|
|
|
| slug |
string |
Oui |
slug du type état |
| configuration |
|
|
|
| slug |
string |
Oui |
slug du type de configuration |
| exposition |
|
|
|
| slug |
string |
Oui |
slug du type d'exposition principale |
| external_wall |
|
|
|
| slug |
string |
Oui |
slug du type de murs extérieurs |
| legal_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut juridique |
| floor |
|
|
|
| slug |
string |
Oui |
slug du type de revêtement sol |
| flooring |
|
|
|
| slug |
string |
Oui |
slug du type de plancher |
| garage_status |
|
|
|
| slug |
string |
Oui |
slug du type de statut des garages |
| glazing |
|
|
|
| slug |
string |
Oui |
slug du type de vitrage |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| heating_method |
|
|
|
| slug |
string |
Oui |
slug du type d'énergie chauffage |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| kitchen |
|
|
|
| slug |
string |
Oui |
slug du type de cuisine |
| roof |
|
|
|
| slug |
string |
Oui |
slug du type de toiture |
| sanitation |
|
|
|
| slug |
string |
Oui |
slug du type d'assainissement |
| shutter |
|
|
|
| slug |
string |
Oui |
slug du type de volets |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| style |
|
|
|
| slug |
string |
Oui |
slug du type de style |
| surroundings |
|
|
|
| slug |
string |
Oui |
slug du type d'environnement |
| transferred_element |
|
|
|
| slug |
string |
Oui |
slug du type d'éléments céder |
| vegetation |
|
|
|
| slug |
string |
Oui |
slug du type de végétation |
| view_principal |
|
|
|
| slug |
string |
Oui |
slug du type de vue principale |
| view |
|
|
|
| slug |
string |
Oui |
slug du type de vue |
| woodwork |
|
|
|
| slug |
string |
Oui |
slug du type de menuiserie |
| optical_fiber |
|
|
|
| slug |
string |
Oui |
slug du type de fibre optique |
| financial |
|
|
|
| currency |
string |
Oui |
Unité monétaire |
| price |
float |
Oui |
Prix / Loyer |
| tax1_annual |
float |
Oui |
Taxe foncière |
| tax2_annual |
float |
Oui |
Taxe d'habitation |
| fees_annual |
float |
Oui |
Charges annuelles de copropriétés |
| honorary |
|
|
|
| honorary |
float |
Oui |
Honoraires |
| honorary_buyer |
float |
Oui |
Honoraires à la charge de l'aquéreur |
| honorary_seller |
float |
Oui |
Honoraires à la charge du vendeur |
| honorary_rate |
float |
Oui |
% d'honoraires |
honorary_rate_buyer |
float |
Oui |
% d'hHonoraires à la charge du vendeur |
honorary_rate_seller |
float |
Oui |
% d'hHonoraires à la charge de l'aquéreur |
| fee_type |
array |
Oui |
Type d'honoraires |
| slug |
string |
Oui |
slug du type d'honoraires |
| honorary_visit |
float |
Oui |
Honaires de visites |
| honorary_inventories |
float |
Oui |
Honoraire sde réalisation de l'état des lieux |
| rental |
|
|
|
is_student_rental |
boolean |
Oui |
Location étudiante |
is_seasonal_rental |
boolean |
Oui |
Location saisonnière |
| rent |
float |
Oui |
Loyer |
| rent_frequency |
string |
Oui |
Fréquence du loyer |
| income_annual |
float |
Oui |
Revenu annuel |
| charge |
float |
Oui |
Charges |
| charge_frequency |
string |
Oui |
Fréquence des charges |
| charge_included |
string |
Oui |
Charges incluses |
| security_deposit |
float |
Oui |
Dépot de garantie |
| charge_modality |
array |
Oui |
Modalités des charges |
| slug |
string |
Oui |
slug des modalités des charges |
| building |
|
|
|
| elevator |
boolean |
Oui |
Ascenseur |
| pool |
boolean |
Oui |
Piscine |
| tennis |
boolean |
Oui |
Tennis |
| park |
boolean |
Oui |
Parc |
| numberoffloors |
integer |
Oui |
Nombre d'étages |
| numberoflots |
integer |
Oui |
Nombre de lots |
| last_renovating_facade |
date |
Oui |
Date du dernier ravalement de façade |
| outbuildings |
string |
Oui |
Dépendances |
| period |
string |
Oui |
Période |
| caretaker |
boolean |
Oui |
Concierge |
| garden |
boolean |
Oui |
Jardin |
| secure_access |
boolean |
Oui |
Accès sécurisé |
| private_garden |
boolean |
Oui |
Jardin privatif |
| handicapped_access |
boolean |
Oui |
Accès PMR |
| parking_lot |
boolean |
Oui |
Parking collectif |
| works_planned |
boolean |
Oui |
Travaux prévu |
| children_playground |
boolean |
Oui |
Jardin d'enfants |
| bike_storage |
boolean |
Oui |
Local à vélo |
| laundry |
boolean |
Oui |
Buanderie |
| sports_hall |
boolean |
Oui |
Salle de sport |
| surveillance |
boolean |
Oui |
Surveillance 24/24 |
| interphone |
boolean |
Oui |
Interphone |
| videophone |
boolean |
Oui |
Vidéophone |
| digicode |
boolean |
Oui |
Digicode |
| characteristics |
|
|
|
| construction |
|
|
|
| slug |
string |
Oui |
slug du type de construction |
| heating |
|
|
|
| slug |
string |
Oui |
slug du type de chauffage |
| hot_water |
|
|
|
| slug |
string |
Oui |
slug du type d'eau chaude |
| standing |
|
|
|
| slug |
string |
Oui |
slug du type de standing |
| open_doors |
|
|
|
| date |
date |
Non |
Date |
| start_time |
time |
Non |
Heure de début |
| end_time |
time |
Non |
Heure de fin |
| informations |
string |
Oui |
Informations |
| price_evolutions |
|
|
|
| date |
date |
Non |
Date de l'évolution du prix |
| old_price |
float |
Non |
Ancien prix |
| new_price |
float |
Non |
Nouveau prix |
| price_evolution_type |
array |
Oui |
Type d'évolution |
| slug |
string |
Oui |
Slug |
| rooms_details |
|
|
|
| floor |
string |
Oui |
Sol |
| wall |
string |
Oui |
Murs |
| storage |
boolean |
Oui |
Placard |
| balcony |
boolean |
Oui |
Balcon |
| terrace |
boolean |
Oui |
Terrasse |
| garden |
boolean |
Oui |
Jardin |
| name |
string |
Oui |
Nom de la pièce |
| air_conditioning |
boolean |
Oui |
Climatisation |
| comments |
string |
Oui |
Commentaires |
| level |
integer |
Oui |
Niveau |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
string |
Oui |
Surface formatée |
| lots_details |
|
|
|
| lot_number |
string |
Oui |
Numéro du lot |
| lot_number_seconadry |
string |
Oui |
Numéro des lots secondaire |
| is_rent |
boolean |
Oui |
Loué |
| rent |
float |
Oui |
Loyer |
lease_end_date |
date |
Oui |
Fin du bail |
| lease_type |
array |
Oui |
Type de bail |
| slug |
string |
Oui |
Slug du type de bail |
| name |
string |
Oui |
Nom du type de bail |
| lot_type |
array |
Oui |
Type de lot |
| slug |
string |
Oui |
Slug |
| area |
float |
Oui |
Surface |
| area_unit |
string |
Oui |
Unité de surface |
| area_formatted |
array |
Oui |
Surface formatée |
| description |
array |
Oui |
Description dans les langues disponibles |
| confidential_information |
array |
Oui |
|
Réponse
{
"id": "b1eMQv",
"uid": null,
"reference": "MLS236053",
"online_at": "2023-11-28T17:15:08.000+01:00",
"created_at": "2024-06-04T13:32:02.840+02:00",
"updated_at": "2024-06-04T13:32:02.840+02:00",
"offline_at": null,
"is_on_portal": true,
"is_mls": false,
"is_private": true,
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
},
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387XXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo",
"default_language": "fr"
}
},
"user": {
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Someone",
"last_name": "XXXXX",
"full_name": "Someone XXXXX",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "xxx@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406+02:00",
"updated_at": "2024-06-18T11:34:30.089+02:00"
},
"mandate": {
"cadastre": "",
"number": "1345",
"co_ownership": true,
"lot_number": "100",
"lot_number_secondary": "S100, A985, P789",
"start_date": "2023-11-28",
"end_date": "2024-11-28",
"effect_date": "2023-11-28",
"urgency_sale": true,
"slug": "exclusive",
"name": {
"fr": "Exclusif",
"en": "Exclusive",
"es": "En Exclusiva",
"it": "Esclusivo",
"nl": "Exclusief",
"pt": null,
"de": null
}
},
"property_type": {
"slug": "house",
"name": {
"fr": "Maison",
"en": "House",
"es": "Chalet",
"it": "Casa",
"nl": "Huis",
"pt": null,
"de": null
},
"sub_type": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"transaction_type": {
"slug": "under-offer",
"name": {
"fr": "Sous offre",
"en": "Under offer",
"es": "En venta",
"it": "In vendita",
"nl": "Onder voorstellen",
"pt": null,
"de": null
}
},
"transaction_status": {
"slug": "for-sale",
"name": {
"fr": "A vendre",
"en": "For sale",
"es": "En venta",
"it": "In vendita",
"nl": "Te koop",
"pt": "",
"de": "",
"ru": ""
},
"sub_status": {
"end_market_date": null,
"offer_accepted_date": null,
"compromise_date": null,
"sold_or_rent_date": null,
"withdrawal_date": null,
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
}
},
"lease": {
"is_sold_with_tenant": true,
"availability_date": "2024-03-21",
"slug": "professional",
"name": {
"fr": "Professionnel",
"en": "Professional",
"es": "Profesional",
"it": "Professionista",
"nl": "Professioneel",
"pt": null,
"de": null
}
},
"life_lease": {
"is_life_lease": false,
"venal_value": null,
"life_annuity": null,
"life_lease_type": {
"slug": "free",
"name": {
"fr": "Viager libre ",
"fr-BE": "Viager libre ",
"fr-CA": "Viager libre ",
"en": "Free ",
"es": "Viager libre ",
"es-LA": "Viager libre ",
"it": "Viager libre ",
"nl": "Viager vrij",
"pt": "Viager libre ",
"pt-BR": "Viager libre ",
"de": "Viager libre ",
"ru": "Viager libre "
}
}
},
"pictures": [
{
"url": "https://xxxx.com/name.jpg",
"name": "name.jpg",
"order": 1,
"allowed_to_display": true
},
{
"url": "https://xxxx.com/name.png",
"name": "name.jpg",
"order": 2,
"allowed_to_display": true
}
],
"documents": [
{
"id": "x5zjX8",
"name": "name.pdf",
"title": null,
"url": "https://xxxx.com/name.pdf",
"order": 1,
"file_size": "1012168",
"document_type": "plans",
"content_type": "application/pdf",
"allowed_to_display": true
},
{
"id": "JYdlK8",
"name": "name.png",
"title": null,
"url": "https://xxxx.com/name.png",
"order": 2,
"file_size": "49786",
"document_type": "",
"content_type": "image/png",
"allowed_to_display": true
}
],
"virtual_visits": [],
"address": {
"allowed_to_display": true,
"address_formatted": "310 Avenue de Provence, 83600 Fréjus",
"street_number": "310",
"street_name": "Avenue de Provence",
"zipcode": "83600",
"locality": "Frejus",
"sublocality": "Frejus Plage",
"latitude": 43.4279,
"longitude": 6.74036,
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Var",
"country": "France",
"country_iso_code": "fr"
},
"country_detail": {
"fr": {
"dpe": {
"date_start": "2024-02-08",
"date_end": null,
"dpe_letter": "C",
"dpe_value": 130.0,
"ges_letter": "C",
"ges_value": 21.0,
"dpe_lower_price": null,
"dpe_higher_price": null,
"dpe_year_reference": null,
"dpe_url": null
},
"alur": {
"procedure_in_progress": false,
"procedure_details": "",
"number_of_lots": 100
}
},
"be": {
"peb": {
"date_start": "2025-03-12",
"peb_letter": "B",
"peb_number": "1487596",
"peb_energy_value": 256.0,
"peb_emission_value": 356.0,
"peb_consumption_total": 1500.0
},
"diagnosis": {
"electrical_inspection": "compliant",
"electrical_inspection_date": "2025-03-14",
"electrical_wiring_diagrams": true,
"gas_inspection": "requested",
"gas_inspection_date": "2025-03-13",
"certibeau_date": "2025-03-13",
"certibeau_number": "Test certibeau",
"tank_type": "mazout",
"tank_date": "2025-03-12",
"tank_number": "A7895",
"tank_color": "orange",
"class_three_declaration_date": "2025-03-13",
"class_three_declaration_object": "Classe3",
"class_three_declaration_note": "Note classe 3",
"abestos_type": "none",
"abestos_date": "2025-03-13"
},
"urbanism": {
"zoning_plan": null,
"territorial_development_plan": null,
"intermunicipal_development_plan": null,
"intermunicipal_development_plan_note": null,
"local_interpretation_plan": null,
"local_interpretation_plan_note": null,
"regional_guide": null,
"regional_guide_note": null,
"municipal_development_plan": null,
"municipal_development_plan_note": null,
"municipal_guide": null,
"municipal_guide_note": null,
"soil_condition_database": null,
"flood_prone_area_due_to_overflow": null,
"flood_prone_area_due_to_runoff": null,
"runoff_concentration_axes": null,
"cu1_urban_planning_information": null,
"cu1_urban_planning_information_date": null,
"cu2": null,
"building_permit_date": null,
"building_permit_note": null,
"urbanization_permit_date": "2025-03-13",
"urbanization_permit_note": "permis d'urbanisation",
"operating_permit_date": "2025-03-21",
"operating_permit_note": "permis d'exploiter",
"rent_permit_date": "2025-03-20",
"rent_permit_note": "permis de location",
"regional_land_use_plan": "none",
"master_development_plan": true,
"master_development_plan_note": "Test PAD",
"regional_urban_planning_regulations": "",
"zoned_regional_urban_planning_regulations": true,
"zoned_regional_urban_planning_regulations_note": "Test RRUZ",
"municipal_land_use_plan": true,
"municipal_land_use_plan_note": "Test PCD",
"zoned_municipal_land_use_plan": true,
"zoned_municipal_land_use_plan_note": "TEST PPAS",
"specific_municipal_urban_planning_regulation": true,
"specific_municipal_urban_planning_regulation_note": "Test RCUS",
"zoned_specific_municipal_urban_planning_regulation": true,
"zoned_specific_municipal_urban_planning_regulation_note": "Test RCUSZ",
"inventory_of_soil_condition": "none",
"heritage_protection": true,
"heritage_protection_note": "Test protection patrimoine",
"preemption_right": true,
"preemption_right_note": "Test droit de préemption",
"summary_description_date": "2025-03-12",
"summary_description_note": null,
"urban_planning_information_date_of_request": "2025-03-06",
"urban_planning_information_date_of_extraction": "2025-03-04",
"infractions_or_sanctions": true,
"infractions_or_sanctions_note": "Test infractions",
"flood_zone": "medium",
"arbitration_plan": null,
"grup": null,
"prup": null,
"structure_plan": null,
"structure_plan_note": null,
"zoning_plan_flandres": null,
"zoning_plan_flandres_note": null,
"urban_planning_information": null,
"urban_planning_information_date": null,
"floor_plan_test": null,
"floor_plan_test_note": null,
"flood_zones_runoff_zones": null,
"flood_zones_runoff_zones_note": null,
"cadastrale_locality": null,
"cadastrale_division": null,
"cadastrale_section": null,
"cadastrale_parcel_number": null
}
},
"it": null
},
"title": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"visit_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"agency_confidential_information": {
"fr": "",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"url_more_infos": "https://www.test.com",
"surface_areas": {
"area_unit": "m2",
"area_total": 140.0,
"area_carrez_law": 140.0,
"area_living_room": 34.0,
"area_terrace": 3.0,
"area_garden": 786.0,
"area_land": 123.0,
"area_storeroom": null,
"area_ground": null,
"area_land_registry": 1.0,
"area_balcony": 3.0,
"area_floor": 64.0,
"area_ces": 76.0,
"formatted": {
"area_total": "140 m<sup>2</sup>",
"area_carrez_law": "140 m<sup>2</sup>",
"area_living_room": "34 m<sup>2</sup>",
"area_terrace": "3 m<sup>2</sup>",
"area_garden": "786 m<sup>2</sup>",
"area_land": "123 m<sup>2</sup>",
"area_storeroom": null,
"area_ground": null,
"area_land_registry": "1 m<sup>2</sup>",
"area_balcony": "3 m<sup>2</sup>",
"area_floor": "64 m<sup>2</sup>",
"area_ces": "76 m<sup>2</sup>"
}
},
"rooms": {
"rooms": 7,
"bedrooms": 4,
"bathrooms": 0,
"half_bathrooms": 2,
"toilets": 2,
"maid_rooms": 8
},
"general": {
"new_program": true,
"new_program_delivery": "2024-03-28",
"garage": 2,
"outside": 2,
"underground": 1,
"location_number": "",
"visitor": 1,
"parkings_nearby": true,
"floor": 0,
"level": 0,
"cellar": 2,
"loggia": false,
"attic": 1,
"convertible_attic": true,
"high_ceilings": 233.0,
"minimum_division": 0.0,
"shop_window_width": 0.0,
"quiet_property": true,
"shared_services": null,
"last_floor": false,
"key_at_agency": true,
"building_permit": true,
"building_permit_date": "2024-03-22",
"private_garden": null,
"air_conditioning": true,
"partition": null,
"conduit": null,
"investor_program": true,
"furnished": true,
"fireplace": true,
"construction_date": "2024-03-07",
"outbuildings": "Grange jardin",
"activities": "",
"authorized_activities": "",
"house_name": "",
"school_nearby": true,
"convenient_store_nearby": true,
"transports_nearby": true,
"viabilisation": null,
"facades_number": 0,
"alarm": true,
"possibility_of_liberal_profession": true,
"vehicle_number": null,
"park": null,
"pool": true,
"tennis": true,
"elevator": true,
"handicapped_access": true,
"single_storey": true,
"interphone": true,
"digicode": true,
"balcony": null,
"terrace": null
},
"characteristics": {
"access": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"adjoining_building": {
"slug": "detached",
"name": {
"fr": "Individuelle",
"en": "Detached",
"es": "Individual",
"it": "Individuale",
"nl": "Open bebouwing",
"pt": null,
"de": null
}
},
"closure": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"condition": {
"slug": "excellent-condition",
"name": {
"fr": "Très bon état",
"en": "Excellent condition",
"es": "Excellent état",
"it": "Ottimo stato",
"nl": "Excellent état",
"pt": null,
"de": null
}
},
"configuration": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"exposition": {
"slug": "north-east",
"name": {
"fr": "Nord-Est",
"en": "North-East",
"es": "Nor-Este",
"it": "Nord-Est",
"nl": "Noord-Oost",
"pt": null,
"de": null
}
},
"external_wall": {
"slug": "crepis",
"name": {
"fr": "Crépis",
"en": "Crépis",
"es": "Crépis",
"it": "Crépis",
"nl": null,
"pt": null,
"de": null
}
},
"legal_status": {
"slug": "free-property",
"name": {
"fr": "Nue-propriété",
"en": "Bare property",
"es": "Propiedad compartida",
"it": "Indivisa",
"nl": "Indivision",
"pt": null,
"de": null
}
},
"floor": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"flooring": {
"slug": "woog",
"name": {
"fr": "Bois",
"en": "Woog",
"es": "Madera",
"it": "Legno",
"nl": "Hout",
"pt": null,
"de": null
}
},
"garage_status": {
"slug": "excluded",
"name": {
"fr": "En sus",
"en": "Excluded",
"es": "Excluidos",
"it": "Esclusi",
"nl": "Uitgesloten",
"pt": null,
"de": null
}
},
"glazing": {
"slug": "double",
"name": {
"fr": "Double vitrage",
"en": "Double glazing",
"es": "Doble",
"it": "Doppi",
"nl": "Dubbele",
"pt": null,
"de": null
}
},
"heating": {
"slug": "electric-radiator",
"name": {
"fr": "Convecteur",
"en": "Electric radiator",
"es": "Convecteur",
"it": "Convettori",
"nl": "Convector",
"pt": null,
"de": null
}
},
"heating_method": {
"slug": "climatisation",
"name": {
"fr": "Climatisation",
"en": "Climatisation",
"es": "Climatisation",
"it": "Climatizzazione",
"nl": "Climatisation",
"pt": null,
"de": null
}
},
"hot_water": {
"slug": "fuel",
"name": {
"fr": "Fioul",
"en": "Fuel",
"es": "Gasoil",
"it": "Gasolio",
"nl": "Stookolie",
"pt": null,
"de": null
}
},
"kitchen": {
"slug": "full-equiped",
"name": {
"fr": "Equipée",
"en": "Full equiped",
"es": "Equipada",
"it": "Attrezzata",
"nl": "Volledig ingericht",
"pt": null,
"de": null
}
},
"roof": {
"slug": "thatch",
"name": {
"fr": "Chaume",
"en": "Thatch",
"es": "Paja",
"it": "Paglia",
"nl": "Riet",
"pt": null,
"de": null
}
},
"sanitation": {
"slug": "sewer",
"name": {
"fr": "Egout",
"en": "Sewer",
"es": "Canal Reglamentario",
"it": "Fogna",
"nl": "Riool",
"pt": null,
"de": null
}
},
"shutter": {
"slug": "electric",
"name": {
"fr": "Roulants électriques",
"en": "Electric roller blind",
"es": "Roulants élec.",
"it": "Tapparelle elec.",
"nl": "Elektrisch",
"pt": null,
"de": null
}
},
"standing": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"style": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"surroundings": {
"slug": "city-houses",
"name": {
"fr": "Pavillonnaire",
"en": "City houses",
"es": "Urbanizacion de chalets",
"it": "Residenziale",
"nl": "Pavillonnaire",
"pt": null,
"de": null
}
},
"transferred_element": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"vegetation": {
"slug": null,
"name": {
"fr": null,
"en": null,
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null
}
},
"view_principal": {
"slug": "panoramic",
"name": {
"fr": "Panoramique",
"en": "Panoramic",
"es": null,
"it": null,
"nl": null,
"pt": null,
"de": null,
"ru": null
}
},
"view": {
"slug": "sea",
"name": {
"fr": "Mer",
"en": "Sea",
"es": "Mar",
"it": "Mare",
"nl": "Zee",
"pt": null,
"de": null
}
},
"woodwork": {
"slug": "mixt",
"name": {
"fr": "Mixte",
"en": "Mixt",
"es": "Mixte",
"it": "Mixte",
"nl": "Mixte",
"pt": null,
"de": null
}
},
"optical_fiber": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
},
"financial": {
"currency": "eur",
"price": 13890000.0,
"tax1_annual": 6754.0,
"tax2_annual": 7890.0,
"fees_annual": 1200.0,
"offer_from": false,
"tax_system": {
"slug": "vat",
"name": {
"fr": "TVA",
"fr-BE": "TVAC",
"fr-CA": "TVA",
"en": "VAT",
"es": "IVA",
"es-LA": "IVA",
"it": "IVA",
"nl": "TVA",
"pt": "TVA",
"pt-BR": "TVA",
"de": "TVA",
"ru": "TVA"
}
},
"honorary": {
"honorary": 800000.0,
"honorary_buyer": 0.0,
"honorary_seller": 800000.0,
"honorary_rate": 5.75,
"honorary_rate_buyer": 0.0,
"honorary_rate_seller": 5.75,
"fee_type": {
"slug": "vendeur",
"name": {
"fr": "Vendeur",
"en": "Vendeur",
"es": "Vendeur",
"it": "Vendeur",
"nl": null,
"pt": null,
"de": null
}
},
"honorary_visit": 0.0,
"honorary_inventories": 0.0
},
"rental": {
"is_student_rental": false,
"is_seasonal_rental": false,
"rent": 1300.0,
"rent_frequency": "monthly",
"income_annual": 0.0,
"charge": 0.0,
"charge_frequency": "monthly",
"charge_included": true,
"security_deposit": 0.0,
"charge_modality": {
"slug": "forfaitaires-mensuelles",
"name": {
"fr": "Forfaitaires mensuelles",
"en": "Forfaitaires mensuelles",
"es": "Forfaitaires mensuelles",
"it": "Forfaitaires mensuelles",
"nl": null,
"pt": null,
"de": null
}
}
},
"formatted": {
"european_format": {
"price": "13 890 000 €",
"tax1_annual": "6 754 €",
"tax2_annual": "7 890 €",
"fees_annual": "1 200 €",
"honorary": {
"honorary": "800 000 €",
"honorary_buyer": "",
"honorary_seller": "800 000 €",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "1 300 €",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
},
"american_format": {
"price": "€13,890,000",
"tax1_annual": "€6,754",
"tax2_annual": "€7,890",
"fees_annual": "€1,200",
"honorary": {
"honorary": "€800,000",
"honorary_buyer": "",
"honorary_seller": "€800,000",
"honorary_visit": "",
"honorary_inventories": ""
},
"rental": {
"rent": "€1,300",
"income_annual": "",
"charge": "",
"security_deposit": ""
}
}
}
},
"building": {
"name": "Boulevard Saint-Roch (15 Bis)",
"elevator": true,
"pool": true,
"tennis": false,
"park": false,
"number_of_floors": 4,
"number_of_lots": null,
"last_renovating_facade": "2014-05-21",
"outbuildings": null,
"period": "1950",
"caretaker": true,
"garden": false,
"secure_access": false,
"private_garden": false,
"handicapped_access": false,
"parking_lot": true,
"works_planned": false,
"children_playground": false,
"bike_storage": true,
"laundry": false,
"sports_hall": true,
"surveillance": true,
"interphone": true,
"videophone": false,
"digicode": true,
"created_at": "2021-09-27T15:40:42.908094+02:00",
"updated_at": "2023-07-07T16:08:49.960744+02:00",
"characteristics": {
"construction": {
"slug": "concrete",
"name": {
"fr": "Béton",
"fr-BE": "Béton",
"fr-CA": "Béton",
"en": "Concrete",
"es": "Hormigón",
"es-LA": "Hormigón",
"it": "Cemento",
"nl": "",
"pt": "Béton",
"pt-BR": "Béton",
"de": "Béton",
"ru": "Béton"
}
},
"heating": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"hot_water": {
"slug": "individual",
"name": {
"fr": "Individuel",
"fr-BE": "Individuel",
"fr-CA": "Individuel",
"en": "Individual",
"es": "Individual",
"es-LA": "Individual",
"it": "Autonomo",
"nl": "Afzonderlijk",
"pt": "Individuel",
"pt-BR": "Individuel",
"de": "Individuel",
"ru": "Individuel"
}
},
"standing": {
"slug": "good",
"name": {
"fr": "Standing",
"fr-BE": "Standing",
"fr-CA": "Standing",
"en": "Good",
"es": "Standing Medio",
"es-LA": "Standing Medio",
"it": "Livello Medio",
"nl": "Standing",
"pt": "Standing",
"pt-BR": "Standing",
"de": "Standing",
"ru": "Standing"
}
}
}
},
"open_doors": [
{
"id": "dXAMXj",
"date": "2023-12-23",
"start_time": "2000-01-01T16:00:00.000000+01:00",
"end_time": "2000-01-01T19:00:00.000000+01:00",
"informations": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
{
"id": "yQY35l",
"date": "2023-11-15",
"start_time": "2000-01-01T15:50:00.000000+01:00",
"end_time": "2000-01-01T17:50:00.000000+01:00",
"informations": "LOrem ipsum"
},
{
"id": "zQ4x0Q",
"date": "2024-01-19",
"start_time": "2000-01-01T10:27:00.000000+01:00",
"end_time": "2000-01-01T10:27:00.000000+01:00",
"informations": "Lorem"
},
{
"id": "VvgDP5",
"date": "2025-05-31",
"start_time": "2000-01-01T10:00:00.000000+01:00",
"end_time": "2000-01-01T12:00:00.000000+01:00",
"informations": "Lorem ipsum dolor sit amet"
}
],
"price_evolutions": [
{
"date": "2024-06-10T19:42:40.145317+02:00",
"old_price": 150000.0,
"new_price": 152000.0,
"price_evolution_type": {
"slug": "price_increase",
"name": {
"fr": "Hausse de prix",
"fr-BE": "Hausse de prix",
"fr-CA": "Hausse de prix",
"en": "Price increase",
"es": "Hausse de prix",
"es-LA": "Hausse de prix",
"it": "Hausse de prix",
"nl": "Hausse de prix",
"pt": "Hausse de prix",
"pt-BR": "Hausse de prix",
"de": "Hausse de prix",
"ru": "Hausse de prix"
}
}
}
],
"rooms_details": [],
"lot_details": []
}Agences
Panier
Cette route vous permet d'obtenir des propriétés selon des critères de recherche
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/:id/cart/:cart_type
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence fourni |
| cart_type |
string |
Type de panier {software, website } |
Précision sur les types de panier
software: Biens du groupement que l'utilisateur a sélectionné dans son Flux Logiciel. Ne doit servir que pour une utilisation interne à l'agence, sans diffusion Web ou autre multidiffusion.
website: Biens du groupement que l'utilisateur a sélectionné dans son Flux Web et cela tient compte des autorisations de diffusions. Doit servir à alimenter le site Web de l'agence, en respectant l'obtention de l'autorisation par les agences détenant les mandats.
QUERY Parameters
Même que Propriétés > recherche
Réponse
Même que Propriétés > recherche
Paramétres de la réponse
Même que Propriétés > recherche
Recherche agence
Cette route vous permet d'obtenir des informations sur les agences dont vous dépendez
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/search
QUERY Parameters
| Parameter |
Type |
Description |
| active |
boolean |
Actif: true ou false |
| email |
string |
Email de l'agence |
| mls_status |
boolean |
Statut MLS |
created_at |
date |
Date de création égale à |
created_at_gt |
date |
Date de création supérieur à |
created_at_gte |
date |
Date de création supérieur ou égale à |
created_at_lt |
date |
Date de création inférieur à |
created_at_lte |
date |
Date de création inférieur ou égale à |
updated_at |
date |
Date de mise à jour égale à |
updated_at_gt |
date |
Date de mise à jour supérieur à |
updated_at_gte |
date |
Date de mise à jour supérieur ou égale à |
updated_at_lt |
date |
Date de mise à jour inférieur à |
updated_at_lte |
date |
Date de mise à jour inférieur égale à |
Réponse
{
"pagination": {
"total": 1,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 1,
"formatted": "1-1 sur 1"
},
"results": [
{
"name": "Agence Dubois SCOP",
"id": "0AE4xL",
"active": false,
"mls_status": true,
"phone": "09 XX XX XX XX",
"email": "francesco@example.net",
"website_url": "",
"created_at": "2020-03-02T01:00:00.000+01:00",
"updated_at": "2024-06-12T09:53:42.280+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "MLS-xxxx",
"slug": "MLS-xxxx"
}
},
{
"name": "Agence Dubois SCEP",
"id": "0AE5xL",
"active": false,
"mls_status": true,
"phone": "09 XX XX XX XX",
"email": "frances3co@example.net",
"website_url": "",
"created_at": "2020-03-02T01:00:00.000+01:00",
"updated_at": "2024-06-12T09:53:42.280+02:00",
"mls_board": {
"id": "Yv69Wm",
"name": "MLS-xxxx",
"slug": "MLS-xxxx"
}
}
]
}Paramétres de la réponse
| Node |
Type |
Nullable |
Description |
| name |
string |
Non |
Nom de l'agence |
| id |
string |
Non |
Id de l'agence |
| active |
boolean |
Non |
Active |
| active_label |
string |
Non |
Label actif |
| mls_status |
string |
Non |
Statut MLS |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| phone |
string |
Oui |
Téléphone de l'agence |
| email |
string |
Oui |
Email de l'agence |
| registration_label |
string |
Oui |
Label numéro d'enregistrement |
| registration_number |
string |
Oui |
Numéro d'enregistrement |
| website_url |
string |
Oui |
Site web de l'agence |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| mls_board |
|
|
|
| id |
string |
Non |
Id du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso de la langue par défaut |
| providers |
|
|
|
| name |
string |
Non |
Nom du logiciel |
Détails agence
Cette route vous permet d'obtenir des informations sur les agences dont vous dépendez
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/search/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
Réponse
{
"id": "oAlYy0",
"active": true,
"mls_status": true,
"name": "immosquare",
"commercial_name": "immosquare",
"phone": "+339XXXXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"logo_url": "https://mon-url/example.png",
"agency_picture_url": "https://mon-url/example.png",
"agency_header_url": "https://mon-url/example.png",
"agency_footer_url": "https://mon-url/example.png",
"address": {
"address_formatted": "23 Bd Pape Jean XXIII, 06300 Nice, France",
"street_number": "23",
"street_name": "Boulevard Pape Jean XXIII",
"zipcode": "06300",
"locality": "Nice",
"sublocality": "",
"latitude": "43.7106018066406",
"longitude": "7.2938899993896",
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Alpes-Maritimes",
"country": "France",
"country_iso_code": "fr"
},
"legal": {
"registration_name": "immosquare",
"registration_id": "RCS XXXXXXX",
"registration_location": "METZ",
"legal_representative": "M DIRECTOR",
"social_capital": "670000",
"fr": {
"guarantee_fund": {
"type": "Garantie avec réception de fonds",
"name": "FNAIM",
"address": "10 rue de la Boétie",
"policy_number": "4343",
"escrow_account_number": "SEQ : 98454545",
"escrow_account_location": "BNP"
},
"insurance": {
"name": "AXA",
"address": "11, rue des mines, 75008 Paris",
"policy_number": "AXA 2343"
}
}
},
"licence": {
"holder": "immosquare's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "immosquare Immobilier est une agence immobilière nouvelle génération, synthèse entre agence traditionnelle et agence virtuelle. Notre équipe d'expérience est constituée de collaborateurs tous impliqués au plus haut niveau de l’entreprise, qui sauront vous accompagner au mieux dans tous vos projets immobiliers sur la Côte d’Azur, que ce soit pour l’achat, la vente, la location ou la gestion locative de biens immobilier de prestige, de Menton à Saint-Tropez. tyty",
"en": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
},
"users": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "M DIRECTOR",
"last_name": "immosquare",
"full_name": "M DIRECTOR immosquare",
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "francesco@example.net",
"created_at": "2021-06-16T14:26:58.754+02:00",
"updated_at": "2024-07-22T14:48:10.662+02:00"
},
{
"id": "ql4Jgm",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Agent",
"last_name": "immosquare",
"full_name": "Agent immosquare",
"mobile": "+337XXXXXXXX",
"phone": "",
"email": "francesco2@example.net",
"created_at": "2021-06-16T14:26:59.148+02:00",
"updated_at": "2022-12-20T18:07:47.118+01:00"
}
]
}Paramétres de la réponse
| Node |
Type |
Nullable |
Description |
| id |
string |
Non |
Id de l'agence |
| active |
boolean |
Non |
Active |
| active_label |
string |
Non |
Label active |
| mls_status |
boolean |
Non |
Statut MLS |
| isonportal |
boolean |
Non |
Agence visible sur les portails externes |
| name |
string |
Oui |
Nom de l'agence |
| commercial_name |
string |
Oui |
Nom de l'agence |
| phone |
string |
Oui |
Téléphone de l'agence |
| email |
string |
Oui |
Email de l'agence |
| website_url |
string |
Oui |
Site web de l'agence |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| logo_url |
string |
Oui |
URL du logo de l'agence |
| agency_picture_url |
string |
Oui |
URL de la photo de l'agence |
| agency_header_url |
string |
Oui |
URL de l'entête utilisée dans les documents de l'agence |
| agency_footer_url |
string |
Oui |
URL du bas de page utilisé dans les documents de l'agence |
| address |
|
|
|
| address_formatted |
string |
Non |
Adresse formatée |
| street_number |
string |
Oui |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postal |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Oui |
Nom du quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
| administrative_area_level1 |
string |
Non |
Région |
| administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
| countryisocode |
string |
Non |
Code ISO du pays |
| legal |
|
|
|
| registrationnumberlabel |
string |
Oui |
Label Raison sociale |
| registration_number |
string |
Oui |
SIRET |
| registration_name |
string |
Oui |
Raison sociale |
| registrationidlabel |
string |
Oui |
Label RCS / SIREN |
| registration_id |
string |
Oui |
RCS / SIREN |
| registration_location |
string |
Oui |
Inscrite au registre du commerce de |
| legal_representative |
string |
Oui |
Représentant légal |
| social_capital |
string |
Oui |
Capital social |
| fr |
|
|
|
| guarantee_fund |
|
|
|
| type |
string |
Oui |
Type de garantie financière |
| name |
string |
Oui |
Nom de la caisse de garantie |
| address |
string |
Oui |
Adresse de la caisse de garantie |
| policy_number |
string |
Oui |
Numéro de sociétaire |
| escrow_account_number |
string |
Oui |
Numéro de compte séquestre |
| escrow_account_location |
string |
Oui |
Compte séquestre ouvert auprès de |
| insurance |
|
|
|
| name |
string |
Oui |
Etablissement d'assurance |
| address |
string |
Oui |
Adresse de l'établissement d'assurance |
| policy_number |
string |
Oui |
Numéro de police d'assurance |
| licence |
Oui |
|
|
| holder |
string |
Oui |
Titulaire de la carte |
| label |
string |
Oui |
Label carte professionelle |
| number |
string |
Oui |
Numéro de carte professionnelle |
| type |
string |
Oui |
Type de carte professionnelle |
| delivery_location |
string |
Oui |
Délivrée par la CCI de |
| validity_date_start |
string |
Oui |
Date de début de validité de la carte |
| validity_date_end |
string |
Oui |
Date de fin de validité de la carte |
| description |
|
|
|
locale |
text |
Oui |
Description dans les différentes langues disponibles |
| mls_board |
|
|
|
| id |
string |
Non |
Id du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso langue par défault |
| users |
|
|
|
| id |
string |
Non |
Id de l'utilisateur |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| mlsboardid |
string |
Non |
Id du MLS |
| agency_id |
string |
Non |
Id agence |
| director |
boolean |
Non |
Est l'utilisateur par défaut de l'agence |
| active |
boolean |
Non |
Actif |
| active_label |
string |
Oui |
Label actif |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| full_name |
string |
Oui |
Nom complet |
| display_mobile |
boolean |
Non |
Numéro de mobile affichable |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Oui |
Email |
| member_since_at |
datetime |
Non |
Membre depuis le |
| licence_label |
string |
Non |
Label licence |
| rights |
string |
Non |
Slug droits utilisateur |
| created_at |
string |
Non |
Date de création |
| updated_at |
string |
Non |
Date de dernière mise à jour |
Refus de collaboration
Cette route vous permet d'obtenir les agences qui ont un refus de collaboration avec l'agence demandée
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/:id/collaboration-refusal
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
Réponse
{
"pagination": {
"total": 1,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 1,
"formatted": "1-1 sur 1"
},
"results": [
{
"name": "Agence Dubois SCOP",
"id": "0AE4xL",
"active": false,
"mls_status": true,
"phone": "09 XX XX XX XX",
"email": "francesco@example.net",
"website_url": "",
"created_at": "2020-03-02T01:00:00.000+01:00",
"updated_at": "2024-06-12T09:53:42.280+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "MLS-xxxx",
"slug": "MLS-xxxx"
}
},
{
"name": "Agence Dubois SCEP",
"id": "0AE5xL",
"active": false,
"mls_status": true,
"phone": "09 XX XX XX XX",
"email": "frances3co@example.net",
"website_url": "",
"created_at": "2020-03-02T01:00:00.000+01:00",
"updated_at": "2024-06-12T09:53:42.280+02:00",
"mls_board": {
"id": "Yv69Wm",
"name": "MLS-xxxx",
"slug": "MLS-xxxx"
}
}
]
}Création agence (Droits supplémentaires requis)
Cette route vous permet de créer une agence
Endpoint
POST https://app.mls-connect.com/fr/api/v3/agencies
URL Parameters
| Parameter |
Type |
Requis |
Description |
| mls_board |
string |
Oui |
Id MLS |
| uid |
string |
Non |
Uid de l'agence - refernece système externe |
| mls_status |
boolean |
Non |
Statut MLS - droits suplémentaire requis |
| name |
string |
Oui |
Nom de l'agence |
| commercial_name |
string |
Non |
Nom de l'agence |
| phone |
string |
Non |
Téléphone de l'agence |
| email |
string |
Non |
Email de l'agence |
| website_url |
string |
Non |
Site web de l'agence |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| logo_url |
string |
Non |
URL du logo de l'agence |
| agency_picture_url |
string |
Non |
URL de la photo de l'agence |
| agency_header_url |
string |
Non |
URL de l'entête utilisée dans les documents de l'agence |
| agency_footer_url |
string |
Non |
URL du bas de page utilisé dans les documents de l'agence |
| address |
|
|
|
| address_formatted |
string |
Oui |
Adresse formatée |
| street_number |
string |
Non |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postal |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Non |
Nom du quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
| administrative_area_level1 |
string |
Non |
Région |
| administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
| countryisocode |
string |
Non |
Code ISO du pays |
| legal |
|
|
|
| registration_number |
string |
Non |
SIRET |
| registration_name |
string |
Non |
Raison sociale |
| registration_id |
string |
Non |
RCS / SIREN |
| registration_location |
string |
Non |
Inscrite au registre du commerce de |
| legal_representative |
string |
Non |
Représentant légal |
| social_capital |
string |
Non |
Capital social |
| fr |
|
|
|
| guarantee_fund |
|
|
|
| type |
string |
Non |
Type de garantie financière |
| name |
string |
Non |
Nom de la caisse de garantie |
| address |
string |
Non |
Adresse de la caisse de garantie |
| policy_number |
string |
Non |
Numéro de sociétaire |
| escrow_account_number |
string |
Non |
Numéro de compte séquestre |
| escrow_account_location |
string |
Non |
Compte séquestre ouvert auprès de |
| insurance |
|
|
|
| name |
string |
Non |
Etablissement d'assurance |
| address |
string |
Non |
Adresse de l'établissement d'assurance |
| policy_number |
string |
Non |
Numéro de police d'assurance |
| licence |
Oui |
|
|
| holder |
string |
Non |
Titulaire de la carte |
| number |
string |
Non |
Numéro de carte professionnelle |
| delivery_location |
string |
Non |
Délivrée par la CCI de |
| validity_date_start |
string |
Non |
Date de début de validité de la carte |
| description |
|
|
|
locale |
text |
Non |
Description dans les différentes langues disponibles |
| user |
hash |
Oui |
Utilisateur crée avec l'agence |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| display_mobile |
boolean |
Non |
Numéro de mobile affichable |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Oui |
Email |
| director |
boolean |
Non |
Est l'utilisateur par défaut de l'agence |
| picture_url |
string |
Non |
Url de la photo de profil |
| rights |
string |
Non |
Code (agency_admin, agency_secretary, agency_agent, agency_trainee) liste séparée par une virgule |
| role |
string |
Non |
Fonction dans l'agence |
| licence |
|
|
|
| type |
string |
Non |
Type de carte professionnelle |
| agent_id |
string |
Non |
Numéro RSAC/RCS |
| licence_id |
string |
Non |
Numéro de carte professionnelle |
| validity_date_start |
string |
Non |
Date de début de validité de la carte |
| validity_date_end |
string |
Non |
Date de fin de validité de la carte |
| language |
Oui |
|
|
| code |
text |
Non |
Code de la langue |
locale |
text |
Non |
Langues parlées dans les différentes langues disponibles |
| description |
Oui |
|
|
locale |
text |
Non |
Description dans les différentes langues disponibles |
Réponse
{
"id": "oAlYy0",
"active": true,
"mls_status": true,
"name": "immosquare",
"commercial_name": "immosquare",
"phone": "+339XXXXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"logo_url": "https://mon-url/example.png",
"agency_picture_url": "https://mon-url/example.png",
"agency_header_url": "https://mon-url/example.png",
"agency_footer_url": "https://mon-url/example.png",
"address": {
"address_formatted": "23 Bd Pape Jean XXIII, 06300 Nice, France",
"street_number": "23",
"street_name": "Boulevard Pape Jean XXIII",
"zipcode": "06300",
"locality": "Nice",
"sublocality": "",
"latitude": "43.7106018066406",
"longitude": "7.2938899993896",
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Alpes-Maritimes",
"country": "France",
"country_iso_code": "fr"
},
"legal": {
"registration_name": "immosquare",
"registration_id": "RCS XXXXXXX",
"registration_location": "METZ",
"legal_representative": "M DIRECTOR",
"social_capital": "670000",
"fr": {
"guarantee_fund": {
"type": "Garantie avec réception de fonds",
"name": "FNAIM",
"address": "10 rue de la Boétie",
"policy_number": "4343",
"escrow_account_number": "SEQ : 98454545",
"escrow_account_location": "BNP"
},
"insurance": {
"name": "AXA",
"address": "11, rue des mines, 75008 Paris",
"policy_number": "AXA 2343"
}
}
},
"licence": {
"holder": "immosquare's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "immosquare Immobilier est une agence immobilière nouvelle génération, synthèse entre agence traditionnelle et agence virtuelle. Notre équipe d'expérience est constituée de collaborateurs tous impliqués au plus haut niveau de l’entreprise, qui sauront vous accompagner au mieux dans tous vos projets immobiliers sur la Côte d’Azur, que ce soit pour l’achat, la vente, la location ou la gestion locative de biens immobilier de prestige, de Menton à Saint-Tropez. tyty",
"en": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
},
"users": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "M DIRECTOR",
"last_name": "immosquare",
"full_name": "M DIRECTOR immosquare",
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "francesco@example.net",
"created_at": "2021-06-16T14:26:58.754+02:00",
"updated_at": "2024-07-22T14:48:10.662+02:00"
},
{
"id": "ql4Jgm",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Agent",
"last_name": "immosquare",
"full_name": "Agent immosquare",
"mobile": "+337XXXXXXXX",
"phone": "",
"email": "francesco2@example.net",
"created_at": "2021-06-16T14:26:59.148+02:00",
"updated_at": "2022-12-20T18:07:47.118+01:00"
}
]
}Mise à jour agence (Droits supplémentaires requis)
Cette route vous permet de mettre à jour une agence
Endpoint
PATCH https://app.mls-connect.com/fr/api/v3/agencies/:id
URL Parameters
| Parameter |
Type |
Requis |
Description |
| blocked_by_mls |
boolean |
Non |
Bloquée par le MLS (droits supplémentaires requis) |
| mls_status |
boolean |
Non |
Statut MLS - droits suplémentaire requis |
| name |
string |
Non |
Nom de l'agence |
| commercial_name |
string |
Non |
Nom de l'agence |
| phone |
string |
Non |
Téléphone de l'agence |
| email |
string |
Non |
Email de l'agence |
| website_url |
string |
Non |
Site web de l'agence |
| logo_url |
string |
Non |
URL du logo de l'agence |
| agency_picture_url |
string |
Non |
URL de la photo de l'agence |
| agency_header_url |
string |
Non |
URL de l'entête utilisée dans les documents de l'agence |
| agency_footer_url |
string |
Non |
URL du bas de page utilisé dans les documents de l'agence |
| address |
|
|
|
| address_formatted |
string |
Non |
Adresse formatée |
| street_number |
string |
Non |
Numéro de voie |
| street_name |
string |
Non |
Nom de voie |
| zipcode |
string |
Non |
Code postal |
| locality |
string |
Non |
Ville |
| sublocality |
string |
Non |
Nom du quartier |
| latitude |
float |
Non |
Latitude |
| longitude |
float |
Non |
Longitude |
| administrative_area_level1 |
string |
Non |
Région |
| administrative_area_level2 |
string |
Non |
Département |
| country |
string |
Non |
Pays |
| country_iso_code |
string |
Non |
Code ISO du pays |
| legal |
|
|
|
| registration_number |
string |
Non |
SIRET |
| registration_name |
string |
Non |
Raison sociale |
| registration_id |
string |
Non |
RCS / SIREN |
| registration_location |
string |
Non |
Inscrite au registre du commerce de |
| legal_representative |
string |
Non |
Représentant légal |
| social_capital |
string |
Non |
Capital social |
| fr |
|
|
|
| guarantee_fund |
|
|
|
| type |
string |
Non |
Type de garantie financière |
| name |
string |
Non |
Nom de la caisse de garantie |
| address |
string |
Non |
Adresse de la caisse de garantie |
| policy_number |
string |
Non |
Numéro de sociétaire |
| escrow_account_number |
string |
Non |
Numéro de compte séquestre |
| escrow_account_location |
string |
Non |
Compte séquestre ouvert auprès de |
| insurance |
|
|
|
| name |
string |
Non |
Etablissement d'assurance |
| address |
string |
Non |
Adresse de l'établissement d'assurance |
| policy_number |
string |
Non |
Numéro de police d'assurance |
| licence |
Oui |
|
|
| holder |
string |
Non |
Titulaire de la carte |
| number |
string |
Non |
Numéro de carte professionnelle |
| delivery_location |
string |
Non |
Délivrée par la CCI de |
| validity_date_start |
string |
Non |
Date de début de validité de la carte |
| description |
|
|
|
locale |
text |
Non |
Description dans les différentes langues disponibles |
Réponse
{
"id": "oAlYy0",
"active": true,
"mls_status": true,
"name": "immosquare",
"commercial_name": "immosquare",
"phone": "+339XXXXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"logo_url": "https://mon-url/example.png",
"agency_picture_url": "https://mon-url/example.png",
"agency_header_url": "https://mon-url/example.png",
"agency_footer_url": "https://mon-url/example.png",
"address": {
"address_formatted": "23 Bd Pape Jean XXIII, 06300 Nice, France",
"street_number": "23",
"street_name": "Boulevard Pape Jean XXIII",
"zipcode": "06300",
"locality": "Nice",
"sublocality": "",
"latitude": "43.7106018066406",
"longitude": "7.2938899993896",
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Alpes-Maritimes",
"country": "France",
"country_iso_code": "fr"
},
"legal": {
"registration_name": "immosquare",
"registration_id": "RCS XXXXXXX",
"registration_location": "METZ",
"legal_representative": "M DIRECTOR",
"social_capital": "670000",
"fr": {
"guarantee_fund": {
"type": "Garantie avec réception de fonds",
"name": "FNAIM",
"address": "10 rue de la Boétie",
"policy_number": "4343",
"escrow_account_number": "SEQ : 98454545",
"escrow_account_location": "BNP"
},
"insurance": {
"name": "AXA",
"address": "11, rue des mines, 75008 Paris",
"policy_number": "AXA 2343"
}
}
},
"licence": {
"holder": "immosquare's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "immosquare Immobilier est une agence immobilière nouvelle génération, synthèse entre agence traditionnelle et agence virtuelle. Notre équipe d'expérience est constituée de collaborateurs tous impliqués au plus haut niveau de l’entreprise, qui sauront vous accompagner au mieux dans tous vos projets immobiliers sur la Côte d’Azur, que ce soit pour l’achat, la vente, la location ou la gestion locative de biens immobilier de prestige, de Menton à Saint-Tropez. tyty",
"en": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
},
"users": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "M DIRECTOR",
"last_name": "immosquare",
"full_name": "M DIRECTOR immosquare",
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "francesco@example.net",
"created_at": "2021-06-16T14:26:58.754+02:00",
"updated_at": "2024-07-22T14:48:10.662+02:00"
},
{
"id": "ql4Jgm",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Agent",
"last_name": "immosquare",
"full_name": "Agent immosquare",
"mobile": "+337XXXXXXXX",
"phone": "",
"email": "francesco2@example.net",
"created_at": "2021-06-16T14:26:59.148+02:00",
"updated_at": "2022-12-20T18:07:47.118+01:00"
}
]
}Suppression agence (Droits supplémentaires requis)
Cette route vous permet de supprimer (désactiver) une agence
Endpoint
DELETE https://app.mls-connect.com/fr/api/v3/agencies/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
Réponse
{
"id": "oAlYy0",
"active": true,
"mls_status": true,
"name": "immosquare",
"commercial_name": "immosquare",
"phone": "+339XXXXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"logo_url": "https://mon-url/example.png",
"agency_picture_url": "https://mon-url/example.png",
"agency_header_url": "https://mon-url/example.png",
"agency_footer_url": "https://mon-url/example.png",
"address": {
"address_formatted": "23 Bd Pape Jean XXIII, 06300 Nice, France",
"street_number": "23",
"street_name": "Boulevard Pape Jean XXIII",
"zipcode": "06300",
"locality": "Nice",
"sublocality": "",
"latitude": "43.7106018066406",
"longitude": "7.2938899993896",
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Alpes-Maritimes",
"country": "France",
"country_iso_code": "fr"
},
"legal": {
"registration_name": "immosquare",
"registration_id": "RCS XXXXXXX",
"registration_location": "METZ",
"legal_representative": "M DIRECTOR",
"social_capital": "670000",
"fr": {
"guarantee_fund": {
"type": "Garantie avec réception de fonds",
"name": "FNAIM",
"address": "10 rue de la Boétie",
"policy_number": "4343",
"escrow_account_number": "SEQ : 98454545",
"escrow_account_location": "BNP"
},
"insurance": {
"name": "AXA",
"address": "11, rue des mines, 75008 Paris",
"policy_number": "AXA 2343"
}
}
},
"licence": {
"holder": "immosquare's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "immosquare Immobilier est une agence immobilière nouvelle génération, synthèse entre agence traditionnelle et agence virtuelle. Notre équipe d'expérience est constituée de collaborateurs tous impliqués au plus haut niveau de l’entreprise, qui sauront vous accompagner au mieux dans tous vos projets immobiliers sur la Côte d’Azur, que ce soit pour l’achat, la vente, la location ou la gestion locative de biens immobilier de prestige, de Menton à Saint-Tropez. tyty",
"en": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
},
"users": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "M DIRECTOR",
"last_name": "immosquare",
"full_name": "M DIRECTOR immosquare",
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "francesco@example.net",
"created_at": "2021-06-16T14:26:58.754+02:00",
"updated_at": "2024-07-22T14:48:10.662+02:00"
},
{
"id": "ql4Jgm",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Agent",
"last_name": "immosquare",
"full_name": "Agent immosquare",
"mobile": "+337XXXXXXXX",
"phone": "",
"email": "francesco2@example.net",
"created_at": "2021-06-16T14:26:59.148+02:00",
"updated_at": "2022-12-20T18:07:47.118+01:00"
}
]
}Activation agence (Droits supplémentaires requis)
Cette route vous permet de réactiver une agence
Endpoint
POST https://app.mls-connect.com/fr/api/v3/agencies/:id/activate
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
Réponse
{
"id": "oAlYy0",
"active": true,
"mls_status": true,
"name": "immosquare",
"commercial_name": "immosquare",
"phone": "+339XXXXXXXX",
"email": "info@immosquare.com",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471+02:00",
"updated_at": "2024-09-04T14:39:35.336+02:00",
"logo_url": "https://mon-url/example.png",
"agency_picture_url": "https://mon-url/example.png",
"agency_header_url": "https://mon-url/example.png",
"agency_footer_url": "https://mon-url/example.png",
"address": {
"address_formatted": "23 Bd Pape Jean XXIII, 06300 Nice, France",
"street_number": "23",
"street_name": "Boulevard Pape Jean XXIII",
"zipcode": "06300",
"locality": "Nice",
"sublocality": "",
"latitude": "43.7106018066406",
"longitude": "7.2938899993896",
"administrative_area_level1": "Provence-Alpes-Côte D'azur",
"administrative_area_level2": "Alpes-Maritimes",
"country": "France",
"country_iso_code": "fr"
},
"legal": {
"registration_name": "immosquare",
"registration_id": "RCS XXXXXXX",
"registration_location": "METZ",
"legal_representative": "M DIRECTOR",
"social_capital": "670000",
"fr": {
"guarantee_fund": {
"type": "Garantie avec réception de fonds",
"name": "FNAIM",
"address": "10 rue de la Boétie",
"policy_number": "4343",
"escrow_account_number": "SEQ : 98454545",
"escrow_account_location": "BNP"
},
"insurance": {
"name": "AXA",
"address": "11, rue des mines, 75008 Paris",
"policy_number": "AXA 2343"
}
}
},
"licence": {
"holder": "immosquare's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "immosquare Immobilier est une agence immobilière nouvelle génération, synthèse entre agence traditionnelle et agence virtuelle. Notre équipe d'expérience est constituée de collaborateurs tous impliqués au plus haut niveau de l’entreprise, qui sauront vous accompagner au mieux dans tous vos projets immobiliers sur la Côte d’Azur, que ce soit pour l’achat, la vente, la location ou la gestion locative de biens immobilier de prestige, de Menton à Saint-Tropez. tyty",
"en": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum",
"es": "",
"it": "",
"nl": "",
"pt": "",
"de": ""
},
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
},
"users": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "M DIRECTOR",
"last_name": "immosquare",
"full_name": "M DIRECTOR immosquare",
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "francesco@example.net",
"created_at": "2021-06-16T14:26:58.754+02:00",
"updated_at": "2024-07-22T14:48:10.662+02:00"
},
{
"id": "ql4Jgm",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Agent",
"last_name": "immosquare",
"full_name": "Agent immosquare",
"mobile": "+337XXXXXXXX",
"phone": "",
"email": "francesco2@example.net",
"created_at": "2021-06-16T14:26:59.148+02:00",
"updated_at": "2022-12-20T18:07:47.118+01:00"
}
]
}Passerelles agence (Droits supplémentaires requis)
Cette route vous permet d'obtenir les passerelles affectées à une agence
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/:id/gateways
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
Réponse
{
"name": "Agence de la gateway",
"id": "XL5ajL",
"active": true,
"active_label": "Actif",
"mls_status": true,
"is_on_portal": true,
"phone": "+33493431551",
"email": "test@test.com",
"registration_label": "N°SIRET : 4232XXXXXXXXX",
"registration_number": "4232XXXXXXXXX",
"website_url": "www.test.com",
"created_at": "2008-05-23T02:00:00.000000+02:00",
"updated_at": "2026-01-07T18:16:12.407181+01:00",
"mls_board": {
"id": "Yv68Wm",
"name": "MLS Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
},
"app": {
"id": "Q754l9",
"name": "mlsconnect",
"slug": "mlsconnect",
"domain": "app.mls-connect.com"
},
"gateways": [
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}
]
}Passerelles agence - Détail (Droits supplémentaires requis)
Cette route vous permet d'obtenir les passerelles affectées à une agence
Endpoint
GET https://app.mls-connect.com/fr/api/v3/agencies/:id/gateways/:id_gateway
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
| id_gateway |
string |
Id de la passerelle |
Réponse
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}Passerelles agence - Création (Droits supplémentaires requis)
Cette route vous permet de créer une passerelle à une agence
Endpoint
POST https://app.mls-connect.com/fr/api/v3/agencies/:id/gateways
URL Parameters
| Parameter |
Type |
Description |
| api_provider |
string |
Id du logiciel |
| pending |
boolean |
En attente Oui/Non |
| import |
boolean |
Est import |
| importfilename |
string |
Identifiant ou nom de fichier |
| import_type |
string |
api ou poliris |
| importapipass |
string |
Mot de passe |
| export |
boolean |
Est export |
| exportfilename |
string |
Identifiant ou nom de fichier |
| export_type |
string |
api ou poliris |
Réponse
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}Passerelles agence - Mise à jour (Droits supplémentaires requis)
Cette route vous permet de mettre à jour une passerelle d'une agence
Endpoint
PATCH https://app.mls-connect.com/fr/api/v3/agencies/:id/gateways/:id_gateway
URL Parameters
| Parameter |
Type |
Description |
| pending |
boolean |
En attente Oui/Non |
| import |
boolean |
Est import |
| importfilename |
string |
Identifiant ou nom de fichier |
| import_type |
string |
api ou poliris |
| importapipass |
string |
Mot de passe |
| export |
boolean |
Est export |
| exportfilename |
string |
Identifiant ou nom de fichier |
| export_type |
string |
api ou poliris |
Réponse
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}Passerelles agence - Suppression (Droits supplémentaires requis)
Cette route vous permet de supprimer une passerelle d'une agence
Endpoint
DELETE https://app.mls-connect.com/fr/api/v3/agencies/:id/gateways/:id_gateway
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'agence |
| id_gateway |
string |
Id de la passerelle |
Réponse
{
"success": true
}
Utilisateurs
Recherche utilisateurs
Cette route vous permet d'obtenir des informations sur les utilisateurs des agences dont vous dépendez
Endpoint
GET https://app.mls-connect.com/fr/api/v3/users/search
QUERY Parameters
| Parameter |
Type |
Description |
| active |
boolean |
Actif: true ou false |
| email |
string |
Email de l'utilisateur |
| created_at |
date |
Date de création égale à |
| created_at_gt |
date |
Date de création supérieur à |
| created_at_gte |
date |
Date de création supérieur ou égale à |
| created_at_lt |
date |
Date de création inférieur à |
| created_at_lte |
date |
Date de création inférieur ou égale à |
| updated_at |
date |
Date de mise à jour égale à |
| updated_at_gt |
date |
Date de mise à jour supérieur à |
| updated_at_gte |
date |
Date de mise à jour supérieur ou égale à |
| updated_at_lt |
date |
Date de mise à jour inférieur à |
| updated_at_lte |
date |
Date de mise à jour inférieur égale à |
| rights |
string |
Code (agency_admin, agency_secretary, agency_agent, agency_trainee) liste séparée par une virgule |
| uid |
string |
Uid de l'utilisateur - réference système externe |
| is_on_portal |
boolean |
Visible sur les portails externes |
| sort |
string |
Champ de tri (createdat, updatedat) |
| order |
string |
Ordre de tri (asc, desc) |
| per_page |
integer |
Nombre de résultats par page (défaut: 100, max: 2000) |
| page |
integer |
Numéro de page |
Réponse
{
"pagination": {
"total": 16,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 16,
"formatted": "1-16 sur 16"
},
"results": [
{
"id": "Mg6O0k",
"agency_id": "MLMVA5",
"active": false,
"first_name": "Anicette",
"last_name": "LUCAS",
"full_name": "Anicette LUCAS",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": null,
"email": "belia.bashirian@example.net",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"rights": "agency_agent",
"created_at": "2021-03-11T01:00:00.000+01:00",
"updated_at": "2024-05-30T09:51:40.177+02:00"
},
{
"id": "AlLk40",
"agency_id": "OLq9L1",
"active": false,
"first_name": "Émeric",
"last_name": "DUPUY",
"full_name": "Émeric DUPUY",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": null,
"email": "roslyn@example.net",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"rights": "agency_agent",
"created_at": "2006-11-12T01:00:00.000+01:00",
"updated_at": "2024-06-07T17:01:35.535+02:00"
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id de l'utilisateur |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| mlsboardid |
string |
Non |
Id du MLS |
| agency_id |
string |
Non |
Id agence |
| director |
boolean |
Non |
Est l'utilisateur par défaut de l'agence |
| active |
boolean |
Non |
Actif |
| active_label |
string |
Oui |
Label actif |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| first_name |
string |
Non |
Prénom |
| last_name |
string |
Non |
Nom |
| full_name |
string |
Non |
Nom complet |
| display_mobile |
boolean |
Non |
Numéro de mobile affichable |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Non |
Email |
| member_since_at |
datetime |
Non |
Membre depuis le |
| licence_label |
string |
Non |
Label licence |
| rights |
string |
Non |
Slug droits utilisateur |
| created_at |
string |
Non |
Date de création |
| updated_at |
string |
Non |
Date de dernière mise à jour |
Détails utilisateur
Cette route vous permet d'obtenir des informations détaillées sur un utilisateur
Endpoint
GET https://app.mls-connect.com/fr/api/v3/users/search/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'utilisateur |
Réponse
{
"id": "lnQRV0",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Olgana",
"last_name": "RIVERO",
"full_name": "Olgana RIVERO",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "xxxxxx@hotmail.com",
"default_user": true,
"public_url": null,
"picture_url": null,
"time_zone": "Lima",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"created_at": "2024-03-10T20:52:17.066+01:00",
"updated_at": "2024-03-10T20:52:17.066+01:00",
"role": {
"slug": "manager",
"name": {
"fr": "Dirigeant",
"en": "Manager",
"es": "Manager",
"it": "Responsabile",
"nl": "Zaakvoerder",
"pt": null,
"de": null,
"ru": null
}
},
"rights": {
"slug": "agency_admin",
"name": {
"fr": "Admin agence",
"fr-BE": "Admin agence",
"fr-CA": "Admin agence",
"en": "Agency admin",
"es": "Admin agence",
"es-LA": "Admin agence",
"it": "Admin agence",
"nl": "Admin agence",
"pt": "Admin agence",
"pt-BR": "Admin agence",
"de": "Admin agence",
"ru": "Admin agence"
}
},
"licence": {
"type": "adc_card",
"agent_id": "",
"licence_id": "",
"validity_date_start": "2022-09-13",
"validity_date_end": "2023-09-13"
},
"languages": [
{
"code": "en",
"fr": "Anglais",
"en": "English",
"es": "Inglés",
"it": "Inglese",
"nl": "Engels",
"pt": "Inglês",
"de": "Englisch",
"ru": "английский"
},
{
"code": "fr",
"fr": "Français",
"en": "French",
"es": "Francés",
"it": "Francese",
"nl": "Frans",
"pt": "Francês",
"de": "Französisch",
"ru": "французский"
},
{
"code": "it",
"fr": "Italien",
"en": "Italian",
"es": "Italiano",
"it": "Italiano",
"nl": "Italiaans",
"pt": "Italiano",
"de": "Italienisch",
"ru": "итальянский"
}
],
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": null,
"de": null
}
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id de l'utilisateur |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| mlsboardid |
string |
Non |
Id du MLS |
| agency_id |
string |
Non |
Id agence |
| active |
boolean |
Non |
Actif |
| active_label |
string |
Non |
Label actif |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| full_name |
string |
Oui |
Nom complet |
| display_mobile |
boolean |
Non |
Affichage du numéro de mobile |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Oui |
Email |
| director |
boolean |
Non |
Utilisateur par défaut de l'agence |
| public_url |
string |
Oui |
URL du profil publique |
| picture_url |
string |
Oui |
URL de la photo de l'agent |
| time_zone |
string |
Oui |
Fuseau horaire |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| member_since_at |
datetime |
Non |
Membre depuis le |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| role |
|
|
|
| name |
string |
Oui |
Nom du rôle |
| slug |
string |
Oui |
Code du rôle |
| rights |
|
|
|
| name |
string |
Oui |
Nom du droit Utilisateur |
| slug |
string |
Oui |
Code du rôle Utilisateur |
| licence |
|
|
|
| type |
string |
Oui |
Type de carte professionnelle |
| agent_label |
string |
Oui |
Label Numéro RSAC/RCS |
| agent_id |
string |
Oui |
Numéro RSAC/RCS |
| licence_label |
string |
Oui |
Label Numéro de carte professionnelle |
| licence_id |
string |
Oui |
Numéro de carte professionnelle |
| validity_date_start |
string |
Oui |
Date de début de validité de la carte |
| validity_date_end |
string |
Oui |
Date de fin de validité de la carte |
| licence_type |
|
|
|
| code |
text |
Oui |
Code du type de licence |
locale |
text |
Oui |
Nom du type de licence dans les différentes langues |
| languages |
|
|
|
locale |
text |
Oui |
Nom de la langue dans les différentes langues disponibles |
| description |
|
|
|
locale |
text |
Oui |
Description dans les différentes langues disponibles |
Création utilisateur (Droits supplémentaires requis)
Cette route vous permet de créer un utilisateur sur une agence
Endpoint
POST https://app.mls-connect.com/fr/api/v3/users
JSON Parameters
| Parameter |
Type |
Requis |
Description |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| agency |
string |
Oui |
Id agence |
| first_name |
string |
Non |
Prénom |
| last_name |
string |
Non |
Nom |
| display_mobile |
boolean |
Non |
Affichage du numéro de mobile |
| mobile |
string |
Non |
Numéro de téléphone portable |
| phone |
string |
Non |
Numéro de téléphone fixe |
| email |
string |
Non |
Email |
| public_url |
string |
Non |
URL du profil publique |
| picture_url |
string |
Non |
URL de la photo de l'agent |
| role |
string |
Non |
Code fonction au sein de l'agence |
| member_since_at |
datetime |
Non |
Date d'entrée en fonction |
| licence |
|
|
|
| type |
string |
Non |
Type de carte professionnelle |
| agent_id |
string |
Non |
Numéro RSAC/RCS |
| agent_label |
string |
Non |
Label Numéro RSAC/RCS |
| licence_id |
string |
Non |
Numéro de carte professionnelle |
| licence_label |
string |
Non |
Label Numéro de carte professionnelle |
| validity_date_start |
string |
Non |
Date de début de validité de la carte |
| validity_date_end |
string |
Non |
Date de fin de validité de la carte |
| licence_type |
|
|
|
| code |
text |
Non |
Code du type de licence |
locale |
text |
Non |
Nom du type de licence dans les différentes langues |
| languages |
|
|
|
| code |
text |
Non |
Code de la langue |
locale |
text |
Non |
Nom de la langue dans les différentes langues disponibles |
| description |
|
|
|
locale |
text |
Non |
Description dans les différentes langues disponibles |
Réponse
{
"id": "lnQRV0",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Olgana",
"last_name": "RIVERO",
"full_name": "Olgana RIVERO",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "xxxxxx@hotmail.com",
"default_user": true,
"public_url": null,
"picture_url": null,
"time_zone": "Lima",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"created_at": "2024-03-10T20:52:17.066+01:00",
"updated_at": "2024-03-10T20:52:17.066+01:00",
"role": {
"slug": "manager",
"name": {
"fr": "Dirigeant",
"en": "Manager",
"es": "Manager",
"it": "Responsabile",
"nl": "Zaakvoerder",
"pt": null,
"de": null,
"ru": null
}
},
"rights": {
"slug": "agency_admin",
"name": {
"fr": "Admin agence",
"fr-BE": "Admin agence",
"fr-CA": "Admin agence",
"en": "Agency admin",
"es": "Admin agence",
"es-LA": "Admin agence",
"it": "Admin agence",
"nl": "Admin agence",
"pt": "Admin agence",
"pt-BR": "Admin agence",
"de": "Admin agence",
"ru": "Admin agence"
}
},
"licence": {
"type": "adc_card",
"agent_id": "",
"licence_id": "",
"validity_date_start": "2022-09-13",
"validity_date_end": "2023-09-13"
},
"languages": [
{
"code": "en",
"fr": "Anglais",
"en": "English",
"es": "Inglés",
"it": "Inglese",
"nl": "Engels",
"pt": "Inglês",
"de": "Englisch",
"ru": "английский"
},
{
"code": "fr",
"fr": "Français",
"en": "French",
"es": "Francés",
"it": "Francese",
"nl": "Frans",
"pt": "Francês",
"de": "Französisch",
"ru": "французский"
},
{
"code": "it",
"fr": "Italien",
"en": "Italian",
"es": "Italiano",
"it": "Italiano",
"nl": "Italiaans",
"pt": "Italiano",
"de": "Italienisch",
"ru": "итальянский"
}
],
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": null,
"de": null
}
}Mise à jour utilisateur (Droits supplémentaires requis)
Cette route vous permet de mettre à jour un utilisateur sur une agence
Endpoint
PATCH https://app.mls-connect.com/fr/api/v3/users/:id
URL Parameters
| Parameter |
Type |
Requis |
Description |
| id |
string |
Oui |
Id de l'utilisateur |
JSON Parameters
| Parameter |
Type |
Requis |
Description |
| first_name |
string |
Non |
Prénom |
| last_name |
string |
Non |
Nom |
| display_mobile |
boolean |
Non |
Affichage du numéro de mobile |
| mobile |
string |
Non |
Numéro de téléphone portable |
| phone |
string |
Non |
Numéro de téléphone fixe |
| email |
string |
Non |
Email |
| public_url |
string |
Non |
URL du profil publique |
| picture_url |
string |
Non |
URL de la photo de l'agent |
| role |
string |
Non |
Code fonction au sein de l'agence |
| member_since_at |
datetime |
Non |
Date d'entrée en fonction |
| licence |
|
|
|
| type |
string |
Non |
Type de carte professionnelle |
| agent_id |
string |
Non |
Numéro RSAC/RCS |
| agent_label |
string |
Non |
Label Numéro RSAC/RCS |
| licence_id |
string |
Non |
Numéro de carte professionnelle |
| licence_label |
string |
Non |
Label Numéro de carte professionnelle |
| validity_date_start |
string |
Non |
Date de début de validité de la carte |
| validity_date_end |
string |
Non |
Date de fin de validité de la carte |
| licence_type |
|
|
|
| code |
text |
Non |
Code du type de licence |
locale |
text |
Non |
Nom du type de licence dans les différentes langues |
| languages |
|
|
|
| code |
text |
Non |
Code de la langue |
locale |
text |
Non |
Nom de la langue dans les différentes langues disponibles |
| description |
|
|
|
locale |
text |
Non |
Description dans les différentes langues disponibles |
Réponse
{
"id": "lnQRV0",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Olgana",
"last_name": "RIVERO",
"full_name": "Olgana RIVERO",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "xxxxxx@hotmail.com",
"default_user": true,
"public_url": null,
"picture_url": null,
"time_zone": "Lima",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"created_at": "2024-03-10T20:52:17.066+01:00",
"updated_at": "2024-03-10T20:52:17.066+01:00",
"role": {
"slug": "manager",
"name": {
"fr": "Dirigeant",
"en": "Manager",
"es": "Manager",
"it": "Responsabile",
"nl": "Zaakvoerder",
"pt": null,
"de": null,
"ru": null
}
},
"rights": {
"slug": "agency_admin",
"name": {
"fr": "Admin agence",
"fr-BE": "Admin agence",
"fr-CA": "Admin agence",
"en": "Agency admin",
"es": "Admin agence",
"es-LA": "Admin agence",
"it": "Admin agence",
"nl": "Admin agence",
"pt": "Admin agence",
"pt-BR": "Admin agence",
"de": "Admin agence",
"ru": "Admin agence"
}
},
"licence": {
"type": "adc_card",
"agent_id": "",
"licence_id": "",
"validity_date_start": "2022-09-13",
"validity_date_end": "2023-09-13"
},
"languages": [
{
"code": "en",
"fr": "Anglais",
"en": "English",
"es": "Inglés",
"it": "Inglese",
"nl": "Engels",
"pt": "Inglês",
"de": "Englisch",
"ru": "английский"
},
{
"code": "fr",
"fr": "Français",
"en": "French",
"es": "Francés",
"it": "Francese",
"nl": "Frans",
"pt": "Francês",
"de": "Französisch",
"ru": "французский"
},
{
"code": "it",
"fr": "Italien",
"en": "Italian",
"es": "Italiano",
"it": "Italiano",
"nl": "Italiaans",
"pt": "Italiano",
"de": "Italienisch",
"ru": "итальянский"
}
],
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": null,
"de": null
}
}Suppression utilisateur (Droits supplémentaires requis)
Cette route vous permet de désactiver un utilisateur sur une agence
Endpoint
DELETE https://app.mls-connect.com/fr/api/v3/users/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'utilisateur |
Réponse
{
"id": "lnQRV0",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Olgana",
"last_name": "RIVERO",
"full_name": "Olgana RIVERO",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "xxxxxx@hotmail.com",
"default_user": true,
"public_url": null,
"picture_url": null,
"time_zone": "Lima",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"created_at": "2024-03-10T20:52:17.066+01:00",
"updated_at": "2024-03-10T20:52:17.066+01:00",
"role": {
"slug": "manager",
"name": {
"fr": "Dirigeant",
"en": "Manager",
"es": "Manager",
"it": "Responsabile",
"nl": "Zaakvoerder",
"pt": null,
"de": null,
"ru": null
}
},
"rights": {
"slug": "agency_admin",
"name": {
"fr": "Admin agence",
"fr-BE": "Admin agence",
"fr-CA": "Admin agence",
"en": "Agency admin",
"es": "Admin agence",
"es-LA": "Admin agence",
"it": "Admin agence",
"nl": "Admin agence",
"pt": "Admin agence",
"pt-BR": "Admin agence",
"de": "Admin agence",
"ru": "Admin agence"
}
},
"licence": {
"type": "adc_card",
"agent_id": "",
"licence_id": "",
"validity_date_start": "2022-09-13",
"validity_date_end": "2023-09-13"
},
"languages": [
{
"code": "en",
"fr": "Anglais",
"en": "English",
"es": "Inglés",
"it": "Inglese",
"nl": "Engels",
"pt": "Inglês",
"de": "Englisch",
"ru": "английский"
},
{
"code": "fr",
"fr": "Français",
"en": "French",
"es": "Francés",
"it": "Francese",
"nl": "Frans",
"pt": "Francês",
"de": "Französisch",
"ru": "французский"
},
{
"code": "it",
"fr": "Italien",
"en": "Italian",
"es": "Italiano",
"it": "Italiano",
"nl": "Italiaans",
"pt": "Italiano",
"de": "Italienisch",
"ru": "итальянский"
}
],
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": null,
"de": null
}
}Activation utilisateur (Droits supplémentaires requis)
Cette route vous permet de réactiver un utilisateur sur une agence
Endpoint
POST https://app.mls-connect.com/fr/api/v3/users/:id/activate
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'utilisateur |
Réponse
{
"id": "lnQRV0",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Olgana",
"last_name": "RIVERO",
"full_name": "Olgana RIVERO",
"display_mobile": false,
"mobile": "+337XXXXXXXX",
"phone": "+339XXXXXXXX",
"email": "xxxxxx@hotmail.com",
"default_user": true,
"public_url": null,
"picture_url": null,
"time_zone": "Lima",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"created_at": "2024-03-10T20:52:17.066+01:00",
"updated_at": "2024-03-10T20:52:17.066+01:00",
"role": {
"slug": "manager",
"name": {
"fr": "Dirigeant",
"en": "Manager",
"es": "Manager",
"it": "Responsabile",
"nl": "Zaakvoerder",
"pt": null,
"de": null,
"ru": null
}
},
"rights": {
"slug": "agency_admin",
"name": {
"fr": "Admin agence",
"fr-BE": "Admin agence",
"fr-CA": "Admin agence",
"en": "Agency admin",
"es": "Admin agence",
"es-LA": "Admin agence",
"it": "Admin agence",
"nl": "Admin agence",
"pt": "Admin agence",
"pt-BR": "Admin agence",
"de": "Admin agence",
"ru": "Admin agence"
}
},
"licence": {
"type": "adc_card",
"agent_id": "",
"licence_id": "",
"validity_date_start": "2022-09-13",
"validity_date_end": "2023-09-13"
},
"languages": [
{
"code": "en",
"fr": "Anglais",
"en": "English",
"es": "Inglés",
"it": "Inglese",
"nl": "Engels",
"pt": "Inglês",
"de": "Englisch",
"ru": "английский"
},
{
"code": "fr",
"fr": "Français",
"en": "French",
"es": "Francés",
"it": "Francese",
"nl": "Frans",
"pt": "Francês",
"de": "Französisch",
"ru": "французский"
},
{
"code": "it",
"fr": "Italien",
"en": "Italian",
"es": "Italiano",
"it": "Italiano",
"nl": "Italiaans",
"pt": "Italiano",
"de": "Italienisch",
"ru": "итальянский"
}
],
"description": {
"fr": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker.",
"en": "",
"es": "",
"it": "",
"nl": "",
"pt": null,
"de": null
}
}Recherches sauvegardées (Droits supplémentaires requis)
Cette route vous permet d'obtenir les recherches sauvegardées d'un ou des utilisateurs d'une agence
Endpoint
GET https://app.mls-connect.com/fr/api/v3/saved-searches
QUERY Parameters
Au moins un des deux paramètres user_id ou agency_id est requis.
| Parameter |
Type |
Description |
| user_id |
string |
Id de l'utilisateur |
| agency_id |
string |
Id de l'agence (utilise le directeur ou premier utilisateur) |
Réponse
{
"pagination": {
"total": 1,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 1,
"formatted": "1-1 sur 1"
},
"results": [
{
"id": "n1vlpq",
"user_id": "gwk5eg",
"agency_id": "wbO6kL",
"name": "Test",
"search_params": "agency_active=true&app=Q754l9&order=desc&property_type=appartment,house&search_geocoder=m&search_type=zone&sort=online_at&transaction_type=for-sale&user_active=true",
"created_at": "2026-02-24T14:57:35.159029+01:00",
"updated_at": "2026-02-24T14:57:35.159029+01:00"
}
]
}Recherches sauvegardées - propriétés (Droits supplémentaires requis)
Cette route vous permet d'obtenir les propriétés correspondant à une recherche sauvegardée
Endpoint
GET https://app.mls-connect.com/fr/api/v3/saved-searches/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de la recherche sauvegardée |
| user_id |
string |
Id de l'utilisateur (userid ou agencyid requis) |
| agency_id |
string |
Id de l'agence (userid ou agencyid requis) |
Réponse
{
"took": 2,
"pagination": {
"total": 31,
"current_page": 1,
"previous_page": null,
"next_page": 2,
"last_page": 2,
"length": 30,
"offset": 0,
"from": 1,
"to": 30,
"formatted": "1-30 sur 31"
},
"results": [
{
"id": "y34R6b",
"reference": "FR342016",
"mandate_number": "",
"is_external": false,
"ref_from_import": "",
"is_on_portal": true,
"is_mls": false,
"is_private": true,
"mls_board": {
"id": "Yv68Wm"
},
"building": {
"id": "W340gO",
"name": "VERNEUIL",
"number_of_floors": 4
},
"estimate": {
"id": null,
"active": false,
"status": 0
},
"agency": {
"id": "oPKYy0",
"name": "immosquare",
"active": true,
"blocked_by_mls": false,
"mls_status": true
},
"user": {
"id": "Mg890k",
"name": "Agent immosquare",
"active": true
},
"price": 990.0,
"price_by_area": 15.71,
"fees": 12004.3,
"fee_type": {
"slug": "acquereur",
"fr": "Acquéreur",
"en": "Acquéreur",
"es": "Acquéreur",
"it": "Acquéreur",
"nl": null,
"pt": null,
"de": null,
"ru": null
},
"sold_price": 990.0,
"currency": "eur",
"currency_sym": "€",
"price_formatted": {
"fr": "990 €/mois",
"en": "€990/month"
},
"dates_formatted": {
"mandate_end_date_at": {
"fr": "04/09/17",
"en": "04/09/17"
},
"mandate_start_date_at": {
"fr": "05/09/16",
"en": "05/09/16"
},
"sold_date_at": {
"fr": "12/08/19",
"en": "12/08/19"
},
"sales_agreement_date_at": {
"fr": "05/09/16",
"en": "05/09/16"
},
"last_price_decrease_at": {
"fr": null,
"en": null
}
},
"cover_url": "https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"assets": [
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg",
"https://example.com/asset/attachment/e6b1a4a3-9db4-4cd6-9d90-c004ba14021e.jpg"
],
"area": 63,
"area_carrez": 63,
"area_unit": "m2",
"area_land": 0.0,
"area_garden": 0.0,
"area_living_room": 0.0,
"area_terrace": 0.0,
"area_balcony": 0.0,
"area_formatted": "63 m<sup>2</sup>",
"created_at": "2016-09-05T15:43:51.740+02:00",
"updated_at": "2021-12-14T12:05:19.495+01:00",
"online": true,
"online_at": "2021-09-27T11:49:52.000+02:00",
"offline_at": "2025-01-20T15:08:10.127831+01:00",
"offline_reason": {
"slug": "removed-by-gateway",
"fr": "Bien retiré de la passerelle",
"en": "Removed by gateway"
},
"mandate_end_date_at": "2017-09-04",
"mandate_start_date_at": "2016-09-05",
"back_to_sale_date_at": null,
"sold_date_at": "2019-08-12",
"sales_agreement_date_at": "2016-09-05",
"last_price_decrease_at": null,
"ongoing_offer_number": 0,
"level": null,
"floor": 3,
"parking_garage": null,
"balcony_number": 1,
"terrace_number": null,
"rooms": 3,
"bedrooms": 0,
"bathrooms": 0,
"urgent_sale": false,
"house_name": "",
"address": "2 Impasse des Noisetiers 06100 NICE",
"address_short": "2 Impasse des Noisetiers",
"address_allowed_to_display": true,
"zipcode": "06100",
"amenties": [
"balcony",
"cellar",
"elevator"
],
"condition": null,
"view": null,
"exposition": null,
"adjoining": null,
"optical_fiber": null,
"last_floor": false,
"is_life_lease": false,
"is_sold_rent": false,
"furnished": false,
"dpe_setuped": true,
"energy_reference_letter": null,
"consumption_reference_letter": null,
"country_detail": {
"fr": {
"dpe": {
"dpe_letter": "D",
"dpe_value": 164.0,
"ges_letter": "E",
"ges_value": 38.0,
"dpe_no_subject_to": false,
"date_start": "2024-08-12"
}
},
"be": null,
"it": null
},
"country": {
"iso_code": "fr",
"slug": "france",
"name": "France"
},
"area_level_1": {
"iso_code": "PAC",
"slug": "provence-alpes-cote-d-azur",
"name": "Provence-Alpes-Côte D'azur"
},
"area_level_2": {
"iso_code": "06",
"slug": "alpes-maritimes",
"name": "Alpes-Maritimes"
},
"locality": {
"slug": "nice",
"name": "Nice"
},
"sublocality": {
"slug": "chambrun",
"name": "Chambrun"
},
"geocodable_type": "precise",
"geocodable": true,
"location_geohash": "spv0tr3xp",
"location": {
"lat": 43.7227,
"lon": 7.26433
},
"geocodable_false": true,
"location_geohash_false": "spv0tr9h6",
"location_false": {
"lat": 43.7236,
"lon": 7.26343
},
"transaction_type": {
"slug": "rent",
"fr": "Loué",
"en": "Rent"
},
"property_type": {
"slug": "appartment",
"fr": "Appartement",
"en": "Appartment"
},
"property_subtype": {
"slug": null,
"fr": null,
"en": null
},
"property_status": {
"slug": "active",
"fr": "Actif",
"en": "Active"
},
"mandate": {
"slug": "exclusive",
"fr": "Exclusif",
"en": "Exclusive"
},
"title": {
"fr": "<span class=\"fw-semibold\">Appartement</span> 3 pièces 63.0 m2 - <span class=\"fw-semibold\">990 €/mois</span> - Loué ",
"en": "<span class=\"fw-semibold\">Appartment</span> 3 rooms 63.0 m2 - <span class=\"fw-semibold\">€990/month</span> - Rent "
},
"description": {
"fr": "Nice Nord : 3 Pièces de 63 m², calme et lumineux situé impasse des Noisetiers. Ce bien est composé d'un salon, de deux chambres, d'une cuisine séparée, d'une salle de bain, WC indépendant et balcons. Il comporte une cave et un parking en sous sol.",
"en": ""
},
"description_short": {
"fr": "Nice Nord : 3 Pièces de 63 m², calme et lumineux situé impasse des Noisetiers.",
"en": null
}
}
]
}Connect (Droits supplémentaires requis)
Recherche connect
Endpoint
GET https://app.mls-connect.com/fr/api/v3/connects/search
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| contact |
string |
Non |
Id du contact |
| default |
boolean |
Oui |
Conversation générale oui/non |
Réponse
{
"pagination": {
"total": 8,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 8,
"formatted": "1-8 sur 8"
},
"results": [
{
"id": "k0vglq",
"property_id": "JX06zb",
"created_at": "2023-09-07T10:06:36.209438+02:00",
"updated_at": "2024-11-28T13:59:32.173362+01:00",
"contact": [
{
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXX",
"last_name": "XXXXXX",
"email": "XXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"mobile": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"last_read_message_id": "QpLVGQ",
"auto_connect": "https://XXXXX"
}
],
"user": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Jérôme",
"last_name": "CHABLIS",
"full_name": "Jérôme CHABLIS",
"display_mobile": false,
"mobile": "+33767281970",
"phone": "",
"email": "jchiron@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00",
"last_read_message_id": "QpLVGQ",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"auto_connect": "https://XXXX"
}
],
"default": false,
"last_message": {
"id": "Aj1g5z",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"created_at": "2024-11-28T13:59:32.167837+01:00",
"updated_at": "2024-11-28T13:59:32.167837+01:00",
"author_type": "Contact",
"contact": {
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXX",
"last_name": "XXXXXX",
"email": "XXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
}
},
{
"id": "9NnW39",
"property_id": null,
"created_at": "2023-09-11T10:49:44.773034+02:00",
"updated_at": "2023-09-14T17:21:20.180189+02:00",
"contact": [
{
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXX",
"last_name": "XXXXXX",
"email": "XXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"mobile": "+33605040302",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"last_read_message_id": "QpLVGQ",
"auto_connect": "https://XXXX"
}
],
"user": [
{
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "Jérôme",
"last_name": "CHABLIS",
"full_name": "Jérôme CHABLIS",
"display_mobile": false,
"mobile": "+33767281970",
"phone": "",
"email": "jchiron@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00",
"last_read_message_id": "QpLVGQ",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"auto_connect": "https://XXXX"
}
],
"default": true,
"last_message": {
"id": "AOk4KA",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"created_at": "2023-09-14T17:21:19.694135+02:00",
"updated_at": "2023-09-14T17:21:19.694135+02:00",
"author_type": "Contact",
"contact": {
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXX",
"last_name": "XXXXXX",
"email": "XXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
}
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
| property_id |
string |
Oui |
Id du bien |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| default |
boolean |
Non |
Connect par défaut |
| contact |
Non |
Objet contact |
|
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
Email |
| phone |
string |
Oui |
Téléphone |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
| last_read_message_id |
string |
Oui |
Id du dernier message lu |
| auto_connect |
string |
Non |
Lien de l'autoconnect du contact |
| user |
|
|
|
| id |
string |
Non |
Id de l'utilisateur |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| mlsboardid |
string |
Non |
Id du MLS |
| agency_id |
string |
Non |
Id agence |
| director |
boolean |
Non |
Est l'utilisateur par défaut de l'agence |
| active |
boolean |
Non |
Actif |
| active_label |
string |
Oui |
Label actif |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| first_name |
string |
Non |
Prénom |
| last_name |
string |
Non |
Nom |
| full_name |
string |
Non |
Nom complet |
| display_mobile |
boolean |
Non |
Numéro de mobile affichable |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Non |
Email |
| member_since_at |
datetime |
Non |
Membre depuis le |
| licence_label |
string |
Non |
Label licence |
| rights |
string |
Non |
Slug droits utilisateur |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| last_read_message_id |
string |
Oui |
Id du dernier message lu |
| auto_connect |
string |
Non |
Lien de l'autoconnect de l'utilisateur |
| agency |
|
|
|
| name |
string |
Non |
Nom de l'agence |
| id |
string |
Non |
Id de l'agence |
| active |
boolean |
Non |
Active |
| active_label |
string |
Non |
Label actif |
| mls_status |
string |
Non |
Statut MLS |
| phone |
string |
Oui |
Téléphone de l'agence |
| email |
string |
Oui |
Email de l'agence |
| registration_label |
string |
Oui |
Label numéro d'enregistrement |
| registration_number |
string |
Oui |
Numéro d'enregistrement |
| website_url |
string |
Oui |
Site web de l'agence |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| mls_board |
|
|
|
| id |
string |
Non |
Id du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso de la langue par défaut |
| last_message |
Non |
Dernier message |
|
| id |
string |
Non |
Id du message |
| message |
string |
Non |
Contenu du message |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| author_type |
string |
Non |
Type d'auteur (User ou Contact) |
Détail connect
Endpoint
GET https://app.mls-connect.com/fr/api/v3/connects/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
Réponse
{
"id": "AxL0lA",
"property_id": "5Dj3kZ",
"created_at": "2025-04-16T11:04:32.103669+02:00",
"updated_at": "2025-04-16T11:04:32.122429+02:00",
"contact": [
{
"id": "6zVdxn",
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"last_read_message_id": "z0NxYQ",
"auto_connect": "https://XXXX"
}
],
"user": [
{
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "User",
"last_name": "Default",
"full_name": "User Default",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "user.default@example.com",
"member_since_at": "2021-06-16T14:26:59.406214+02:00",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406214+02:00",
"updated_at": "2024-06-18T11:34:30.089070+02:00",
"last_read_message_id": "QpLVGQ",
"auto_connect": "https://XXXX",
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+336XXXXXXXX",
"email": "info@immosquare.com",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
}
}
}
],
"default": false,
"last_message": {
"id": "9v2JJ9",
"message": "Hello, I am John Doe nexrt next",
"created_at": "2025-04-23T14:09:16.902338+02:00",
"updated_at": "2025-04-23T14:09:16.902338+02:00",
"author_type": "Contact",
"contact": {
"id": "6zVdxn",
"uid": null,
"archived": false,
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
},
"messages": [
{
"id": "9nXk5A",
"message": "Amélie BRUNET vient de modifier le statut du bien à Refusé",
"created_at": "2023-11-22T09:44:14.107463+01:00",
"updated_at": "2023-11-22T09:44:14.107463+01:00",
"author_type": "Contact",
"contact": {
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "Amélie",
"last_name": "BRUNET",
"email": "xxxxx@xxxx.com",
"phone": "+33666666666",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-15T15:19:15.574607+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
| property_id |
string |
Oui |
Id du bien |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| default |
boolean |
Non |
Connect par défaut |
| contact |
Non |
Objet contact |
|
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
Email |
| phone |
string |
Oui |
Téléphone |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
| last_read_message_id |
string |
Oui |
Id du dernier message lu |
| auto_connect |
string |
Non |
Lien de l'autoconnect du contact |
| user |
|
|
|
| id |
string |
Non |
Id de l'utilisateur |
| uid |
string |
Non |
Uid de l'utilisateur - réference système externe |
| mlsboardid |
string |
Non |
Id du MLS |
| agency_id |
string |
Non |
Id agence |
| director |
boolean |
Non |
Est l'utilisateur par défaut de l'agence |
| active |
boolean |
Non |
Actif |
| active_label |
string |
Oui |
Label actif |
| is_on_portal |
boolean |
Non |
Visible sur les portails externes |
| first_name |
string |
Non |
Prénom |
| last_name |
string |
Non |
Nom |
| full_name |
string |
Non |
Nom complet |
| display_mobile |
boolean |
Non |
Numéro de mobile affichable |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Non |
Email |
| member_since_at |
datetime |
Non |
Membre depuis le |
| licence_label |
string |
Non |
Label licence |
| rights |
string |
Non |
Slug droits utilisateur |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| last_read_message_id |
string |
Oui |
Id du dernier message lu |
| auto_connect |
string |
Non |
Lien de l'autoconnect de l'utilisateur |
| agency |
|
|
|
| name |
string |
Non |
Nom de l'agence |
| id |
string |
Non |
Id de l'agence |
| active |
boolean |
Non |
Active |
| active_label |
string |
Non |
Label actif |
| mls_status |
string |
Non |
Statut MLS |
| phone |
string |
Oui |
Téléphone de l'agence |
| email |
string |
Oui |
Email de l'agence |
| registration_label |
string |
Oui |
Label numéro d'enregistrement |
| registration_number |
string |
Oui |
Numéro d'enregistrement |
| website_url |
string |
Oui |
Site web de l'agence |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| mls_board |
|
|
|
| id |
string |
Non |
Id du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso de la langue par défaut |
| last_message |
Non |
Dernier message |
|
| id |
string |
Non |
Id du message |
| message |
string |
Non |
Contenu du message |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| author_type |
string |
Non |
Type d'auteur (User ou Contact) |
| messages |
Non |
Liste des messages |
|
| id |
string |
Non |
Id du message |
| message |
string |
Non |
Contenu du message |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| author_type |
string |
Non |
Type d'auteur (User ou Contact) |
Création connect
Cette route vous permet de créer un connect, cette route est désactivé et est activable sur demande pour vos credentials
Si aucun utilisateur n'est renseigné, le message sera envoyé à l'utilisateur par défaut de l'agence.
Endpoint
POST https://app.mls-connect.com/fr/api/v3/connects
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| first_name |
string |
Non |
Prénom du contact |
| last_name |
string |
Non |
Nom du contact |
| email |
string |
Non |
Email du contact |
| agency |
string |
Non |
Id de l'agence |
| message |
string |
Non |
Message à faire parvenir à l'utilisateur |
| phone |
string |
Oui |
Téléphone du contact |
| property |
string |
Oui |
Id du bien en relation |
| user |
string |
Oui |
Id de l'utilisateur |
| contact |
string |
Oui |
Id du contact |
| project |
string |
Oui |
Id du projet |
Réponse
{
"id": "AxL0lA",
"property_id": "5Dj3kZ",
"created_at": "2025-04-16T11:04:32.103669+02:00",
"updated_at": "2025-04-16T11:04:32.122429+02:00",
"contact": [
{
"id": "6zVdxn",
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"last_read_message_id": "z0NxYQ",
"auto_connect": "https://XXXX"
}
],
"user": [
{
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "User",
"last_name": "Default",
"full_name": "User Default",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "user.default@example.com",
"member_since_at": "2021-06-16T14:26:59.406214+02:00",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406214+02:00",
"updated_at": "2024-06-18T11:34:30.089070+02:00",
"last_read_message_id": "QpLVGQ",
"auto_connect": "https://XXXX",
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+336XXXXXXXX",
"email": "info@immosquare.com",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
}
}
}
],
"default": false,
"last_message": {
"id": "9v2JJ9",
"message": "Hello, I am John Doe nexrt next",
"created_at": "2025-04-23T14:09:16.902338+02:00",
"updated_at": "2025-04-23T14:09:16.902338+02:00",
"author_type": "Contact",
"contact": {
"id": "6zVdxn",
"uid": null,
"archived": false,
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
},
"messages": [
{
"id": "9nXk5A",
"message": "Amélie BRUNET vient de modifier le statut du bien à Refusé",
"created_at": "2023-11-22T09:44:14.107463+01:00",
"updated_at": "2023-11-22T09:44:14.107463+01:00",
"author_type": "Contact",
"contact": {
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "Amélie",
"last_name": "BRUNET",
"email": "xxxxx@xxxx.com",
"phone": "+33666666666",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-15T15:19:15.574607+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
| property_id |
string |
Oui |
Id du bien |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| user |
Non |
Objet utilisateur (cf json user) |
|
| last_message |
Non |
Dernier message |
|
| id |
string |
Non |
Id du message |
| message |
string |
Non |
Contenu du message |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| author_type |
string |
Non |
Type d'auteur (User ou Contact) |
| contact |
Non |
Objet contact (cf json contact) |
|
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
Email |
| phone |
string |
Oui |
Téléphone |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
Création message
Endpoint
POST https://app.mls-connect.com/fr/api/v3/connects/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
| message |
string |
Non |
Message du contact |
Réponse
{
"id": "AxL0lA",
"property_id": "5Dj3kZ",
"created_at": "2025-04-16T11:04:32.103669+02:00",
"updated_at": "2025-04-16T11:04:32.122429+02:00",
"contact": [
{
"id": "6zVdxn",
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"last_read_message_id": "z0NxYQ",
"auto_connect": "https://XXXX"
}
],
"user": [
{
"id": "Mg120k",
"agency_id": "oAlYy0",
"active": true,
"first_name": "User",
"last_name": "Default",
"full_name": "User Default",
"mobile": "+336XXXXXXXX",
"phone": "",
"email": "user.default@example.com",
"member_since_at": "2021-06-16T14:26:59.406214+02:00",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:59.406214+02:00",
"updated_at": "2024-06-18T11:34:30.089070+02:00",
"last_read_message_id": "QpLVGQ",
"auto_connect": "https://XXXX",
"agency": {
"name": "immosquare",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+336XXXXXXXX",
"email": "info@immosquare.com",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur"
}
}
}
],
"default": false,
"last_message": {
"id": "9v2JJ9",
"message": "Hello, I am John Doe nexrt next",
"created_at": "2025-04-23T14:09:16.902338+02:00",
"updated_at": "2025-04-23T14:09:16.902338+02:00",
"author_type": "Contact",
"contact": {
"id": "6zVdxn",
"uid": null,
"archived": false,
"first_name": "John",
"last_name": "DOE",
"email": "john.doe@example.com",
"phone": "+33669466809",
"created_at": "2025-04-15T13:43:38.006455+02:00",
"updated_at": "2025-04-15T13:43:38.201219+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
},
"messages": [
{
"id": "9nXk5A",
"message": "Amélie BRUNET vient de modifier le statut du bien à Refusé",
"created_at": "2023-11-22T09:44:14.107463+01:00",
"updated_at": "2023-11-22T09:44:14.107463+01:00",
"author_type": "Contact",
"contact": {
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "Amélie",
"last_name": "BRUNET",
"email": "xxxxx@xxxx.com",
"phone": "+33666666666",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-15T15:19:15.574607+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
}
}
]
}Mettre un connect en lu
Endpoint
POST https://app.mls-connect.com/fr/api/v3/connects/search/:id/read
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du connect |
Réponse
{
"success": "success"
}
MLS Board
Recherche Mls board
Cette route vous permet d'obtenir des informations sur les mls board dont vous dépendez
Endpoint
GET https://app.mls-connect.com/fr/api/v3/mls-boards/search
[
{
"id": "Yv68Wm",
"name": "Mls 1",
"slug": "mls-1",
"default_language": "fr"
},
{
"id": "4qNoW8",
"name": "Mls 2",
"slug": "mls-2",
"default_language": "fr"
}
]Passerelles MLS (Droits supplémentaires requis)
Cette route vous permet d'obtenir les passerelles disponibles sur le MLS board dont vous dépendez
Endpoint
GET https://app.mls-connect.com/fr/api/v3/mls-boards/:id/gateways
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du MLS |
Réponse
{
"mls_board": {
"id": "Yv68Wm",
"name": "MLS Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
},
"app": {
"id": "Q754l9",
"name": "mlsconnect",
"slug": "mlsconnect",
"domain": "app.mls-connect.com"
},
"gateways": [
{
"id": "YnyjAd",
"active": 1,
"api_provider": {
"id": "pKVNK4",
"name": "Software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-10-12T16:02:20.075992+02:00",
"updated_at": "2026-01-07T18:09:40.020663+01:00"
}
},
{
"id": "EnR9V8",
"active": 1,
"api_provider": {
"id": "eLy7Kw",
"name": "Software 2",
"slug": "software-2",
"active": true,
"created_at": "2022-05-18T13:37:44.410659+02:00",
"updated_at": "2026-01-07T18:09:40.015622+01:00"
}
}
]
}Projets (Droits supplémentaires requis)
Recherche projets
Endpoint
GET https://app.mls-connect.com/fr/api/v3/projects/search
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| agency |
string |
Oui |
Id de l'agence |
| user |
string |
Oui |
Id de l'utilisateur |
| contact |
string |
Oui |
Id du contact |
| active |
boolean |
Oui |
Projet actif |
Réponse
{
"pagination": {
"total": 2,
"current_page": 1,
"previous_page": null,
"next_page": 1,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 100,
"formatted": "1-2 sur 2"
},
"results": [
{
"id": "m5X1W4",
"name": "Cimiez-Musiciens",
"active": false,
"created_at": "2022-02-16T23:37:26.202536+01:00",
"updated_at": "2024-06-24T22:33:56.088985+02:00",
"agency_id": "oAlYy0",
"user_id": "Mg120k",
"contact": {
"id": "bNrapL",
"uid": null
}
},
{
"id": "9zZKvL",
"name": "Antibes - Mr X",
"active": false,
"created_at": "2022-02-17T04:25:28.129506+01:00",
"updated_at": "2024-06-07T14:48:16.557765+02:00",
"agency_id": "oAlYy0",
"user_id": "Mg120k",
"contact": {
"id": "o6vB6l",
"uid": null
}
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
| name |
string |
Oui |
Nom du projet |
| active |
boolean |
Non |
Projet actif |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
| contact |
Non |
Objet contact |
|
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
Détail projet
Endpoint
GET https://app.mls-connect.com/fr/api/v3/projects/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
| name |
string |
Oui |
Nom du projet |
| active |
boolean |
Non |
Projet actif |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| agency |
Non |
Objet agence |
|
| name |
string |
Non |
Nom de l'agence |
| id |
string |
Non |
Id de l'agence |
| active |
boolean |
Non |
Active |
| mls_status |
string |
Non |
Statut MLS |
| phone |
string |
Oui |
Téléphone de l'agence |
| email |
string |
Oui |
Email de l'agence |
| website_url |
string |
Oui |
Site web de l'agence |
| created_at |
date |
Non |
Date de création |
| updated_at |
date |
Non |
Date de dernière mise à jour |
| mls_board |
|
|
|
| id |
string |
Non |
Id du MLS |
| name |
string |
Non |
Nom du MLS |
| slug |
string |
Non |
Code du MLS |
| default_language |
string |
Non |
Code iso de la langue par défaut |
| user |
Non |
Objet utilisateur |
|
| id |
string |
Non |
Id de l'utilisateur |
| agency_id |
string |
Non |
Id agence |
| active |
boolean |
Non |
Actif |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| full_name |
string |
Oui |
Nom complet |
| mobile |
string |
Oui |
Numéro de téléphone portable |
| display_mobile |
boolean |
Non |
Affichage du numéro de mobile |
| phone |
string |
Oui |
Numéro de téléphone fixe |
| email |
string |
Oui |
Email |
| member_since_at |
date |
Non |
Membre depuis le |
| rights |
string |
Non |
Code des droits utilisateurs |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de dernière mise à jour |
| contact |
Non |
Objet contact |
|
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
Email |
| phone |
string |
Oui |
Téléphone |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
| filters |
Non |
Filtres du projet |
|
| key |
string |
Oui |
Clé du filtre |
| value |
string |
Oui |
Valeur du filtre |
| properties |
Non |
Liste des propriétés du projet |
|
| id |
string |
Non |
Id de la propriété |
| created_at |
datetime |
Non |
Date de création |
| updated_at |
datetime |
Non |
Date de modification |
| status |
Non |
Statut de la proposition |
|
| slug |
string |
Non |
Code du statut |
| name |
Non |
Nom du statut |
|
| locale |
string |
Non |
Nom dans les différentes langues |
Mettre à jour le statut d'une propriété d'un projet
Endpoint
POST https://app.mls-connect.com/fr/api/v3/projects/search/:id/:property_id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
| property_id |
string |
Non |
Id de la propriété |
| alert_proposition_status_type |
string |
Non |
Status de la propriété (refused, favorite, unlike(*)) |
(*) unlike permet de retirer le statut d'une proposition
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Ajouter une propriété à un projet
Endpoint
POST https://app.mls-connect.com/fr/api/v3/projects/search/:id/add/:property_id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
| property_id |
string |
Non |
Id de la propriété |
| contact |
string |
Oui |
Id du contact qui ajoute (contact ou user requis) |
| user |
string |
Oui |
Id du user qui ajoute (contact ou user requis) |
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Retirer une propriété à un projet
Endpoint
DELETE https://app.mls-connect.com/fr/api/v3/projects/search/:id/:property_id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
| property_id |
string |
Non |
Id de la propriété |
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Désactiver un projet
Endpoint
DELETE https://app.mls-connect.com/fr/api/v3/projects/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Réactiver un projet
Endpoint
POST https://app.mls-connect.com/fr/api/v3/projects/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du projet |
Réponse
{
"id": "WaMmKW",
"name": null,
"active": true,
"created_at": "2024-10-22T17:55:07.165095+02:00",
"updated_at": "2025-06-30T15:29:27.836405+02:00",
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": true,
"mls_status": true,
"phone": "+33387493901",
"email": "info@immosquare.com",
"registration_label": "N°SIRET : 123456",
"registration_number": "123456",
"website_url": "https://immosquare.com",
"created_at": "2021-06-16T14:26:58.471772+02:00",
"updated_at": "2025-04-17T10:48:34.184772+02:00",
"mls_board": {
"id": "Yv68Wm",
"name": "Mls Côte d'Azur",
"slug": "mls-cote-d-azur",
"default_language": "fr"
}
},
"user": {
"id": "DgwMle",
"agency_id": "oAlYy0",
"active": true,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"full_name": "XXXXXXXXX XXXXXXXXX",
"display_mobile": false,
"mobile": "+33XXXXXXXXX",
"phone": "",
"email": "XXXXXXXXX@immosquare.com",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"licence_label": "Carte pro : RESDG",
"rights": "agency_admin",
"created_at": "2021-06-16T14:26:58.754899+02:00",
"updated_at": "2024-12-09T16:10:58.631450+01:00"
},
"contact": {
"id": "o6vOqL",
"uid": null,
"first_name": "XXXXXXXXX",
"last_name": "XXXXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle"
},
"filters": [
{
"key": "transaction_type",
"value": "À Vendre"
},
{
"key": "property_type",
"value": "Maison"
}
],
"properties": [
{
"id": "gbZr0b",
"created_at": "2024-11-28T16:39:07.256341+01:00",
"updated_at": "2025-06-30T17:55:34.201686+02:00",
"status": {
"slug": "favorite",
"name": {
"fr": "Favoris",
"fr-BE": "Favoris",
"fr-CA": "Favoris",
"en": "Favorite",
"es": "Favoris",
"es-LA": "Favoris",
"it": "Favoris",
"nl": "Favoris",
"pt": "Favoris",
"pt-BR": "Favoris",
"de": "Favoris",
"ru": "Favoris"
}
}
},
{
"id": "dXN88b",
"created_at": "2024-11-28T16:39:07.266378+01:00",
"updated_at": "2024-11-28T16:39:07.266378+01:00",
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}
]
}Endpoint
GET https://app.mls-connect.com/fr/api/v3/contacts/search
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| agency |
string |
Oui |
Id de l'agence |
| user |
string |
Oui |
Id de l'utilisateur |
| archived |
boolean |
Oui |
Contact archivé |
Réponse
{
"pagination": {
"total": 2,
"current_page": 1,
"previous_page": null,
"next_page": 1,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 100,
"formatted": "1-2 sur 2"
},
"results": [
{
"id": "5LAbNl",
"uid": null,
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"created_at": "2021-10-28T23:39:42.827559+02:00",
"updated_at": "2024-05-03T15:32:24.926075+02:00",
"agency_id": "oAlYy0",
"user_id": "Mg120k"
},
{
"id": "b6B26k",
"uid": null,
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"created_at": "2021-10-28T23:41:56.740747+02:00",
"updated_at": "2024-05-03T15:32:25.251297+02:00",
"agency_id": "oAlYy0",
"user_id": "Mg120k"
}
]
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
email |
| phone |
string |
Oui |
Téléphone |
| created_at |
string |
Non |
Date de création |
| updated_at |
string |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
Endpoint
GET https://app.mls-connect.com/fr/api/v3/contacts/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du contact |
Réponse
{
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"mobile": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"society": null,
"contact_identities": [
{
"id": "nj9Jg1",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2023-09-08T16:39:13.795774+02:00",
"updated_at": "2023-09-08T16:39:13.795774+02:00"
},
{
"id": "3jnBVj",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2025-04-18T11:40:32.323308+02:00",
"updated_at": "2025-04-18T11:40:32.323308+02:00"
},
{
"id": "mjE7MQ",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2025-06-30T17:42:00.412465+02:00",
"updated_at": "2025-06-30T17:42:00.412465+02:00"
}
],
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
},
"origin": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du contact |
| uid |
string |
Oui |
Id externe |
| archived |
boolean |
Non |
Contact archivé |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
email |
| phone |
string |
Oui |
Téléphone |
| mobile |
string |
Oui |
Téléphone portable |
| created_at |
string |
Non |
Date de création |
| updated_at |
string |
Non |
Date de modification |
| agency_id |
string |
Non |
Id de l'agence |
| user_id |
string |
Oui |
Id de l'utilisateur |
| society |
string |
Oui |
Nom société |
| contact_identities |
--------- |
Non |
Identités supplémentaires |
| id |
string |
Non |
Id du contact |
| first_name |
string |
Oui |
Prénom |
| last_name |
string |
Oui |
Nom |
| email |
string |
Oui |
email |
| phone |
string |
Oui |
Téléphone |
| mobile |
string |
Oui |
Téléphone portable |
| created_at |
string |
Non |
Date de création |
| updated_at |
string |
Non |
Date de modification |
| status |
--------- |
Non |
Statut du contact |
| slug |
string |
Oui |
Code |
| name |
string |
Oui |
Nom |
| origin |
--------- |
Non |
Origine |
| slug |
string |
Oui |
Code |
| name |
string |
Oui |
Nom |
Endpoint
POST https://app.mls-connect.com/fr/api/v3/contacts/search/:id
URL Parameters
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id du contact |
JSON Parameters
| Parameter |
Type |
Nullable |
Description |
| uid |
string |
Oui |
Id externe du contact |
| phone |
string |
Oui |
Téléphone du contact |
| email |
string |
Oui |
Email du contact |
Réponse
{
"id": "o6vOqL",
"uid": null,
"archived": false,
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "XXXXXXXXX@immosquare.com",
"phone": "+33XXXXXXXXX",
"mobile": "+33XXXXXXXXX",
"created_at": "2022-05-16T17:22:26.590961+02:00",
"updated_at": "2025-07-01T14:16:12.136178+02:00",
"agency_id": "oAlYy0",
"user_id": "DgwMle",
"society": null,
"contact_identities": [
{
"id": "nj9Jg1",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2023-09-08T16:39:13.795774+02:00",
"updated_at": "2023-09-08T16:39:13.795774+02:00"
},
{
"id": "3jnBVj",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2025-04-18T11:40:32.323308+02:00",
"updated_at": "2025-04-18T11:40:32.323308+02:00"
},
{
"id": "mjE7MQ",
"first_name": "XXXXXXX",
"last_name": "XXXXXXX",
"email": "",
"phone": "",
"mobile": "",
"created_at": "2025-06-30T17:42:00.412465+02:00",
"updated_at": "2025-06-30T17:42:00.412465+02:00"
}
],
"status": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
},
"origin": {
"slug": null,
"name": {
"fr": null,
"fr-BE": null,
"fr-CA": null,
"en": null,
"es": null,
"es-LA": null,
"it": null,
"nl": null,
"pt": null,
"pt-BR": null,
"de": null,
"ru": null
}
}
}Passerelles (Droits supplémentaires requis)
Recherche passerelles
Cette route vous permet d'obtenir les passerelles disponibles sur un MLS board
Endpoint
GET https://app.mls-connect.com/fr/api/v3/gateways/search
QUERY Parameters
| Parameter |
Type |
Description |
| mls_board |
string |
Id du MLS (requis) |
Réponse
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}Détail passerelle
Cette route vous permet d'obtenir le détail d'une passerelle
Endpoint
GET https://app.mls-connect.com/fr/api/v3/gateways/search/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de la passerelle |
Réponse
{
"id": "BX1MyX",
"pending": false,
"import": true,
"import_file_name": "MAGXXXXX",
"import_type": "poliris",
"import_api_pass": null,
"export": false,
"export_file_name": null,
"export_type": "poliris",
"created_at": "2024-06-02T12:51:55.254764+02:00",
"updated_at": "2024-06-02T12:51:55.254764+02:00",
"api_provider": {
"id": "wrpELY",
"name": "software 1",
"slug": "software-1",
"active": true,
"created_at": "2022-05-18T13:37:45.239746+02:00",
"updated_at": "2026-01-07T18:09:40.019519+01:00"
}
}Emailings (Droits supplémentaires requis)
Détail emailing
Cette route vous permet d'obtenir le détail d'un emailing (lien externe de propriété)
Endpoint
GET https://app.mls-connect.com/fr/api/v3/emailings/search/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
string |
Id de l'emailing |
Paramétres de la réponse
| Parameter |
Type |
Nullable |
Description |
| id |
string |
Non |
Id de l'emailing |
| user |
object |
Non |
Objet utilisateur (cf json user) |
| properties |
array |
Non |
Liste des propriétés |
Locations
Pays
Cette route vous permet de lister les pays disponibles
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/countries
QUERY Parameters
| Parameter |
Type |
Description |
| search |
string |
Recherche par nom, slug ou code ISO |
| page |
integer |
Numéro de page |
| per_page |
integer |
Nombre de résultats par page (max 100) |
Réponse
{
"pagination": {
"total": 12,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 12,
"formatted": "1-12 sur 12"
},
"data": [
{
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
{
"id": 2,
"name": "Belgique",
"slug": "belgique",
"iso_code": "be"
}
]
}Détail pays
Cette route vous permet d'obtenir le détail d'un pays
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/countries/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
integer |
Id du pays |
Réponse
{
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
}Régions
Cette route vous permet de lister les régions (administrative area level 1)
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/administrative_area_level1
QUERY Parameters
| Parameter |
Type |
Description |
| country |
integer |
Id du pays |
| search |
string |
Recherche par nom ou slug |
| page |
integer |
Numéro de page |
| per_page |
integer |
Nombre de résultats par page (max 100) |
Réponse
{
"pagination": {
"total": 22,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 22,
"formatted": "1-22 sur 22"
},
"data": [
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
}
}
]
}Détail région
Cette route vous permet d'obtenir le détail d'une région
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/administrative_area_level1/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
integer |
Id de la région |
Réponse
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
}
}Départements
Cette route vous permet de lister les départements (administrative area level 2)
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/administrative_area_level2
QUERY Parameters
| Parameter |
Type |
Description |
| country |
integer |
Id du pays |
| administrativearealevel1 |
integer |
Id de la région |
| search |
string |
Recherche par nom ou slug |
| page |
integer |
Numéro de page |
| per_page |
integer |
Nombre de résultats par page (max 100) |
Réponse
{
"pagination": {
"total": 101,
"current_page": 1,
"previous_page": null,
"next_page": 2,
"last_page": 2,
"length": 100,
"offset": 0,
"from": 1,
"to": 100,
"formatted": "1-100 sur 101"
},
"data": [
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
}
}
]
}Détail département
Cette route vous permet d'obtenir le détail d'un département
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/administrative_area_level2/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
integer |
Id du département |
Réponse
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
}
}Villes
Cette route vous permet de lister les villes (localities)
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/localities
QUERY Parameters
| Parameter |
Type |
Description |
| country |
integer |
Id du pays |
| administrativearealevel1 |
integer |
Id de la région |
| administrativearealevel2 |
integer |
Id du département |
| zip_code |
string |
Code postal |
| search |
string |
Recherche par nom ou slug |
| page |
integer |
Numéro de page |
| per_page |
integer |
Nombre de résultats par page (max 100) |
Réponse
{
"pagination": {
"total": 543,
"current_page": 1,
"previous_page": null,
"next_page": 2,
"last_page": 6,
"length": 100,
"offset": 0,
"from": 1,
"to": 100,
"formatted": "1-100 sur 543"
},
"data": [
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
},
"locality": {
"id": 543,
"name": "Nice",
"slug": "nice",
"zip_code": "06000,06100,06200,06300",
"latitude": 43.7101728,
"longitude": 7.2619532
}
}
]
}Détail ville
Cette route vous permet d'obtenir le détail d'une ville
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/localities/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
integer |
Id de la ville |
Réponse
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
},
"locality": {
"id": 543,
"name": "Nice",
"slug": "nice",
"zip_code": "06000,06100,06200,06300",
"latitude": 43.7101728,
"longitude": 7.2619532
}
}Quartiers
Cette route vous permet de lister les quartiers (sublocalities)
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/sublocalities
QUERY Parameters
| Parameter |
Type |
Description |
| country |
integer |
Id du pays |
| administrativearealevel1 |
integer |
Id de la région |
| administrativearealevel2 |
integer |
Id du département |
| locality |
integer |
Id de la ville |
| search |
string |
Recherche par nom ou slug |
| page |
integer |
Numéro de page |
| per_page |
integer |
Nombre de résultats par page (max 100) |
Réponse
{
"pagination": {
"total": 28,
"current_page": 1,
"previous_page": null,
"next_page": null,
"last_page": 1,
"length": 100,
"offset": 0,
"from": 1,
"to": 28,
"formatted": "1-28 sur 28"
},
"data": [
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
},
"locality": {
"id": 543,
"name": "Nice",
"slug": "nice",
"zip_code": "06000,06100,06200,06300",
"latitude": 43.7101728,
"longitude": 7.2619532
},
"sublocality": {
"id": 1024,
"name": "Chambrun",
"slug": "chambrun"
}
}
]
}Détail quartier
Cette route vous permet d'obtenir le détail d'un quartier
Endpoint
GET https://app.mls-connect.com/fr/api/v3/locations/sublocalities/:id
URL Parameters
| Parameter |
Type |
Description |
| id |
integer |
Id du quartier |
Réponse
{
"country": {
"id": 1,
"name": "France",
"slug": "france",
"iso_code": "fr"
},
"administrative_area_level1": {
"id": 12,
"name": "Provence-Alpes-Côte D'azur",
"slug": "provence-alpes-cote-d-azur",
"iso_code": "PAC"
},
"administrative_area_level2": {
"id": 6,
"name": "Alpes-Maritimes",
"slug": "alpes-maritimes",
"iso_code": "06"
},
"locality": {
"id": 543,
"name": "Nice",
"slug": "nice",
"zip_code": "06000,06100,06200,06300",
"latitude": 43.7101728,
"longitude": 7.2619532
},
"sublocality": {
"id": 1024,
"name": "Chambrun",
"slug": "chambrun"
}
}Types
Type d'honoraire - fee_type
| Slug |
Description |
| acquereur |
Acquéreur |
| acquereur-et-vendeur |
Acquéreur et Vendeur |
| vendeur |
Vendeur |
Raison de mise hors ligne - offline_reason
| Slug |
Description |
| converted-to-simple-mandate |
Transformation en mandat simple |
| entered-in-error |
Saisi par erreur |
| estimation-deleted |
Estimation supprimée |
| mandate-expired |
Mandat échu |
| mandate-removed-by-mandator |
Retiré par le mandant |
| mandate-renew |
Mandat à renouveler |
| old-mls-agency |
Ancienne agence MLS |
| removed-by-gateway |
Retiré par la passerelle |
| sold |
Vendu |
Type de transaction - transaction_type
| Slug |
Description |
| draft |
Brouillon |
| validation |
En attente de validation |
| estimate |
Estimation |
| for-sale |
À vendre |
| under-offer |
Sous offre acceptée |
| under-agreement |
Sous compromis |
| sold |
Vendu |
| to-rent |
À louer |
| rent |
Loué |
| mandate-withdrawal |
Retiré |
Type de propriété - property_type
| Slug |
Description |
| appartment |
Appartement |
| building |
Immeuble de rapport |
| commercial-office |
Commerce/Bureau |
| garage-parking |
Garage/Parking |
| house |
Maison |
| land |
Terrain |
| others |
Autre propriété |
Sous type de propriété - property_subtype
| Type de propriété |
slug |
Description |
| appartment |
appartement |
Appartement |
| appartment |
atelier-d-artiste |
Atelier d'artiste |
| appartment |
bureau |
Bureau |
| appartment |
chambre-de-service |
Chambre de service |
| appartment |
duplex |
Duplex |
| appartment |
entresol |
Entresol |
| appartment |
penthouse |
Penthouse |
| appartment |
plateau-brut |
Plateau Brut |
| appartment |
studio |
Studio |
| appartment |
triplex |
Triplex |
| building |
medical-building |
Immeuble à destination médical |
| building |
mixed-use-building |
Immeuble mixte |
| commercial-office |
business-office |
Bureau - Local Professionnel |
| commercial-office |
commercial |
Commerce - Bail Commercial |
| commercial-office |
commercial-for-sale |
Murs commerciaux |
| garage-parking |
closed-box |
Box fermé |
| garage-parking |
indoor-garage |
Garage en sous-sol |
| garage-parking |
indoor-parking |
Parking en sous-sol |
| garage-parking |
outdoor-garage |
Garage extérieur |
| garage-parking |
outdoor-parking |
Parking extérieur |
| house |
bastide-mas |
Bastide / Mas |
| house |
bungalow |
Bungalow |
| house |
castle-manor |
Château / Manoir |
| house |
country-house |
Maison de campagne |
| house |
farm-grange |
Ferme / Grange |
| house |
haras |
Haras |
| house |
house-architect |
Maison d'architecte |
| house |
maison-individuelle |
Maison individuelle |
| house |
manor-house |
Maison de maître |
| house |
mansion |
Hôtel Particulier |
| house |
mountain-chalet |
Chalet |
| house |
private-island |
Ile Privée |
| house |
ruin |
Ruine |
| house |
town-house |
Maison de ville |
| house |
villa |
Villa |
| house |
villa-jumelee |
Maison jumelée |
| house |
village-house |
Maison de village |
| house |
vineyard |
Domaine Viticole |
| house |
waterfront-property |
Maison pieds dans l'eau |
| land |
agricultural |
Agricole |
| land |
buildable |
Constructible |
| land |
industrial-commercial |
Industriel / Commercial |
| land |
leasure |
Loisir |
| land |
unbuildable |
Inconstructible |
| others |
attic |
Grenier |
| others |
cellar |
Cave |
| others |
diverse |
Divers |
| others |
maid_room |
Chambre de bonne |
| others |
storage_building |
Hangar |
| others |
storeroom |
Cellier |
| others |
warehouse |
Entrepôt |
Type de mandat - mandate
| Slug |
Description |
| co-exclusive |
Co-exclusif |
| exclusive |
Exclusif |
| off-market |
Off market |
| open |
Open |
| simple |
Simple |
Type de viager - lease
| Slug |
Description |
| forward-sale |
Vente à terme |
| free |
Viager libre |
| occupied |
Viager occupé |
Type de mitoyenneté - adjoining_building
| Slug |
Description |
| attached |
Jumelée 2 cotés |
| attached-by-garage |
Jumelée garage |
| detached |
Individuelle |
| semi-detached |
Jumelée 1 coté |
| twin-3-sides |
Jumelée 3 côtés |
Type fermeture - closure
| Slug |
Description |
| automatic |
Automatique |
| manual |
Manuelle |
| to-create |
Possible à réaliser |
| without |
Sans |
Type état - condition
| Slug |
Description |
| excellent-condition |
Très bon état |
| good |
Bon état |
| needs-renovating |
A rénover |
| needs-work |
A rafraichir |
| new |
Neuf / Rénové |
Type configuration - configuration
| Slug |
Description |
| flat |
Plat |
| high-scales |
Planches élevées |
| scales |
En terrasse |
| small-slope |
Pente douce |
| steep-slope |
Pente forte |
| street-embankment |
Talus à rue |
Type exposition - exposition
| Slug |
Description |
| east |
Est |
| north |
Nord |
| north-east |
Nord-Est |
| north-west |
Nord-Ouest |
| south |
Sud |
| south-east |
Sud-Est |
| south-west |
Sud-Ouest |
| west |
Ouest |
Type murs extérieurs - external_wall
| Slug |
Description |
| bricks |
Briques |
| briks |
Briques |
| cladding |
Bardage |
| concrete |
Béton |
| concrete-blocks |
Parpaings |
| crepis |
Crépis |
| stone |
Pierre |
| to-be-finished |
A parachever |
| wood |
Bois |
Type statut juridique - legal_status
| Slug |
Description |
| emphyteusis |
Emphytéose |
| free-property |
Nue-propriété |
| single-owner |
Pleine propriété |
| undivided-state |
Indivision |
| usufruct |
Usufruit |
Type de revêtement sol - floor
| Slug |
Description |
| carpet |
Moquette |
| cement |
Ciment brut |
| granit |
Granit |
| laminate-flooring |
Parquet stratifié |
| marble |
Marbre |
| mosaic |
Mosaïque |
| natural-stone |
Pierre naturelle |
| painted-cement |
Ciment peint |
| parquet |
Parquet bois |
| plastic |
Vinyl |
| terracotta |
Terre cuite |
| tiles |
Carrelage |
| vintage-tiles |
Carrelage à l'ancienne |
Type de plancher - flooring
| Slug |
Description |
| concrete |
Béton |
| steel |
Acier |
| vaults |
Voutes |
| woog |
Bois |
Type de statut des garages - garage_status
| Slug |
Description |
| excluded |
En sus |
| included |
Inclus |
| rental |
Location |
Type de vitrage - glazing
| Slug |
Description |
| double |
Double vitrage |
| mixed |
Double vitrage en partie |
| single |
Simple vitrage |
| triple |
Autre vitrage isolant |
| triple-glazing |
Triple vitrage |
Type de chauffage - heating
| Slug |
Description |
| airflow |
Air pulsé |
| electric-radiator |
Convecteur |
| radiator |
Radiateur |
| underfloor |
Sol |
Type de énergie chauffage - heating_method
| Slug |
Description |
| citern-gaz |
Bottled gas |
| city-gaz |
Town gas |
| climatisation |
Climatisation |
| cpcu |
Chauffage urbain |
| electric |
Electrique |
| fuel |
Mazout |
| gas |
Gaz |
| geothermal |
Géothermique |
| heat-pump |
Pompe à chaleur |
| oil-stove |
Poêle à mazout |
| passive-heating |
Chauffage passif |
| pellet-stove |
Poêle à pellets |
| solar |
Solaire |
| wood |
Bois |
| wood-stove |
Poêle à bois |
Type eau chaude - hot_water
| Slug |
Description |
| boiler |
Boiler électrique |
| boiler-via-heating-system |
Boiler via la chaudière |
| cpcu |
Chauffage urbain |
| fuel |
Mazout |
| gas |
Gaz |
| heat-pump |
Pompe à chaleur |
| solar |
Solaire |
Type cuisine - kitchen
| Slug |
Description |
| empty |
Nue |
| full-equiped |
Equipée |
| furnitured |
Aménagée |
| semi-equipped |
Semi équipée |
| super-equipped |
Super équipée |
Type toiture - roof
| Slug |
Description |
| artificial-slate |
Ardoise artificielle |
| concrete-tiles |
Tuiles Béton |
| metal-cladding |
Bardage métallique |
| roof-terrace |
Terrasse |
| roofing |
Roofing |
| shingle |
Shingle |
| slate-tiles |
Ardoise |
| thatch |
Chaume |
| tiles |
Tuiles |
| vegetal |
Membrane |
| zinc-lead |
Zinc-Plomb |
Type assainissement - sanitation
| Slug |
Description |
| dispersal-drain |
Drain dispersant |
| drainage-pit |
Puits perdu |
| fosse-a-debordement |
Fosse à débordement |
| natural-environment |
Milieu naturel |
| septic-tank |
Fosse septique |
| sewer |
Egout |
| to-create |
Inexistant |
| treatment-plant |
Station d'épuration |
Type volets - shutter
| Slug |
Description |
| electric |
Roulants électriques |
| electric-partial |
Roulants électriques en partie |
| manual |
Roulants manuels |
| ouvrants |
Ouvrants |
| shutters |
Persiennes |
| sunshade |
Pare-soleil |
Type standing - standing
| Slug |
Description |
| good |
Bon Standing |
| low |
Standard |
| luxury |
Luxe |
Type style - style
| Slug |
Description |
| 50-60-year |
Années 50/60 |
| art-nouveau |
Art nouveau |
| belle-epoque |
Art déco |
| bourgeoise |
Bourgeoise |
| californian |
Californienne |
| contemporary |
Contemporain |
| florentine |
Florentin |
| nicois |
Niçois |
| regional |
Provençale |
| rural |
Rural |
| standard |
Standard |
Type environnement - surroundings
| Slug |
Description |
| city |
Ville |
| city-houses |
Pavillonnaire |
| commercial |
Commercial |
| country |
Campagne |
| industrial |
Industriel |
| isolated |
Isolé |
| peri-urban |
Péri-urbain |
| residential |
Résidentiel |
| village |
Village |
Type éléments céder - transferred_element
| Slug |
Description |
| company |
Société |
| lease-rights |
Cession de bail |
| leasehold |
Fond de commerce |
Type végétation - vegetation
| Slug |
Description |
| farm-land |
Terres agricoles |
| none |
Nu |
| planted-garden |
Complanté |
| pond |
Etang |
| prairie |
Prairie |
| wasteland |
Friche |
| woods |
Boisé |
Type vue principale - view_principal
| Slug |
Description |
| clear |
Dégagée |
| overview |
Aperçu |
| panoramic |
Panoramique |
Type vue - view
| Slug |
Description |
| city |
Ville |
| country |
Campagne |
| courtyard |
Cour |
| hills |
Collines |
| mountain |
Montagne |
| sea |
Mer |
| street |
Rue |
| vegetation |
Verdure |
| Slug |
Description |
| alu |
Alu |
| galvanized-steel |
Acier-Galva |
| mixt |
Mixte |
| pvc |
PVC |
| wood |
Bois |
Type modalité de charges complémentaires - charge_modality
| Slug |
Description |
| forfaitaires-mensuelles |
Forfaitaires mensuelles |
| previsonnelles-mensuelles-avec-regularisation-annuelle |
Prévisonnelles mensuelles avec régularisation annuelle |
| remboursement-annuel-par-le-locataire |
Remboursement annuel par le locataire |
Type construction immeuble
| Slug |
Description |
| brick |
Brique |
| concrete |
Béton |
| haussmannian |
Haussmannien |
| metal-structure |
Structure métal |
| mosaic |
Mosaïque |
| prefabricated |
Préfabriqué |
| stone |
Pierre |
| wood |
Bois |
Type chauffage immeuble - building_heating
| Slug |
Description |
| collective |
Collectif |
| individual |
Individuel |
| mixed |
Mixte |
Type standing immeuble - building_standing
| Slug |
Description |
| bourgeois |
Bourgeois |
| good |
Standing |
| low |
Plan Courant |
| luxe |
Luxe |
| old |
Ancien |
| residential |
Bon Standing |
Type eau chaude immeuble - building_hot_water
| Slug |
Description |
| collective |
Collectif |
| individual |
Individuel |
| mixed |
Mixte |
Type de bail
| Slug |
Description |
| be-commercial |
Commercial |
| commercial |
Commercial |
| common-law |
Droit commun |
| furnished |
Habitation meublée |
| garage |
Garage |
| main-residence-9-years |
Résidence principale 9 ans |
| main-residence-colocation |
Résidence principale colocation |
| main-residence-short-term |
Résidence principale court terme |
| mobility |
Mobilité |
| professional |
Professionnel |
| residential |
Habitation vide |
| short-time |
Précaire |
| student |
Étudiant |
| student-lease |
Bail étudiant |
Type de fibre optique
| Slug |
Description |
| no |
Non |
| possible |
Possible |
| undetermined |
Non déterminé |
| yes |
Oui |
Droits utilisateurs
| Slug |
Description |
| agency_admin |
Admin agence |
| agency_secretary |
Assistant(e) de direction |
| agency_agent |
Agent |
| agency_trainee |
Stagiaire |
Type évolution du prix - price_evolution_type
| Slug |
Description |
| price_increase |
Hausse de prix |
| price_decrease |
Baisse de prix |
Versions
La version actuelle de MLS CONNECT est: v7
V7 - 10/03/2026: corrections de la documentation (types de données, descriptions, tables de référence), ajout des routes panier agence, refus collaboration, passerelles globales, emailings et locations
V7 - 04/03/2026: ajout des routes crud agences, utilisateurs, propriétés, passerelles et recherches sauvegardées