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.
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 fourni |
agency_active |
boolean |
Si agence active |
adjoining |
string |
Type de mittoyenneté, liste séparé par une virgule {attached, attached-by-garage, detached, semi-detached } |
amenity |
string |
Liste séparée par une virgule: {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} |
area_balcony_terrace |
integer |
Surface balcon ou terrasse supérieur à |
area_from |
integer |
Surface minimum |
area_garden |
integer |
Surface jardin supérieur à |
area_land |
integer |
Surface terrain supérieur à |
area_living_room |
integer |
Surface séjour supérieur à |
area_to |
integer |
Surface maximum |
back_to_sale_date_at_lte |
date |
Date de remise en vente inférieur ou égale à (YYYY-MM-DD) |
bedrooms |
string |
Liste séparé par une virgule de nombre de chambres, ex 1,2,3,4,5 |
bedrooms_from |
integer |
Nombre de chambres supérieur à |
building |
string |
Id sécurisé disponible dans la réponse |
circle |
string |
Ex: 7.272547,43.71769,20m |
condition |
string |
Etat du bien, liste séparé par une virgule: {new, good, needs-work, needs-renovating, excellent-condition} |
country |
string |
Liste séparé par une virgule de code pays (fr,be) |
created_at_gt |
datetime |
Date de création supérieur à |
created_at_gte |
datetime |
Date de création supérieur ou égale à |
created_at_lt |
datetime |
Date de création inférieur à |
created_at_lte |
datetime |
Date de création inférieur ou égale à |
dpe_letter |
string |
Lettre du dpe, liste séparé par une virgule: {A,B,C,D,E,F,G} |
exposition |
string |
Expostion du bien, liste séparé par une virgule: {north, north-east, east, south-east, south, south-west, west, north-west} |
floor |
integer |
Etage supérieur à |
furnished |
boolean |
Meublé |
ges_letter |
string |
Lettre du ges, liste séparé par une virgule: {A,B,C,D,E,F,G} |
is_life_lease |
boolean |
Viager |
is_sold_rent |
boolean |
Vendu loué |
keywords |
string |
Mot clés: {Référence, Ville, Quartier, Prix} |
last_price_decrease_at_gte |
date |
Date de dernière baisse de prix supérieur ou égale à (YYYY-MM-DD) |
level |
integer |
Etage ou niveau supérieur à |
mandate |
string |
Type de mandat, liste séparé par une virgule: {exclusive, open, simple} |
mandate_start_date_at_gt |
date |
Date de début de mandat supérieur à (YYYY-MM-DD) |
mandate_end_date_gt |
date |
Date de fin de mandat supérieur à (YYYY-MM-DD) |
mls_board |
string |
Id du MLS (Note: pour avoir toutes les options du mls pris en compte dans votre demande, nous vous recommandons de le passer dans chacune de vos requêtes) |
online_at_gte |
date |
Date de publication supérieur à (YYYY-MM-DD) |
online_at_lte |
date |
Date de publication inférieur à (YYYY-MM-DD) |
order |
string |
Ordre du tri {desc, asc} |
page |
integer |
Numéro de la page |
parking_garage |
integer |
Nombres de stationnements supérieur à |
per_page |
integer |
Nombres de résultats par page (défaut 30) |
polygon |
string |
Ex: 7.472159624446277,43.77035536906513,7.471648961696133,43.75661939777285,7.494524864008753,43.75591312452855,7.503698380016573,43.77026630449856,7.48330967012663,43.78010918046601,7.472159624446277,43.77035536906513 |
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é par une virgule: {agricultural, appartement, atelier-d-artiste, bastide-mas, buildable, bureau, business-office, castle-manor, chambre-de-service, closed-box, commercial, commercial-for-sale, country-house, duplex, entresol, farm-grange, haras, house-architect, indoor-garage, indoor-parking, industrial-commercial, leasure, maison-individuelle, mansion, mountain-chalet, outdoor-garage, outdoor-parking, penthouse, plateau-brut, private-island, ruin, studio, town-house, triplex, unbuildable, villa-jumelee, village-house, vineyard, waterfront-property} |
property_type |
string |
Type de bien, liste séparé par une virgule: {appartment, building, commercial-office, garage-parking, house, land) |
reference |
string |
Référence du bien |
rooms |
integer |
Liste séparé par une virgule de nombre de pièces, ex 1,2,3,4,5 |
rooms_from |
integer |
Nombre de pièces supérieur à |
sold_date_at_gte |
date |
Date vendu supérieur à (YYYY-MM-DD) |
sales_agreement_date_at_gte |
date |
Date de sous compromis supérieur à (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} |
transaction_type |
string |
Type de transaction, liste séparé par une virgule: {for-sale, rent, sold, to-rent, under-agreement, under-offer, mandate-withdrawal} |
updated_at_gt |
datetime |
Date de mise à jour supérieur à |
updated_at_gte |
datetime |
Date de mise à jour supérieur ou égale à |
updated_at_lt |
datetime |
Date de mise à jour inférieur à |
updated_at_lte |
datetime |
Date de mise à jour inférieur ou égale à |
view |
string |
Type de vue, liste séparé par une virgule: {city, country, courtyard, hills, mountain, sea, street, vegetation} |
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": "",
"mls_board": {
"id": "Yv68Wm"
},
"building": {
"id": "W340gO",
"name": "VERNEUIL",
"number_of_floors": 4
},
"estimate": {
"id": null,
"active": false,
"status": 0
},
"agency": {
"id": "oPKYy0",
"name": "IMMO SQUARE",
"active": true,
"blocked_by_mls": false
},
"user": {
"id": "Mg890k",
"name": "Agent IMMO SQUARE",
"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_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,
"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,
"last_floor": false,
"is_life_lease": false,
"is_sold_rent": false,
"furnished": false,
"dpe_setuped": true,
"dpe_letter": null,
"ges_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
},
"sublocality": {
"id": 676,
"slug": "chambrun",
"name": "Chambrun"
},
"locality": {
"id": 522,
"slug": "nice",
"name": "Nice"
},
"area_level_2": {
"id": 3,
"slug": "alpes-maritimes",
"name": "Alpes-Maritimes"
},
"area_level_1": {
"id": 1,
"slug": "provence-alpes-cote-d-azur",
"name": "Provence-Alpes-Côte D'azur"
},
"country": {
"id": 1,
"slug": "fr",
"name": "France"
},
"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 |
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é |
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,
"mls_board": {
"id": "Yv68Wm",
"name": "Mls démo",
"slug": "mls-demo"
},
"agency": {
"name": "IMMO SQUARE",
"id": "oAlYy0",
"active": 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"
}
},
"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",
"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
}
},
"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": 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": ""
},
"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
},
"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
}
}
},
"financial": {
"currency": "eur",
"price": 13890000.0,
"tax1_annual": 6754.0,
"tax2_annual": 7890.0,
"fees_annual": 1200.0,
"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": ""
}
}
}
},
"rooms_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) |
mls_board |
|
|
|
id |
string |
Non |
ID du MLS |
name |
string |
Non |
Nom du MLS |
slug |
string |
Non |
Slug du MLS |
agency |
Oui |
|
|
id |
string |
Non |
ID de l'agence |
name |
string |
Non |
Nom de l'agence |
email |
string |
Oui |
Email de l'agence |
licence |
string |
Oui |
RCS / SIREN de l'agence |
company_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 |
license |
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 |
|
|
dpe |
Oui |
|
|
date_start |
datetime |
Oui |
Surface du balcon |
date_end |
datetime |
Oui |
Surface formaté avec l'unité |
dpe_letter |
string |
Non |
Date de création du bien |
dpe_value |
float |
Non |
Date de dernière modification du bien |
ges_letter |
string |
Non |
Date de mise en ligne du bien |
ges_value |
float |
Non |
Date de fin du mandat du bien AAAA-MM-JJ
|
dpe_lower_price |
float |
Oui |
Date du retour à la vente du bien AAAA-MM-JJ
|
dpe_higher_price |
float |
Oui |
Date du retour à la vente du bien AAAA-MM-JJ
|
dpe_year_reference |
date |
Oui |
Date de vente du bien AAAA-MM-JJ
|
dpe_url |
string |
Oui |
Date de l'accord de vente du bien AAAA-MM-JJ
|
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 |
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 |
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 |
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 |
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 tyoe 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 |
|
Types
Type d'honoraire - fee_type
Slug |
Description |
acquereur |
A la charge de l'acquéreur |
vendeur |
A la charge du vendeur |
acquereur-et-vendeur |
A la charge de l'acquéreur et du vendeur |
Raison de mise hors ligne - offline_reason
Slug |
Description |
removed-by-gateway |
Bien retiré de la passerelle |
mandate-expired |
Mandat échu |
mandate-removed-by-mandator |
Retiré par le mandant |
old-mls-agency |
Ancienne agence MLS |
converted-to-simple-mandate |
Transformation en mandat simple |
Type de transaction - transaction_type
Slug |
Description |
for-sale |
A vendre |
under-offer |
Sous offre acceptée |
sold |
Vendu |
to-rent |
A louer |
rent |
Loué |
under-agreement |
Sous compromis |
mandate-withdrawal |
Retiré |
estimate |
Estimation |
draft |
Brouillon |
validation |
En attente de validation |
Type de propriété - property_type
Slug |
Description |
appartment |
Appartement |
house |
Maison |
land |
Terrain |
commercial-office |
Commerce/Bureau |
garage-parking |
Garage/Parking |
building |
Immeuble de rapport |
others |
Autres |
Sous type de propriété - property_subtype
Type de propriété |
slug |
Description |
commercial-office |
business-office |
Bureau - Local Professionnel |
commercial-office |
commercial |
Commerce - Bail Commercial |
commercial-office |
commercial-for-sale |
Murs commerciaux |
garage-parking |
indoor-garage |
Garage en sous-sol |
garage-parking |
outdoor-garage |
Garage extérieur |
garage-parking |
indoor-parking |
Parking en sous-sol |
garage-parking |
outdoor-parking |
Parking extérieur |
garage-parking |
closed-box |
Box fermé |
appartment |
duplex |
Duplex |
appartment |
triplex |
Triplex |
appartment |
penthouse |
Penthouse |
appartment |
entresol |
Entresol |
appartment |
plateau-brut |
Plateau Brut |
appartment |
studio |
Studio |
appartment |
atelier-d-artiste |
Atelier d'artiste |
appartment |
chambre-de-service |
Chambre de service |
appartment |
appartement |
Appartement |
appartment |
bureau |
Bureau |
house |
town-house |
Maison de ville |
house |
village-house |
Maison de village |
house |
bastide-mas |
Bastide / Mas |
house |
farm-grange |
Ferme / Grange |
house |
house-architect |
Maison d'architecte |
house |
country-house |
Maison de campagne |
house |
mountain-chalet |
Chalet |
house |
castle-manor |
Château / Manoir |
house |
mansion |
Hôtel Particulier |
house |
vineyard |
Domaine Viticole |
house |
waterfront-property |
Maison pieds dans l'eau |
house |
ruin |
Ruine |
house |
haras |
Haras |
house |
private-island |
Ile Privée |
house |
villa-jumelee |
Maison jumelée |
house |
maison-individuelle |
Maison individuelle |
land |
buildable |
Constructible |
land |
unbuildable |
Inconstructible |
land |
agricultural |
Agricole |
land |
leasure |
Loisir |
land |
industrial-commercial |
Industriel / Commercial |
others |
cellar |
Cave |
others |
attic |
Grenier |
others |
storeroom |
Cellier |
others |
maid_room |
Chambre de bonne |
others |
warehouse |
Entrepôt |
others |
storage_building |
Hangar |
others |
diverse |
Divers |
Type de mandat - mandate
Slug |
Description |
exclusive |
Exclusif |
open |
Open |
simple |
Simple |
Type de viager - lease
Slug |
Description |
free |
Viager libre |
occupied |
Viager occupé |
forward-sale |
Vente à terme |
Type de mitoyenneté - adjoining_building
Slug |
Description |
detached |
Individuelle |
semi-detached |
Jumelée 1 coté |
attached |
Jumelée 2 cotés |
attached-by-garage |
Jumelée garage |
Type fermeture - closure
Slug |
Description |
without |
Sans |
automatic |
Automatique |
manual |
Manuelle |
to-create |
Possible à réaliser |
Type état - condition
Slug |
Description |
new |
Neuf / Rénové |
good |
Bon état |
needs-work |
A rafraichir |
needs-renovating |
A rénover |
excellent-condition |
Très bon état |
Type configuration - configuration
Slug |
Description |
flat |
Plat |
small-slope |
Pente douce |
scales |
Planches |
high-scales |
Planches élevées |
steep-slope |
Pente forte |
Type exposition - exposition
Slug |
Description |
north |
Nord |
north-east |
Nord-est |
east |
Est |
south-east |
Sud-est |
south |
Sud |
south-west |
Sud-ouest |
west |
Ouest |
north-west |
Nord-ouest |
Type murs extérieurs - external_wall
Slug |
Description |
briks |
Briques |
concrete-blocks |
Parpaings |
concrete |
Béton |
stone |
Pierres |
wood |
Bois |
crepis |
Crépis |
Type statut juridique - legal_status
Slug |
Description |
single-owner |
Pleine propriété |
free-property |
Nue-propriété |
usufruct |
Usufruit |
undivided-state |
Indivision |
Type de revêtement sol - floor
Slug |
Description |
tiles |
carrelage |
carpet |
moquette |
plastic |
plastique |
parquet |
parquet |
cement |
Ciment brut |
painted-cement |
Ciment peint |
marble |
Marbre |
granit |
Granit |
terracotta |
Terre cuite |
Type de plancher - flooring
Slug |
Description |
concrete |
Béton |
woog |
Bois |
steel |
Acier |
Type de statut des garages - garage_status
Slug |
Description |
included |
Inclus |
rental |
Location |
excluded |
En sus |
Type de vitrage - glazing
Slug |
Description |
single |
Simple vitrage |
double |
Double vitrage |
triple |
Autre vitrage isolant |
mixed |
Double vitrage en partie |
Type de chauffage - heating
Slug |
Description |
radiator |
Radiateur |
electric-radiator |
Convecteur |
underfloor |
Sol |
airflow |
Air pulsé |
heatpump |
Pompe à chaleur |
passive-heating |
Passif |
Type de énergie chauffage - heating_method
Slug |
Description |
electric |
Electrique |
gas |
Gaz |
fuel |
Fioul |
wood |
Bois |
heat-pump |
Pompe à chaleur |
solar |
Solaire |
geothermal |
Géothermique |
passive-heating |
Chauffage passif |
climatisation |
Climatisation |
cpcu |
CPCU |
city-gaz |
Gaz de ville |
citern-gaz |
Gaz Citerne |
Type eau chaude - hot_water
Slug |
Description |
boiler |
Cumulus |
gas |
Gaz |
fuel |
Fioul |
solar |
Solaire |
Type cuisine - kitchen
Slug |
Description |
full-equiped |
Equipée |
furnitured |
Aménagée |
empty |
Nue |
Type toiture - roof
Slug |
Description |
tiles |
Tuiles |
concrete-tiles |
Tuiles Béton |
roof-terrace |
Terrasse |
shingle |
Shingle |
thatch |
Chaume |
slate-tiles |
Ardoise |
roofing |
Roofing |
Type toiture - roof
Slug |
Description |
tiles |
Tuiles |
concrete-tiles |
Tuiles Béton |
roof-terrace |
Terrasse |
shingle |
Shingle |
thatch |
Chaume |
slate-tiles |
Ardoise |
roofing |
Roofing |
Type assainissemnt - sanitation
Slug |
Description |
sewer |
Egout |
septic-tank |
Fosse septique |
to-create |
Inexistant |
fosse-a-debordement |
Fosse à débordement |
treatment-plant |
Station d'épuration |
Type volets - shutter
Slug |
Description |
electric |
Roulants électriques |
ouvrants |
Ouvrants |
shutters |
Persiennes |
manual |
Roulants manuels |
electric-partial |
Roulants électriques en partie |
Type standing - standing
Slug |
Description |
luxury |
Luxe |
good |
Bon Standing |
low |
Plan courant |
Type style - style
Slug |
Description |
contemporary |
Contemporain |
bourgeoise |
Bourgeoise |
regional |
Provençale |
belle-epoque |
Belle Époque |
florentine |
Florentin |
nicois |
Niçois |
50-60-year |
Années 50/60 |
californian |
Californienne |
Type environnement - surroundings
Slug |
Description |
city |
Ville |
country |
Campagne |
residential |
Résidentiel |
city-houses |
Pavillonnaire |
industrial |
Industriel |
commercial |
Commercial |
Type éléments céder - transferred_element
Slug |
Description |
lease-rights |
DAB |
leasehold |
Fond de commerce |
company |
Société |
Type végétation - vegetation
Slug |
Description |
none |
Nu |
wasteland |
Friche |
planted-garden |
Complanté |
woods |
Boisé |
prairie |
Prairie |
farm-land |
Terres agricoles |
pond |
Etang |
Type vue principale - view_principal
Slug |
Description |
clear |
Dégagée |
panoramic |
Panoramique |
overview |
Aperçu |
Type vue - view
Slug |
Description |
sea |
Mer |
hills |
Collines |
city |
Ville |
vegetation |
Verdure |
country |
Campagne |
mountain |
Montagne |
street |
Rue |
courtyard |
Cour |
Slug |
Description |
alu |
Alu |
wood |
Bois |
pvc |
PVC |
mixt |
Mixte |
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 |
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 |
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,
"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,
"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 |
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 |
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,
"name": "IMMO SQUARE",
"commercial_name": "IMMO SQUARE",
"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": "IMMO SQUARE",
"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"
}
}
},
"license": {
"holder": "Immo Square's Boss",
"number": "123456789",
"type": null,
"delivery_location": "Alpes-maritimes",
"validity_date_start": "2021-06-25",
"validity_date_end": null
},
"description": {
"fr": "IMMO SQUARE 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": "IMMO SQUARE",
"full_name": "M DIRECTOR IMMO SQUARE",
"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": "IMMO SQUARE",
"full_name": "Agent IMMO SQUARE",
"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 |
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 |
|
|
|
registration_name |
string |
Oui |
Raison sociale |
registration_id |
string |
Oui |
RCS / SIRET |
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 |
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 |
users |
|
|
|
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 |
phone |
string |
Oui |
Numéro de téléphone fixe |
email |
string |
Oui |
Email |
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 des 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,
"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,
"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"
}
}
]
}
Utilisateurs
Recherche utilisateur
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 à |
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",
"mobile": "+337XXXXXXXX",
"phone": null,
"email": "belia.bashirian@example.net",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"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",
"mobile": "+337XXXXXXXX",
"phone": null,
"email": "roslyn@example.net",
"member_since_at": "2021-06-16T14:26:58.754899+02:00",
"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 |
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 |
phone |
string |
Oui |
Numéro de téléphone fixe |
email |
string |
Oui |
Email |
membersinceat |
date |
Non |
Membre depuis le |
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 sur les agences dont vous dépendez
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",
"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
}
},
"license": {
"type": "adc_card",
"agent_id": "",
"license_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 |
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 |
phone |
string |
Oui |
Numéro de téléphone fixe |
email |
string |
Oui |
Email |
default_user |
boolean |
Non |
Utilisateur par dféaut 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 |
membersinceat |
date |
Non |
Membre depuis le |
created_at |
date |
Non |
Date de création |
updated_at |
date |
Non |
Date de dernière mise à jour |
role |
|
|
|
name |
string |
Oui |
Nom du rôle |
slug |
string |
Oui |
Code du rôle |
licence |
|
|
|
type |
string |
Oui |
Type de carte professionnelle |
agent_id |
string |
Oui |
Numéro RSAC/RCS |
license_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 |
language |
|
Oui |
|
code |
text |
Oui |
Code de la langue |
locale |
text |
Oui |
Langues parlées dans les différentes langues disponibles |
description |
|
Oui |
|
locale |
text |
Oui |
Description dans les différentes langues disponibles |
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"
},
{
"id": "4qNoW8",
"name": "Mls 2",
"slug": "mls-2"
}
]