Documentation | Casapulse Data Hub

				https://api.casapulse.fr/exemple-uri/?parametre=valeur&api_key=xxxxxxxx

				{
				  /* Nom du paramètre ayant reçu une valeur invalide */
				  "rooms_min":
				  /* Liste de messages d'erreur associés au paramètre */
				  [
				    "Saisissez un nombre entier valide."
				  ],
				  /* Nom du paramètre ayant reçu une valeur invalide */
				  "from_date":
				  /* Liste de messages d'erreur associés au paramètre */
				  [
				    "La date doit être au format AAAA-MM-JJ ou AAAA-MM-JJ_hh-mm-ss."
				  ]
				}

				{
				  /* La chaîne spécifiée dans le paramètre query. */
				  "query": "velizy",
				  /* Liste des résultats. */
				  "results": [
				    {
				      /* ID de la localisation. */
				      "id": "43ba90b1-8b19-4011-9ed4-41b7e1716cdb",
				      /* Code Insee de la localisation. */
				      "insee_code": "78640",
				      /* Code postal si le type de localisation est "city", sinon null. */
				      "zip_code": "78140",
				      /* Nom de la localisation. */
				      "name": "Vélizy-Villacoublay",
				      /* Nom de la localisation en minuscules sans caractères spéciaux. */
				      "slug": "velizy villacoublay",
				      /* Type de localisation, peut être "city", "department", ou "region". */
				      "location_type": "city"
				    }
				  ]
				}

				{
				  /* Liste des sources disponibles (plateformes de publication d'annonces),
				  tronqué à 1 dans cet exemple */
				  "sources": [
				    {
				      /* ID de la source */
				      "id": "e771f32f-af39-4ef3-aef8-3e1793848f32",
				      /* Code de la source */
				      "code": "PARU_VENDU",
				      /* Nom de la source */
				      "name": "ParuVendu"
				    }
				  ],
				  /* Liste des types de biens disponibles, tronqué à 1 dans cet exemple */
				  "property_types": [
				    {
				      /* ID du type de bien */
				      "id": "6f2af4e2-77e4-4430-a4d8-e8899ca91c0a",
				      /* Code du type de bien */
				      "value": "APARTMENT"
				    }
				  ]
				}

				{
				  /* Taille de la page actuelle. */
				  "page_size": 25,
				  /* Nombre de pages total de la requête. */
				  "total_pages_count": 40,
				  /* Numéro de la page actuelle. */
				  "current_page": 1,
				  /* Nombre total de résultats de la requête (limité à 1000). */
				  "total_items_count": 1000,
				  /* Indique si le nombre maximum de résultats est atteint. */
				  "limit_reached": true,
				  /* Numéro du premier résultat de la page sur le total de résultats. */
				  "current_items_start": 1,
				  /* Numéro du dernier résultat de la page sur le total de résultats. */
				  "current_items_end": 25,
				  /* Liste de résultats de la page actuelle, tronqué à 1 dans cet exemple. */
				  "items": [
				    {
				      /* ID de l’annonce. */
				      "id": "cbe1f718-bfb8-4544-aea6-2bee0cce4fc2",
				      /* Date d’ajout de l’annonce dans la base Casapulse. */
				      "created": "2021-06-08T02:32:16.165485Z",
				      /* Date de dernière modification de l’annonce dans la base
				      Casapulse. */
				      "modified": "2021-06-08T02:32:16.165485Z",
				      /* Plateforme de publication de l’annonce (source). */
				      "source": {
				        /* ID de la source. */
				        "id": "e771f32f-af39-4ef3-aef8-3e1793848f32",
				        /* Code de la source. */
				        "code": "SE_LOGER",
				        /* Nom de la source. */
				        "name": "Se Loger"
				      },
				      /* URL vers l’annonce d’origine. */
				      "url": "https://www.seloger.com/annonces/174024877.htm",
				      /* URLs des 6 premières images de l’annonce, vide
				      si pas d'image disponible. */
				      "img_url_1": "https://v.seloger.com/s/ea9q95y3bw0z1.jpg",
				      "img_url_2": "https://v.seloger.com/s/ea9q95y3bw0z2.jpg",
				      "img_url_3": "https://v.seloger.com/s/ea9q95y3bw0z3.jpg",
				      "img_url_4": "https://v.seloger.com/s/ea9q95y3bw0z4.jpg",
				      "img_url_5": "https://v.seloger.com/s/ea9q95y3bw0z5.jpg",
				      "img_url_6": "https://v.seloger.com/s/ea9q95y3bw0z6.jpg",
				      /* Liste de l'ensemble des URLs des images de l'annonce,
				      vide si pas d'image disponible */
				      "image_urls": [
				          "https://v.seloger.com/s/ea9q95y3bw0z1.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z2.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z3.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z4.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z5.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z6.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z7.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z8.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z9.jpg",
				          "https://v.seloger.com/s/ea9q95y3bw0z10.jpg"
				       ],
				      /* Date de retrait de l'annnonce si l'annonce n'est plus en ligne,
				      null si l'annonce est en ligne. */
				      "offline": "2021-06-12T01:15:08.243486Z",
				      /* True si une annonce pour le même bien a été publiée
				      sur une autre plateforme. */
				      "duplicate": false,
				      /* Date de dernière vérification de l’annonce par le service
				      Casapulse. */
				      "last_check": "2021-06-08T02:32:16.165485Z",
				      /* "agency" si l’annonce est publiée par une agence,
				      "individual" si l’annonce est publiée par un particulier. */
				      "seller_type": "agency",
				      /* Prix du bien en euros. */
				      "price": 600000,
				      /* Prix au m² du bien en euros. */
				      "price_m2": 1802,
				      /* Nombre d'annonces de location postées dans les 6 derniers
				      mois pour des biens similaires dans la même ville, null si l'information
				      n'est pas connue. */
				      "rental_count": 16,
				      /* Loyer au m² moyen observé pour des biens similaires dans la
				      même ville, null si l'information n'est pas connue. */
				      "average_rent_m2": 9,
				      /* Rendement locatif brut estimé du bien, null si l'information n'est
				      pas connue. */
				      "rental_yield_estimate": 6.4,
				      /* Titre de l'annonce, chaîne vide si non disponible */
				      "title": "Maison à vendre à Saint-Barthélemy-le-Plain",
				      /* Description de l'annonce */
				      "description": "Maison de 333m2 habitables bien agencée située en...",
				      /* Type du bien. */
				      "property_type": {
				        /* ID du type de bien. */
				        "id": "2c0f1544-83c5-4112-adb5-7145d0b2ce57",
				        /* Code du type de bien. */
				        "value": "HOUSE"
				      },
				      /* Localisation du bien. */
				      "city": {
				        /* ID de la ville. */
				        "id": "aaa3d7b9-9af6-44cc-b9da-96e557609ee1",
				        /* Code Insee de la ville. */
				        "insee_code": "07217",
				        /* Code postal de la ville. */
				        "zip_code": "07300",
				        /* Nom de la ville. */
				        "name": "Saint-Barthélemy-le-Plain",
				        /* Nom de la ville en minuscules et sans caractères spéciaux. */
				        "slug": "saint barthelemy le plain",
				        /* Type de localisation (toujours "city" dans les
				        résultats de recherche). */
				        "location_type": "city"
				      },
				      /* Surface en m² du bien. */
				      "surface": 333.0,
				      /* Surface carrez en m² du bien, null si l’information n’est
				      pas connue. */
				      "surface_carrez": 333.0,
				      /* Nombre de pièces. */
				      "rooms": 8,
				      /* Indique l’étage, null si l’information n’est pas connue. */
				      "floor": 3,
				      /* Indique si le bien possède un parking. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "parking": true,
				      /* Indique si le bien possède une cave. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "basement": true,
				      /* Indique si l’immeuble du bien possède un ascenseur. false
				      pour non, true pour oui, null si l’information n’est pas connue. */
				      "elevator": true,
				      /* Indique si le bien possède un balcon. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "balcony": true,
				      /* Indique si le bien possède une terrasse. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "terrace": true,
				      /* Indique si le bien est un terrain constructible. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "buildable_land": false,
				      /* Surface de terrain du bien en m². null si l’information
				      n’est pas connue. */
				      "surface_land": 421.5,
				      /* Indique si le bien possède une piscine. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "pool": false,
				      /* Indique si le bien est un appartement duplex. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "duplex": false,
				      /* Indique si le bien est un appartement triplex. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "triplex": false,
				      /* Indique si le bien est un appartement souplex. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "souplex": false,
				      /* Indique si le bien est dépourvu de vis-à-vis. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "not_overlooked": false,
				      /* Indique si le bien est meublé. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "furnished": false,
				      /* Indique si le bien est orienté nord. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "orientation_north": false,
				      /* Indique si le bien est orienté ouest. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "orientation_west": false,
				      /* Indique si le bien est orienté sud. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "orientation_south": false,
				      /* Indique si le bien est orienté est. false pour non,
				      true pour oui, null si l’information n’est pas connue. */
				      "orientation_east": false,
				      /* Indique si le bien nécessite des travaux de rénovation.
				      false pour non, true pour oui, null si l’information
				      n’est pas connue. */
				      "renovation_needed": false,
				      /* Charges de copropriété annuelles du bien en euros. null
				      si l’information n’est pas connue. */
				      "condominium_fees": 527,
				      /* Loyer mensuel du bien en euros si le bien est loué. null
				      si l’information n’est pas connue. */
				      "monthly_rent": null,
				      /* Taxe foncière annuelle en euros. null si l’information
				      n’est pas connue. */
				      "property_tax": 1250,
				      /* Nom du quartier dans lequel est situé le bien. null si
				      l’information n’est pas connue. */
				      "district": null,
				      /* Classe DPE du bien. Lettre de A à G, null si l’information
				      n’est pas connue. */
				      "dpe": "B",
				      /* Classe GES du bien. Lettre de A à G, null si l’information
				      n’est pas connue. */
				      "ges": "C",
				      /* Nombre d'étages que comprend le bien . null si l’information
				      n’est pas connue. */
				      "floor_count": 2,
				      /* Nombre d'étages du bâtiment . null si l’information
				      n’est pas connue. */
				      "floor_total": 2,
				      /* Année de construction du bien. null si l’information n’est
				      pas connue. */
				      "year_of_construction": 1998
				    }
				  ]
				}

				{
				    /* Nombre de villes correspondant aux paramètres city, department,
				    region. */
				    "city_matches": 463,
				    /* Objet localisation du même format que les résultats
				    renvoyés par le service Recherche de localisations.
				    Spécifié si une unique localisation correspond aux paramètres
				    city, department, et region, sinon null. */
				    "exact_match": {
				        "id": "e4d7574c-4248-41e6-aed1-38bce2b1168d",
				        "insee_code": "17",
				        "zip_code": null,
				        "name": "Charente-Maritime",
				        "slug": "charente maritime",
				        "location_type": "department"
				    },
				    "data": {
				        /* Données basées sur les transactions historiques. */
				        "transaction_market": {
				            /* Nombre de transactions sur la dernière année. */
				            "count": 1137,
				            /* Prix au m² moyen sur la dernière année. */
				            "average_price_m2": 2812,
				            /* Variation de prix au m² sur la dernière année
				            (pourcentage).*/
				            "price_m2_variation_1y": 8.4,
				            /* Variation de prix au m² sur les 5 dernières années
				            (pourcentage). */
				            "price_m2_variation_5y": 15.6
				        },
				        /* Données basées sur les annonces immobilières. */
				        "listing_market": {
				            "sales": {
				                /* Nombre d'annonces de vente sur la dernière année. */
				                "count": 12226,
				                /* Prix au m² moyen des annonces de vente sur la dernière
				                année. */
				                "average_price_m2": 3716
				            },
				            "rental": {
				                /* Nombre d'annonces de location sur la dernière année. */
				                "count": 4596,
				                /* Prix au m² moyen des annonces de location sur la dernière
				                année. */
				                "average_price_m2": 14
				            }
				        },
				        /* Moyenne du rendement locatif brut estimé (loyer annuel observé
				        divisé par le prix de vente). */
				        "rental_yield_estimate": 4.8
				    }
				}