French Real Estate Agent

French Real Estate Agent · GPT-Aktionen

French Energy report API

This API provides energy report of french properties.

  • POST /v1/datasets/dpe-v2-logements-existants/linesquery DPE, bilan energetique
  • POST /v1/datasets/dpe-france/linesquery DPE, bilan energetique
Ursprüngliches API-Schema
{
  "openapi": "3.1.0",
  "info": {
    "title": "French Energy report API",
    "version": "1.0.0",
    "description": "This API provides energy report of french properties."
  },
  "servers": [
    {
      "url": "https://data.ademe.fr/data-fair/api"
    }
  ],
  "paths": {
    "/v1/datasets/dpe-v2-logements-existants/lines": {
      "post": {
        "summary": "query DPE, bilan energetique",
        "operationId": "GetDPE",
        "parameters": [
          {
            "in": "query",
            "name": "geo_distance",
            "description": "\n  Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n  Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n  Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n    ",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Le résultat de la requête",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "integer",
                      "description": "Le nombre total de résultat si on ignore la pagination"
                    },
                    "results": {
                      "type": "array",
                      "description": "Le tableau de résultats",
                      "items": {
                        "type": "object",
                        "properties": {
                          "nom_methode_dpe": {
                            "type": "string",
                            "title": "Nom de la méthode DPE utilisée",
                            "description": "Nom de la méthode DPE utilisée",
                            "x-cardinality": 491,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "version_methode_dpe": {
                            "type": "string",
                            "title": "Version de la méthode DPE utilisée",
                            "description": "Version de la méthode DPE utilisée",
                            "x-cardinality": 91,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "date_etablissement_dpe": {
                            "type": "string",
                            "format": "date",
                            "x-refersTo": "http://schema.org/Date",
                            "title": "Date DPE",
                            "description": "",
                            "x-capabilities": {},
                            "x-cardinality": 3701,
                            "x-concept": {
                              "id": "date",
                              "title": "Date d'évènement",
                              "primary": true
                            }
                          },
                          "consommation_energie": {
                            "type": "number",
                            "title": "Consommation énergie en kWhEP/m².an",
                            "description": "Consommation énergie en kWhEP/m².an",
                            "x-cardinality": 82613,
                            "x-capabilities": {}
                          },
                          "classe_consommation_energie": {
                            "type": "string",
                            "title": "Classement consommation d'énergie",
                            "description": "Classement consommation d'énergie",
                            "x-cardinality": 19,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "D",
                              "E",
                              "N",
                              "C",
                              "B",
                              "A",
                              "F",
                              "G",
                              "S",
                              "I",
                              "5",
                              "6",
                              "-",
                              "4",
                              "7",
                              "8",
                              "H",
                              "0",
                              "3"
                            ]
                          },
                          "estimation_ges": {
                            "type": "number",
                            "title": "Estimation GES en Kg eqCO2/m².an",
                            "description": "Estimation GES en Kg eqCO2/m².an",
                            "x-cardinality": 19770,
                            "x-capabilities": {}
                          },
                          "classe_estimation_ges": {
                            "type": "string",
                            "title": "Classement GES",
                            "description": "Classement GES",
                            "x-cardinality": 16,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "C",
                              "N",
                              "B",
                              "D",
                              "E",
                              "A",
                              "F",
                              "G",
                              "S",
                              "I",
                              "1",
                              "-",
                              "2",
                              "0",
                              "7",
                              "H"
                            ]
                          },
                          "annee_construction": {
                            "type": "integer",
                            "title": "Année de construction ou évaluation de cette date",
                            "description": "Année de construction ou évaluation de cette date",
                            "x-cardinality": 873,
                            "x-capabilities": {}
                          },
                          "surface_thermique_lot": {
                            "type": "number",
                            "title": "Surface thermique du lot pour un bâtiment à usage principal autre qu'habitation",
                            "description": "Surface thermique du lot pour un bâtiment à usage principal autre qu'habitation",
                            "x-cardinality": 69031,
                            "x-capabilities": {}
                          },
                          "latitude": {
                            "type": "number",
                            "title": "Latitude du Bâtiment",
                            "description": "Latitude du Bâtiment",
                            "x-cardinality": 2458746,
                            "x-refersTo": "http://schema.org/latitude",
                            "x-capabilities": {},
                            "x-concept": {
                              "id": "latitude",
                              "title": "Latitude",
                              "primary": true
                            }
                          },
                          "longitude": {
                            "type": "number",
                            "title": "Longitude du Bâtiment",
                            "description": "Longitude du Bâtiment",
                            "x-cardinality": 2680100,
                            "x-refersTo": "http://schema.org/longitude",
                            "x-capabilities": {},
                            "x-concept": {
                              "id": "longitude",
                              "title": "Longitude",
                              "primary": true
                            }
                          },
                          "tr001_modele_dpe_type_libelle": {
                            "type": "string",
                            "title": "Type de DPE",
                            "description": "Type de DPE",
                            "x-cardinality": 6,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "Vente",
                              "Location",
                              "Neuf",
                              "Copropriété",
                              "Bâtiment public",
                              "Centre commercial"
                            ]
                          },
                          "tr002_type_batiment_description": {
                            "type": "string",
                            "title": "Type de bâtiment",
                            "description": "Type de bâtiment",
                            "x-cardinality": 3,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "Logement",
                              "Maison Individuelle",
                              "Bâtiment collectif à usage principal d'habitation"
                            ]
                          },
                          "code_insee_commune_actualise": {
                            "title": "Code INSEE Commune",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 47011,
                            "x-refersTo": "http://rdf.insee.fr/def/geo#codeCommune",
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "x-concept": {
                              "id": "codeCommune",
                              "title": "Code commune",
                              "primary": true
                            }
                          },
                          "tv016_departement_code": {
                            "title": "Code département",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 96,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "geo_adresse": {
                            "title": "",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 3336184,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "geo_score": {
                            "title": "",
                            "description": "",
                            "type": "number",
                            "x-cardinality": 71,
                            "x-capabilities": {}
                          },
                          "_geopoint": {
                            "x-calculated": true,
                            "type": "string",
                            "title": "Coordonnée géographique",
                            "description": "Centroïde au format \"lat,lon\"",
                            "x-refersTo": "http://www.w3.org/2003/01/geo/wgs84_pos#lat_long",
                            "x-concept": {
                              "id": "latLon",
                              "title": "Latitude / Longitude",
                              "primary": true
                            },
                            "readOnly": true
                          },
                          "_id": {
                            "x-calculated": true,
                            "type": "string",
                            "format": "uri-reference",
                            "title": "Identifiant",
                            "description": "Identifiant unique parmi toutes les lignes du jeu de données",
                            "readOnly": true
                          },
                          "_i": {
                            "x-calculated": true,
                            "type": "integer",
                            "title": "Numéro de ligne",
                            "description": "Indice de la ligne dans le fichier d'origine",
                            "readOnly": true
                          },
                          "_rand": {
                            "x-calculated": true,
                            "type": "integer",
                            "title": "Nombre aléatoire",
                            "description": "Un nombre aléatoire associé à la ligne qui permet d'obtenir un tri aléatoire par exemple",
                            "readOnly": true
                          }
                        }
                      }
                    },
                    "next": {
                      "type": "string",
                      "description": "URL pour continuer la pagination"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/datasets/dpe-france/lines": {
      "post": {
        "summary": "query DPE, bilan energetique",
        "operationId": "GetOldDPE",
        "parameters": [
          {
            "in": "query",
            "name": "geo_distance",
            "description": "\n  Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n  Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n  Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n    ",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Le résultat de la requête",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "integer",
                      "description": "Le nombre total de résultat si on ignore la pagination"
                    },
                    "results": {
                      "type": "array",
                      "description": "Le tableau de résultats",
                      "items": {
                        "type": "object",
                        "properties": {
                          "nom_methode_dpe": {
                            "type": "string",
                            "title": "Nom de la méthode DPE utilisée",
                            "description": "Nom de la méthode DPE utilisée",
                            "x-cardinality": 491,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "version_methode_dpe": {
                            "type": "string",
                            "title": "Version de la méthode DPE utilisée",
                            "description": "Version de la méthode DPE utilisée",
                            "x-cardinality": 91,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "date_etablissement_dpe": {
                            "type": "string",
                            "format": "date",
                            "x-refersTo": "http://schema.org/Date",
                            "title": "Date DPE",
                            "description": "",
                            "x-capabilities": {},
                            "x-cardinality": 3701,
                            "x-concept": {
                              "id": "date",
                              "title": "Date d'évènement",
                              "primary": true
                            }
                          },
                          "consommation_energie": {
                            "type": "number",
                            "title": "Consommation énergie en kWhEP/m².an",
                            "description": "Consommation énergie en kWhEP/m².an",
                            "x-cardinality": 82613,
                            "x-capabilities": {}
                          },
                          "classe_consommation_energie": {
                            "type": "string",
                            "title": "Classement consommation d'énergie",
                            "description": "Classement consommation d'énergie",
                            "x-cardinality": 19,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "D",
                              "E",
                              "N",
                              "C",
                              "B",
                              "A",
                              "F",
                              "G",
                              "S",
                              "I",
                              "5",
                              "6",
                              "-",
                              "4",
                              "7",
                              "8",
                              "H",
                              "0",
                              "3"
                            ]
                          },
                          "estimation_ges": {
                            "type": "number",
                            "title": "Estimation GES en Kg eqCO2/m².an",
                            "description": "Estimation GES en Kg eqCO2/m².an",
                            "x-cardinality": 19770,
                            "x-capabilities": {}
                          },
                          "classe_estimation_ges": {
                            "type": "string",
                            "title": "Classement GES",
                            "description": "Classement GES",
                            "x-cardinality": 16,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "C",
                              "N",
                              "B",
                              "D",
                              "E",
                              "A",
                              "F",
                              "G",
                              "S",
                              "I",
                              "1",
                              "-",
                              "2",
                              "0",
                              "7",
                              "H"
                            ]
                          },
                          "annee_construction": {
                            "type": "integer",
                            "title": "Année de construction ou évaluation de cette date",
                            "description": "Année de construction ou évaluation de cette date",
                            "x-cardinality": 873,
                            "x-capabilities": {}
                          },
                          "surface_thermique_lot": {
                            "type": "number",
                            "title": "Surface thermique du lot pour un bâtiment à usage principal autre qu'habitation",
                            "description": "Surface thermique du lot pour un bâtiment à usage principal autre qu'habitation",
                            "x-cardinality": 69031,
                            "x-capabilities": {}
                          },
                          "latitude": {
                            "type": "number",
                            "title": "Latitude du Bâtiment",
                            "description": "Latitude du Bâtiment",
                            "x-cardinality": 2458746,
                            "x-refersTo": "http://schema.org/latitude",
                            "x-capabilities": {},
                            "x-concept": {
                              "id": "latitude",
                              "title": "Latitude",
                              "primary": true
                            }
                          },
                          "longitude": {
                            "type": "number",
                            "title": "Longitude du Bâtiment",
                            "description": "Longitude du Bâtiment",
                            "x-cardinality": 2680100,
                            "x-refersTo": "http://schema.org/longitude",
                            "x-capabilities": {},
                            "x-concept": {
                              "id": "longitude",
                              "title": "Longitude",
                              "primary": true
                            }
                          },
                          "tr001_modele_dpe_type_libelle": {
                            "type": "string",
                            "title": "Type de DPE",
                            "description": "Type de DPE",
                            "x-cardinality": 6,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "Vente",
                              "Location",
                              "Neuf",
                              "Copropriété",
                              "Bâtiment public",
                              "Centre commercial"
                            ]
                          },
                          "tr002_type_batiment_description": {
                            "type": "string",
                            "title": "Type de bâtiment",
                            "description": "Type de bâtiment",
                            "x-cardinality": 3,
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "example": [
                              "Logement",
                              "Maison Individuelle",
                              "Bâtiment collectif à usage principal d'habitation"
                            ]
                          },
                          "code_insee_commune_actualise": {
                            "title": "Code INSEE Commune",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 47011,
                            "x-refersTo": "http://rdf.insee.fr/def/geo#codeCommune",
                            "x-capabilities": {
                              "textAgg": true
                            },
                            "x-concept": {
                              "id": "codeCommune",
                              "title": "Code commune",
                              "primary": true
                            }
                          },
                          "tv016_departement_code": {
                            "title": "Code département",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 96,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "geo_adresse": {
                            "title": "",
                            "description": "",
                            "type": "string",
                            "x-cardinality": 3336184,
                            "x-capabilities": {
                              "textAgg": true
                            }
                          },
                          "geo_score": {
                            "title": "",
                            "description": "",
                            "type": "number",
                            "x-cardinality": 71,
                            "x-capabilities": {}
                          },
                          "_geopoint": {
                            "x-calculated": true,
                            "type": "string",
                            "title": "Coordonnée géographique",
                            "description": "Centroïde au format \"lat,lon\"",
                            "x-refersTo": "http://www.w3.org/2003/01/geo/wgs84_pos#lat_long",
                            "x-concept": {
                              "id": "latLon",
                              "title": "Latitude / Longitude",
                              "primary": true
                            },
                            "readOnly": true
                          },
                          "_id": {
                            "x-calculated": true,
                            "type": "string",
                            "format": "uri-reference",
                            "title": "Identifiant",
                            "description": "Identifiant unique parmi toutes les lignes du jeu de données",
                            "readOnly": true
                          },
                          "_i": {
                            "x-calculated": true,
                            "type": "integer",
                            "title": "Numéro de ligne",
                            "description": "Indice de la ligne dans le fichier d'origine",
                            "readOnly": true
                          },
                          "_rand": {
                            "x-calculated": true,
                            "type": "integer",
                            "title": "Nombre aléatoire",
                            "description": "Un nombre aléatoire associé à la ligne qui permet d'obtenir un tri aléatoire par exemple",
                            "readOnly": true
                          }
                        }
                      }
                    },
                    "next": {
                      "type": "string",
                      "description": "URL pour continuer la pagination"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {}
  }
}

French Property Address API

This API provides address and geo-coordinates for French properties based on a user-inputted address.

  • GET /searchRetrieve address and coordinates for a French property

    Returns address information and geo-coordinates based on a provided query parameter.

Ursprüngliches API-Schema
{
  "openapi": "3.1.0",
  "info": {
    "title": "French Property Address API",
    "version": "1.0.0",
    "description": "This API provides address and geo-coordinates for French properties based on a user-inputted address."
  },
  "servers": [
    {
      "url": "https://api-adresse.data.gouv.fr"
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "operationId": "GetAddressGeocode",
        "summary": "Retrieve address and coordinates for a French property",
        "description": "Returns address information and geo-coordinates based on a provided query parameter.",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "Address query for a French property",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "example": "FeatureCollection"
                    },
                    "version": {
                      "type": "string",
                      "example": "draft"
                    },
                    "features": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Feature"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Feature": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "Feature"
          },
          "geometry": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "example": "Point"
              },
              "coordinates": {
                "type": "array",
                "items": {
                  "type": "number"
                },
                "description": "LatLon coordinates of the address"
              }
            }
          },
          "properties": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string",
                "example": "8 Boulevard du Port 80000 Amiens",
                "description": "Official name of the address"
              }
            }
          }
        }
      }
    }
  }
}

