Présentation des champs de l'API

Notre API fournit un accès complet aux données des biens Equimmox, triés et valorisés par notre IA. Elle distingue deux catégories principales de données : les biens immobiliers (property) et les annonces y afférentes (ads), reliées par l'identifiant unique du bien (id_property). Chaque bien se compose de une ou plusieurs annonces.

Dans les tableaux suivants, nous détaillons les paramètres disponibles pour interroger notre API, ainsi que les attributs retournés par bien et par annonce.

Important :
  • Les paramètres de requête sont optionnels. Laisser un paramètre empty équivaut à désactiver le filtre associé.
  • Pour vous authentifier ajoutez dans le header Authorization: Bearer { TOKEN } en remplaçant { TOKEN } par votre token.

Pour plus d'information, vous pouvez nous contacter via l'adresse suivante :

contact@equimmox.com

Paramètres et attributs de l'API

https://api.equimmox.com/properties
https://api.equimmox.com/property/{id_property}
https://api.equimmox.com/merged-properties
Les biens (properties) constituent des offres immobilières qui centralisent les annonces associées permettant d'avoir une vision consolidée des informations sous jacentes.

Query Param

page
(Integer)
Default 1 : numéro de la page
page_size
(Integer)
Default 50 : nombre de biens par page (100 maximum)
property_type
(String)
Type du bien. 3 options possibles : ”Sale” (Vente) / “Rental” (Location) / “Transfer” (Fonds de commerce)
Plus de détails dans notre guide
asset_class
(String)
Classe d'actif indiquant les usages potentiels du bien. 7 options possibles : ”Office” (Bureau) / “Commercial” (Commerce) / "Business_premises" (Locaux d'activités) / “Logistics” (Logistique) / “Hotel” (Hôtel) / "Land" (Terrains) / "Building" (Immeuble) 
Plus de détails dans notre guide
active
(Boolean)
Booléen indiquant si l'annonce est encore active sur au moins un site web
publication_date_min
(Date)
Date minimale pour la publication de la première annonce
Format ISO : YYYY-MM-DD
publication_date_max
(Date)
Date maximale pour la publication de la première annonce
Format ISO : YYYY-MM-DD
deleted_date_min
(Datetime)
Date minimale pour la suppression du bien
Format ISO : YYYY-MM-DDTHH:MM:SSZ
deleted_date_max
(Datetime)
Date maximale pour la suppression du bien
Format ISO : YYYY-MM-DDTHH:MM:SSZ
insertion_date_min
(Datetime)
Date minimale pour filtrer les biens selon leur date d'insertion dans la base de données
Format ISO : YYYY-MM-DDTHH:MM:SSZ
insertion_date_max
(Datetime)
Date maximale pour filtrer les biens selon leur date d'insertion dans la base de données.
Format ISO : YYYY-MM-DDTHH:MM:SSZ
min_price
(Integer)
Prix minimum. Définition du prix:
- Pour Vente : Prix d'acquisition du bien
- Pour Fonds de commerce : Prix de cession du fonds
- Pour Location : Loyer annuel HT / HC
max_price
(Integer)
Prix maximum
min_entry_fee
(Integer)
Droit d'entrée (pas de porte ou droit au bail) minimum
max_entry_fee
(Integer)
Droit d'entrée (pas de porte ou droit au bail) maximum
min_rent
(Integer)
Loyer annuel minimum (estimation HT/HC). Définition du loyer :
Pour les autres types que Location ("Rental") uniquement, il s’agit du loyer (si mentionné).
Pour Location ("Rental") ce champ est non applicable.
max_rent
(Integer)
Loyer annuel maximum (estimation HT/HC). Définition du loyer :
Pour les autres types que Location ("Rental") uniquement, il s’agit du loyer (si mentionné).
Pour Location ("Rental") ce champ est non applicable.
min_surface
(Integer)
Surface minimale en mètres carrés
max_surface
(Integer)
Surface maximale en mètres carrés
city
(String)
Nom de la ville. Nous utilisons les données publiques pour toutes les géolocalisations, accessibles ici
zip_code
(String)
Numéro de code postal
department
(String)
Nom du département
department_code
(String)
Code du département
region
(String)
Nom de la région
is_occupied
(Boolean)
Si True, renvoie les murs occupés. Si False, renvoie les murs vides et ceux non identifiés.
publisher_type
(String)
Type d'auteur de l'annonce.
Valeurs possibles : "Individual" (pour les particulier) ou "Professional" (pour les professionnels) selon l'auteur de l'annonce.
office_contract
(String)
Type de contrat de location de bureau.
Ce filtre est seulement applicable pour property type = Rental et asset class = Office.
Valeurs possibles : "Flexible" (bureau opéré) ou "Long_term" (bail commercial).

Output

id_property
(uuid)
Clé primaire d'identification du bien
property_type
(String)
Type du bien. 3 options possibles : ”Sale” (Vente) / “Rental” (Location) / “Transfer” (Fonds de commerce)
Plus de détails dans notre guide
asset_class
(String)
Classe d'actif indiquant les usages potentiels du bien. 7 options possibles : ”Office” (Bureau) / “Commercial” (Commerce) / "Business premises" (Locaux d'activités) / “Logistics” (Logistique) / “Hotel” (Hôtel) / "Land" (Terrains) / "Building" (Immeuble)
Plus de détails dans notre guide
city
(String)
Nom de la ville où se trouve le bien
zip_code
(String)
Code postal de la ville du bien
department
(String)
Nom du département
department_code
(String)
Code du département
region
(String)
Nom de la région
insee_code
(String)
Code insee de la ville où se trouve le bien
district
(Integer)
Numéro de l'arrondissement (si applicable)
value_surface
(Integer)
Surface du bien en mètres carrés
value_price_total
(Integer)
Dépend du type de bien:
- Pour Vente : Prix d'acquisition du bien
- Pour Fonds de commerce : Prix de cession du fonds
- Pour Location : Loyer annuel HT / HC
value_price_m2
(Integer)
Dépend du type de bien:
- Pour Vente : Prix d'acquisition du bien par m² de surface
- Pour Fonds de commerce : Prix de cession du fonds par m² de surface
- Pour Location : Loyer annuel HT / HC par m² de surface
description
(String)
Description détaillée du bien
publication_date
(Date)
Date de publication de la première annonce associée au bien
deleted_date
(Datetime)
Date à laquelle la dernière annonce associée au bien a été supprimée
insertion_date
(Datetime)
Date d'insertion dans la base de données
energy_diagnosis
(Dict)
Diagnostic énergétique. Inclus les lettres de classe énergétique et des émissions de CO2 (Format: {”DPE”: ”A”, “GES”: “A”})
active
(Boolean)
Indique si l’une des annonces associée est toujours active (True/False)
occupation
(Boolean)
Indique si le bien est vendu occupé (True) ou vendu vide (False)
rent
(Integer)
Pour les autres types que Location uniquement, il s’agit du loyer (si mentionné).
Pour Location ce champ est non applicable (le loyer des location correspond à value_price_total).
entry_fee
(Integer)
Tout droit d’entrée (Droit au bail ou pas de porte) pour la prise de bail, si applicable.
exploitation
(List[String])
Type d'exploitation pour les cessions de fonds (exemple: ['restaurant', 'Traiteur'], ['salon de coiffure'], etc.)
image_url
(List[String])
URL des images de l’annonce
sales_revenue
(Integer)
Pour les fonds de commerce: Chiffre d’affaires du précédent occupant si applicable
coordinates
(List[Integer])
Si disponible, coordonnées géographiques du bien (peu précis, à titre indicatif)
rooms_number
(Integer)
Nombre de pièces
construction_year
(Integer)
Année de construction
property_tax
(Integer)
Montant de la taxe foncière
floor_level
(Integer)
Étage du bien
publisher_type
(String)
Type d'auteur de l'annonce.
Valeurs possibles : "Individual" (pour les particulier) ou "Professional" (pour les professionnels) selon l'auteur de l'annonce.
office_contract
(String)
Type de contrat de location de bureau.
Valeurs possibles : "Flexible" (bureau opéré) ou "Long term" (bail commercial).
location_type
(String)
Type d'emplacement.
Valeurs possibles : "City center" (centre-ville), "Commercial zone" (zone commerciale), "Activity zone" (zone d'activité), "Other" (autre).
value_yield
(Float)
Pour le property_type Sale (Vente de murs) uniquement, il s'agit du rendement brut (Loyer annuel/Prix du bien).
ads
(List)
Liste des annonces liées au bien :
- id reference du site
- nom du site
- url du site source
- date de publication
- date de suppression (si empty : l'annonce est toujours active, sinon l'annonce a été désactivée)
- date de dernière vérification
- type d'auteur de l'annonce ('Professional' vs 'Individual')
- nom du réseau d'agence (si identifié)
- nom de l'agence
- téléphone (si disponible, hors particuliers)
- email (si disponible, hors particuliers)
- prix
‍
Cet endpoint permet de récupérer les détails par annonce d'un bien immobilier (property) spécifique en utilisant son identifiant unique ('id_property')

Query Param

id_property
(str, uuid)
Identifiant unique du bien qu'on souhaite récupérer

Output

ads
(List)
Liste des annonces liées au bien :
- id reference du site
- nom du site
- url du site source
- date de publication
- date de suppression (si empty : l'annonce est toujours active, sinon l'annonce a été désactivée)
- date de dernière vérification
- type d'auteur de l'annonce ('Professional' vs 'Individual')
- nom du réseau d'agence (si identifié)
- nom de l'agence
- téléphone (si disponible, hors particuliers)
- email (si disponible, hors particuliers)
- prix
‍

Cet endpoint permet de retourner les biens qui ont été fusionnés. Il peut arriver qu'après vérification, on détecte une similarité entre deux biens ou plus, c'est alors qu'on fusionne ces biens en un seul.

Query Param

merged_date_min
Date minimale de fusion
merged_date_max
Date maximale de fusion

Output

id_properties_merged
Clés primaires d'identification des biens "fils" qui ont été fusionnés entre les deux dates de fusion, vers le bien "père"
id_property_receiver
Clé primaire d'identification du bien "père" qui a reçu les biens fusionnés
merge_date
Date à laquelle les biens ont été fusionnés