French cadaster API

This API provides parcel information for a give geojson point.

  • GET /parcelleRecherche d'informations sur les parcelles cadastrales d'une commune

    Retourne un résultat de Type "FeatureCollection" avec différentes informations sur les parcelles cadastrales.

Ursprüngliches API-Schema
{
  "openapi": "3.1.0",
  "info": {
    "title": "French cadaster API",
    "version": "1.0.0",
    "description": "This API provides parcel information for a give geojson point."
  },
  "servers": [
    {
      "url": "https://apicarto.ign.fr/api/cadastre"
    }
  ],
  "paths": {
    "/parcelle": {
      "get": {
        "operationId": "GetCadasterInfo",
        "summary": "Recherche d'informations sur les parcelles cadastrales d'une commune",
        "description": "Retourne un résultat de Type \"FeatureCollection\" avec différentes informations sur les parcelles cadastrales.",
        "parameters": [
          {
            "name": "geom",
            "in": "query",
            "description": "Géométrie de la parcelle au format GeoJSON",
            "schema": {
              "type": "string",
              "pattern": "\\{\\\"type\\\": \\\"(Point|Polygon)\\\",\\\"coordinates\\\": \\[.*\\]\\}"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Retourne les données cadastrales demandées",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "FeatureCollection"
                      ]
                    },
                    "features": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Parcelle"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Parcelle": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "Feature"
            ]
          },
          "geometry": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "Polygon"
                ]
              },
              "coordinates": {
                "type": "array",
                "items": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          },
          "properties": {
            "type": "object",
            "properties": {
              "idu": {
                "type": "string",
                "description": "Important: Official identifier of a cadaster parcel. Used to cross reference the property across services",
                "example": "690210000A0599"
              },
              "code_arr": {
                "type": "string",
                "description": " Code arrondissement pour Paris, Lyon, Marseille"
              },
              "code_insee": {
                "type": "number",
                "description": "Important: Code insee de la commune sur 5 caractères, used in future actions"
              },
              "section": {
                "type": "string",
                "description": "Section de la parcelle sur 2 caractères"
              },
              "numero": {
                "type": "string",
                "description": "Numero de la parcelle sur 4 caractères"
              },
              "bbox": {
                "type": "array",
                "items": {
                  "type": "number"
                },
                "description": "Important: Coordinates box of the parcel, used in future actions"
              }
            }
          }
        }
      }
    }
  }
}